From 602dd2a16d440b80e1a64aababe084b540411aef Mon Sep 17 00:00:00 2001 From: cmendible <266546+cmendible@users.noreply.github.com> Date: Thu, 22 Aug 2024 10:41:16 +0200 Subject: [PATCH] chore: updated README.md and docs --- README.md | 13 +++++++++---- docs/content/en/docs/Related/_index.md | 24 ++++++++++++++++++------ 2 files changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f5cc2e3..7193738 100644 --- a/README.md +++ b/README.md @@ -190,12 +190,17 @@ For information on available commands and help run: ./azqr -h ``` -### Excluding Recommendations and more +## Filtering Recommendations and more -To prevent Azure Quick Review from scanning specific subscriptions, resource groups, services or recommendations, create a `yaml` file with the following format: +You can configure Azure Quick Review to include or exclude specific subscriptions or resource groups and also exclude services or recommendations. To do so, create a `yaml` file with the following format: ```yaml azqr: + include: + subscriptions: + - # format: + resourceGroups: + - # format: /subscriptions//resourceGroups/ exclude: subscriptions: - # format: @@ -207,10 +212,10 @@ azqr: - # format: ``` -Then run the scan with the `--exclude` flag: +Then run the scan with the `--filters` flag: ```bash -./azqr scan --exclude +./azqr scan --filters ``` > Check the [rules](https://azure.github.io/azqr/docs/recommendations/) to get the recommendation ids. diff --git a/docs/content/en/docs/Related/_index.md b/docs/content/en/docs/Related/_index.md index 8b4bd44..5dd9dcf 100644 --- a/docs/content/en/docs/Related/_index.md +++ b/docs/content/en/docs/Related/_index.md @@ -1,17 +1,29 @@ --- title: Releated Projects -description: Azure Quick Review difference to Azure Review Checklists and PSRule.Rules.Azure +description: Azure Quick Review compared to APRL, Azure Review Checklists and PSRule.Rules.Azure weight: 6 --- +## AZQR and APRL + +As of version 2.0.0-preview, **Azure Quick Review (azqr)** includes all [Azure Resource Graph](https://learn.microsoft.com/azure/governance/resource-graph/overview) queries provided by the the [Azure Proactive Resiliency Library (APRL)](https://aka.ms/aprl), which are used to identify non-compliant resources. + +**Azure Quick Review (azqr)** extends [APRL](https://aka.ms/aprl) by providing per service instance SLAs, Diagnostic Settings detection and more. Therefore, scan results display `AZQR` or `APRL`, to indicate the source of the recommendation. + +> **APRL** provides a curated catalog of resiliency recommendations for workloads running in Azure. Many of the recommendations contain supporting Azure Resource Graph (ARG) queries + +## AZQR compared to Azure Review Checklists and PSRule.Rules.Azure + **Azure Quick Review (azqr)** was created to address a very specific need we had back in 2022. Initially, we had to run three assessments to get a clear picture of various solutions in terms of SLAs, use of Availability Zones, and Diagnostic Settings. At the time, we were not aware of the existence of the [`review-checklist`](https://github.com/Azure/review-checklists) or [`PSRule.Rules.Azure`](https://github.com/Azure/PSRule.Rules.Azure). -When some of our peers saw the assessments we were able to deliver with the early bits of **Azure Quick Review (azqr)**, they asked us to add more checks (rules) and change the output format from markdown to Excel. +When some of our peers saw the assessments we were able to deliver with the early bits of **Azure Quick Review (azqr)**, they asked us to add more checks (recommendations) and change the output format from markdown to Excel. + +As many of our customers work in restrictive environments, the ability to run a self-contained, cross-platform binary while using read-only permissions became a key feature. -Also, many of our customers work in very restrictive environments. Therefore, the ability to run a self-contained binary, in any OS, which requires read-only permissions was very important. +Moving forward to 2023, based on great feedback from both peers and customers, we moved the original repo to the [Azure](https://aka.ms/azqr) organization, added support for more services, fixed some issues and even added a Power BI template. -Moving forward to 2023, based on great feedback from both peers and customers, we moved the original repo to the Azure organization, added support for more services, fixed some issues and even added a Power BI template. +In August 2024, we added all [APRL](https://aka.ms/aprl) recommendations to **Azure Quick Review (azqr)** and removed duplicates in favor of the ones already available as [Azure Resource Graph](https://learn.microsoft.com/azure/governance/resource-graph/overview) queries. -To be open we are giving **Azure Quick Review (azqr)** a "best effort" approach, and since we learned about [`PSRule.Rules.Azure`](https://github.com/Azure/PSRule.Rules.Azure), we are slowly trying to catch up with their great set of rules, with no intention to replace Bernie White's and collaborators outstanding work. +When compared with [`PSRule.Rules.Azure`](https://github.com/Azure/PSRule.Rules.Azure), **Azure Quick Review (azqr)** only scans deployed Azure resources and provides recommendations based on the current state. **Azure Quick Review (azqr)** does not scan ARM templates or Bicep files. -Long Story short, given the fact that each solution is built using different technologies and have a different set of features, there is room for both. +When compared to the [`review-checklist`](https://github.com/Azure/review-checklists), **Azure Quick Review (azqr)** also provides an actionable list of more than 400 recommendations (70+ Azure resource types), that can be used to improve the resiliency of your Azure solutions. \ No newline at end of file