Skip to content

Commit

Permalink
refactor: Limit learnmorelink to one link per recommendation (#618)
Browse files Browse the repository at this point in the history
  • Loading branch information
oZakari authored Jan 17, 2025
1 parent 5054ca7 commit 501324a
Show file tree
Hide file tree
Showing 42 changed files with 5 additions and 373 deletions.
2 changes: 1 addition & 1 deletion .github/scripts/schemas/aprl-schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ recommendation:
pgVerified: bool()
automationAvailable: bool()
tags: any(enum('AI','AVD', 'AVS', 'HPC', 'SAP'), null())
learnMoreLink: list(include('linkItem'), required=False, min=1)
learnMoreLink: list(include('linkItem'), required=False, max=1)

linkItem:
name: str()
Expand Down
2 changes: 0 additions & 2 deletions azure-resources/AVS/privateClouds/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@
automationAvailable: true
tags: null
learnMoreLink:
- name: Implement high availability
url: "https://learn.microsoft.com/en-us/azure/well-architected/azure-vmware/infrastructure#implement-high-availability"
- name: Stretched Clusters
url: "https://learn.microsoft.com/en-us/azure/azure-vmware/deploy-vsan-stretched-clusters"

Expand Down
8 changes: 0 additions & 8 deletions azure-resources/ApiManagement/service/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
learnMoreLink:
- name: Change your API Management service tier
url: "https://learn.microsoft.com/en-us/azure/api-management/upgrade-and-scale#change-your-api-management-service-tier"
- name: Migrate Azure API Management to availability zone support
url: "https://learn.microsoft.com/en-us/azure/reliability/migrate-api-mgt"

- description: Enable Availability Zones on Premium API Management instances
aprlGuid: 740f2c1c-8857-4648-80eb-47d2c56d5a50
Expand All @@ -33,8 +31,6 @@
learnMoreLink:
- name: Ensure API Management availability and reliability
url: "https://learn.microsoft.com/en-us/azure/api-management/high-availability#availability-zones"
- name: Migrate Azure API Management to availability zone support
url: "https://learn.microsoft.com/en-us/azure/reliability/migrate-api-mgt"

- description: Azure API Management platform version should be stv2
aprlGuid: e35cf148-8eee-49d1-a1c9-956160f99e0b
Expand All @@ -52,8 +48,6 @@
learnMoreLink:
- name: Azure API Management - stv1 platform retirement (August 2024)
url: "https://learn.microsoft.com/en-us/azure/api-management/breaking-changes/stv1-platform-retirement-august-2024"
- name: Azure API Management compute platform
url: "https://learn.microsoft.com/en-us/azure/api-management/compute-infrastructure"

- description: Enable auto-scale for production workloads on API Management services
aprlGuid: c79680ea-de85-44fa-a596-f31fa17a952f
Expand Down Expand Up @@ -105,5 +99,3 @@
learnMoreLink:
- name: Add caching to improve performance in Azure API Management
url: "https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-cache"
- name: Use an external cache in Azure API Management
url: "https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external"
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,3 @@
learnMoreLink:
- name: Disaster recovery for Automation accounts
url: "https://learn.microsoft.com/en-us/azure/automation/automation-disaster-recovery?tabs=win-hrw%2Cps-script%2Coption-one"
- name: Disaster recovery scenarios for cloud and hybrid jobs
url: "https://learn.microsoft.com/en-us/azure/automation/automation-disaster-recovery?tabs=win-hrw%2Cps-script%2Coption-one#scenarios-for-cloud-and-hybrid-jobs"
10 changes: 1 addition & 9 deletions azure-resources/Cdn/profiles/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@
learnMoreLink:
- name: REST API Reference
url: "https://learn.microsoft.com/rest/api/frontdoor/"
- name: Client library for Java
url: "https://learn.microsoft.com/java/api/overview/azure/resourcemanager-frontdoor-readme?view=azure-java-preview"
- name: SDK for Python
url: "https://learn.microsoft.com/python/api/overview/azure/front-door?view=azure-python"

- description: Configure logs
aprlGuid: 1ad74c3c-e3d7-0046-b83f-a2199974ef15
Expand All @@ -52,10 +48,6 @@
learnMoreLink:
- name: Monitor metrics and logs in Azure Front Door
url: "https://learn.microsoft.com/azure/frontdoor/front-door-diagnostics?pivots=front-door-standard-premium"
- name: WAF logs
url: "https://learn.microsoft.com/azure/web-application-firewall/afds/waf-front-door-monitor?pivots=front-door-standard-premium#waf-logs"
- name: Configure Azure Front Door logs
url: "https://learn.microsoft.com/azure/frontdoor/standard-premium/how-to-logs"

- description: Use end-to-end TLS
aprlGuid: d9bd6780-0d6f-cd4c-bc66-8ddcab12f3d1
Expand Down Expand Up @@ -259,4 +251,4 @@
tags: null
learnMoreLink:
- name: Compare pricing between Azure Front Door tiers
url: https://learn.microsoft.com/en-us/azure/frontdoor/understanding-pricing
url: "https://learn.microsoft.com/en-us/azure/frontdoor/understanding-pricing"
2 changes: 0 additions & 2 deletions azure-resources/Compute/disks/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
learnMoreLink:
- name: Azure Shared Disk Introduction
url: "https://learn.microsoft.com/azure/virtual-machines/disks-shared"
- name: Enable Shared Disks
url: "https://learn.microsoft.com/azure/virtual-machines/disks-shared-enable?tabs=azure-portal"

- description: Use Azure Disks with Zone Redundant Storage for higher resiliency and availability
aprlGuid: fa0cf4f5-0b21-47b7-89a9-ee936f193ce1
Expand Down
6 changes: 0 additions & 6 deletions azure-resources/Compute/galleries/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
learnMoreLink:
- name: Compute Gallery best practices
url: "https://learn.microsoft.com/en-us/azure/virtual-machines/azure-compute-gallery#best-practices"
- name: Zone-redundant storage
url: "https://learn.microsoft.com/en-us/azure/storage/common/storage-redundancy#zone-redundant-storage"

- description: Consider creating TrustedLaunchSupported images where possible
aprlGuid: 1c5e1e58-4e56-491c-8529-10f37af9d4ed
Expand All @@ -50,10 +48,6 @@
learnMoreLink:
- name: Compute Gallery best practices
url: "https://learn.microsoft.com/en-us/azure/virtual-machines/azure-compute-gallery#best-practices"
- name: Generation 1 vs Generation 2 in Hyper-V
url: "https://learn.microsoft.com/en-us/windows-server/virtualization/hyper-v/plan/should-i-create-a-generation-1-or-2-virtual-machine-in-hyper-v"
- name: Images in Compute gallery
url: "https://learn.microsoft.com/en-us/azure/virtual-machines/shared-image-galleries?tabs=azure-cli"

- description: Create Image Versions replicas in secondary region
aprlGuid: b14ee8ed-7d27-447b-b6fb-6472cb5f4b75
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
learnMoreLink:
- name: When to use VMSS instead of VMs
url: "https://learn.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-design-overview#when-to-use-scale-sets-instead-of-virtual-machines"
- name: Azure Well-Architected Framework review - Virtual Machines and Scale Sets
url: "https://learn.microsoft.com/azure/well-architected/services/compute/virtual-machines/virtual-machines-review"

- description: Enable Azure Virtual Machine Scale Set Application Health Monitoring
aprlGuid: 94794d2a-eff0-2345-9b67-6f9349d0a627
Expand Down Expand Up @@ -67,8 +65,6 @@
learnMoreLink:
- name: Get started with autoscale in Azure
url: "https://learn.microsoft.com/azure/azure-monitor/autoscale/autoscale-get-started?WT.mc_id=Portal-Microsoft_Azure_Monitoring"
- name: Overview of autoscale in Azure
url: "https://learn.microsoft.com/azure/azure-monitor/autoscale/autoscale-overview"

- description: Enable Predictive autoscale and configure at least for Forecast Only
aprlGuid: 3f85a51c-e286-9f44-b4dc-51d00768696c
Expand Down Expand Up @@ -120,8 +116,6 @@
learnMoreLink:
- name: Create a Virtual Machine Scale Set that uses Availability Zones
url: "https://learn.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-use-availability-zones"
- name: Update scale set to add availability zones
url: "https://learn.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-use-availability-zones?tabs=cli-1%2Cportal-2#update-scale-set-to-add-availability-zones"

- description: Set Patch orchestration options to Azure-orchestrated
aprlGuid: e4ffd7b0-ba24-c84e-9352-ba4819f908c0
Expand All @@ -139,8 +133,6 @@
learnMoreLink:
- name: Automatic VM Guest Patching for Azure VMs
url: "https://learn.microsoft.com/azure/virtual-machines/automatic-vm-guest-patching"
- name: Auto OS Image Upgrades
url: "https://learn.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-automatic-upgrade"

- description: Upgrade VMSS Image versions scheduled to be deprecated or already retired
aprlGuid: 83d61669-7bd6-9642-a305-175db8adcdf4
Expand Down
20 changes: 0 additions & 20 deletions azure-resources/Compute/virtualMachines/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
learnMoreLink:
- name: What has changed with Flexible orchestration mode
url: "https://learn.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-orchestration-modes#what-has-changed-with-flexible-orchestration-mode"
- name: Attach or detach a Virtual Machine to or from a Virtual Machine Scale Set
url: "https://learn.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-attach-detach-vm?branch=main&tabs=portal-1%2Cportal-2%2Cportal-3"

- description: Deploy VMs across Availability Zones
aprlGuid: 2bd0be95-a825-6f47-a8c6-3db1fb5eb387
Expand Down Expand Up @@ -67,8 +65,6 @@
learnMoreLink:
- name: Resiliency checklist for Virtual Machines
url: "https://learn.microsoft.com/azure/architecture/checklist/resiliency-per-service#virtual-machines"
- name: Run a test failover (disaster recovery drill) to Azure
url: "https://learn.microsoft.com/azure/site-recovery/site-recovery-test-failover-to-azure"

- description: Use Managed Disks for VM disks
aprlGuid: 122d11d7-b91f-8747-a562-f56b79bcfbdc
Expand All @@ -86,10 +82,6 @@
learnMoreLink:
- name: Migrate your Azure unmanaged disks by Sep 30, 2025
url: "https://learn.microsoft.com/azure/virtual-machines/unmanaged-disks-deprecation"
- name: Migrate Windows VM from unmanaged disks to managed disks
url: "https://learn.microsoft.com/azure/virtual-machines/windows/convert-unmanaged-to-managed-disks"
- name: Migrate Linux VM from unmanaged disks to managed disks
url: "https://learn.microsoft.com/azure/virtual-machines/linux/convert-unmanaged-to-managed-disks"

- description: Host database data on a data disk
aprlGuid: 4ea2878f-0d69-8d4a-b715-afc10d1e538e
Expand All @@ -107,8 +99,6 @@
learnMoreLink:
- name: Introduction to Azure managed disks - Data disks
url: "https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview#data-disk"
- name: Azure managed disk types
url: "https://learn.microsoft.com/azure/virtual-machines/disks-types"

- description: Backup VMs with Azure Backup service
aprlGuid: 1981f704-97b9-b645-9c57-33f8ded9261a
Expand Down Expand Up @@ -279,8 +269,6 @@
learnMoreLink:
- name: Policy-driven governance
url: "https://learn.microsoft.com/azure/cloud-adoption-framework/ready/landing-zone/design-principles#policy-driven-governance"
- name: Azure Policy Regulatory Compliance controls for Azure Virtual Machines
url: "https://learn.microsoft.com/azure/virtual-machines/security-policy"

- description: Virtual Machines should have Azure Disk Encryption or EncryptionAtHost enabled
aprlGuid: f0a97179-133a-6e4f-8a49-8a44da73ffce
Expand Down Expand Up @@ -315,8 +303,6 @@
learnMoreLink:
- name: Overview of VM insights
url: "https://learn.microsoft.com/azure/azure-monitor/vm/vminsights-overview"
- name: Did the extension install properly?
url: "https://learn.microsoft.com/azure/azure-monitor/vm/vminsights-troubleshoot#did-the-extension-install-properly"

- description: Configure monitoring for all Azure Virtual Machines
aprlGuid: 4a9d8973-6dba-0042-b3aa-07924877ebd5
Expand Down Expand Up @@ -402,8 +388,6 @@
learnMoreLink:
- name: Microsoft Azure Boost
url: "https://learn.microsoft.com/azure/azure-boost/overview"
- name: Announcing the general availability of Azure Boost
url: "https://aka.ms/AzureBoostGABlog"

- description: Enable Scheduled Events for Maintenance sensitive workload VMs
aprlGuid: 2de8fa5e-14f4-4c4c-857f-1520f87a629f
Expand All @@ -421,10 +405,6 @@
learnMoreLink:
- name: Monitor scheduled events for your Azure VMs
url: "https://learn.microsoft.com/azure/virtual-machines/windows/scheduled-event-service"
- name: Azure Metadata Service Scheduled Events for Linux VMs
url: "https://learn.microsoft.com/azure/virtual-machines/linux/scheduled-events"
- name: Azure Metadata Service Scheduled Events for Windows VMs
url: "https://learn.microsoft.com/azure/virtual-machines/windows/scheduled-events"

- description: Reserve Compute Capacity for critical workloads
aprlGuid: 302fda08-ee65-4fbe-a916-6dc0b33169c4
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,6 @@
learnMoreLink:
- name: Registry best practices - Enable geo-replication
url: "https://learn.microsoft.com/en-us/azure/container-registry/container-registry-best-practices#geo-replicate-multi-region-deployments"
- name: Geo-Replicate Container Registry
url: "https://learn.microsoft.com/en-us/azure/container-registry/container-registry-geo-replication"

- description: Use Repository namespaces
aprlGuid: a5a0101a-a240-8742-90ba-81dbde9a0c0c
Expand Down Expand Up @@ -101,8 +99,6 @@
learnMoreLink:
- name: Registry best practices - Manage registry size
url: "https://learn.microsoft.com/en-us/azure/container-registry/container-registry-best-practices#manage-registry-size"
- name: Retention Policy
url: "https://learn.microsoft.com/en-us/azure/container-registry/container-registry-retention-policy#about-the-retention-policy"

- description: Disable anonymous pull access
aprlGuid: 03f4a7d8-c5b4-7842-8e6e-14997a34842b
Expand Down Expand Up @@ -135,8 +131,6 @@
automationAvailable: false
tags: null
learnMoreLink:
- name: Monitoring Azure Container Registry data reference - Resource Logs
url: "https://learn.microsoft.com/en-us/azure/container-registry/monitor-service-reference#resource-logs"
- name: Monitor Azure Container Registry - Enable diagnostic logs
url: "https://learn.microsoft.com/en-us/azure/container-registry/monitor-service#collection-and-routing"

Expand All @@ -154,8 +148,6 @@
automationAvailable: false
tags: null
learnMoreLink:
- name: Monitoring Azure Container Registry data reference
url: "https://learn.microsoft.com/en-us/azure/container-registry/monitor-service-reference#metrics"
- name: Monitor Azure Container Registry
url: "https://learn.microsoft.com/en-us/azure/container-registry/monitor-service"

Expand Down
Loading

0 comments on commit 501324a

Please sign in to comment.