diff --git a/README.md b/README.md index 20080259aa..fc191bee6f 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,20 @@ A suite of rules to validate Azure resources and infrastructure as code (IaC) us Features of PSRule for Azure include: -- [Ready to go][2] - Leverage over 340 pre-built rules to validate Azure resources. -- [DevOps][3] - Validate resources and infrastructure code pre or post-deployment. -- [Cross-platform][4] - Run on MacOS, Linux, and Windows. +- [Learn by example][6] - Fix issues quickly, and learn how to improve your Infrastructure as Code.. +- [Framework aligned][7] - Apply principals of Azure Well-Architected Framework to your workloads. +- [Start day one][2] - Leverage over 340 pre-built rules to test Azure resources. +- [DevOps integrated][3] - Test Azure infrastructure as code such as Bicep or Azure Resource Manager templates. +- [Cross-platform][4] - Run locally or in the cloud on MacOS, Linux, and Windows. +- [Open community][8] - Open source rules for the Azure community. [1]: https://vscode.dev/github/Azure/PSRule.Rules.Azure - [2]: https://azure.github.io/PSRule.Rules.Azure/features/#readytogo - [3]: https://azure.github.io/PSRule.Rules.Azure/features/#devops + [2]: https://azure.github.io/PSRule.Rules.Azure/features/#start-day-one + [3]: https://azure.github.io/PSRule.Rules.Azure/features/#devops-integrated [4]: https://azure.github.io/PSRule.Rules.Azure/features/#cross-platform + [6]: https://azure.github.io/PSRule.Rules.Azure/features/#learn-by-example + [7]: https://azure.github.io/PSRule.Rules.Azure/features/#framework-aligned + [8]: https://azure.github.io/PSRule.Rules.Azure/license-contributing/ ## Project objectives @@ -313,12 +319,14 @@ The following baselines are included within `PSRule.Rules.Azure`. - [Azure.GA_2022_03](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_03/) - Baseline for GA rules released March 2022 or prior. - [Azure.GA_2022_06](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_06/) - Baseline for GA rules released June 2022 or prior. - [Azure.GA_2022_09](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_09/) - Baseline for GA rules released September 2022 or prior. +- [Azure.GA_2022_12](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.GA_2022_12/) - Baseline for GA rules released December 2022 or prior. - [Azure.Preview](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview/) - Includes rules for Azure GA and preview features. - [Azure.Preview_2021_09](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2021_09/) - Baseline for rules released September 2021 or prior for Azure preview only features. - [Azure.Preview_2021_12](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2021_12/) - Baseline for rules released December 2021 or prior for Azure preview only features. - [Azure.Preview_2022_03](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_03/) - Baseline for rules released March 2022 or prior for Azure preview only features. - [Azure.Preview_2022_06](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_06/) - Baseline for rules released June 2022 or prior for Azure preview only features. - [Azure.Preview_2022_09](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_09/) - Baseline for rules released September 2022 or prior for Azure preview only features. +- [Azure.Preview_2022_12](https://azure.github.io/PSRule.Rules.Azure/en/baselines/Azure.Preview_2022_12/) - Baseline for rules released December 2022 or prior for Azure preview only features. ## Language reference diff --git a/docs/about.md b/docs/about.md index 431163d6e2..a17a4c15d6 100644 --- a/docs/about.md +++ b/docs/about.md @@ -18,6 +18,9 @@ PSRule for Azure uses the principles of the Azure Well-Architected Framework (WA - **Link to documentation** — to learn how this applies to your environment. - **Demonstrate** — how you can implement the change with examples. +If you want to write your own tests, you can do that too in your choice of YAML, JSON, or PowerShell. +However with over 340 tests already built, you can identify and fix issues day one. + ## Introducing PSRule for Azure An introduction to PSRule for Azure and how it relates to the Azure Well-Architected Framework. diff --git a/docs/features.md b/docs/features.md index 6672304e12..b33b70dfed 100644 --- a/docs/features.md +++ b/docs/features.md @@ -5,25 +5,36 @@ discussion: false # Features +## Learn by example + +PSRule for Azure helps you quickly identify and fix issues to improve the quality of solutions deployed on Azure. +Tests include documentation with offical documentation references and examples. +Use the Azure Bicep or template examples to adapt your solution to recommendations. + ## Framework aligned PSRule for Azure is aligned to the [Azure Well-Architected Framework (WAF)][2]. Tests called _rules_ check the configuration of Azure resources against WAF principles. Rules exist across five (5) WAF pillars: -- Cost Optimization -- Operational Excellence -- Performance Efficiency -- Reliability -- Security +- [Cost Optimization][9] +- [Operational Excellence][10] +- [Performance Efficiency][11] +- [Reliability][12] +- [Security][13] To help you align your Infrastructure as Code (IaC) to WAF principles, PSRule for Azure includes documentation. Included are examples, references to WAF and product documentation. This allows you to explore and learn the context of each WAF principle. [2]: https://learn.microsoft.com/azure/architecture/framework/ + [9]: en/rules/module.md#cost-optimization + [10]: en/rules/module.md#operational-excellence + [11]: en/rules/module.md#performance-efficiency + [12]: en/rules/module.md#reliability + [13]: en/rules/module.md#security -## Ready to go +## Start day one PSRule for Azure includes over 340 rules for validating resources against configuration recommendations. Rules automatically detect and analyze resources from Azure IaC artifacts. @@ -47,7 +58,7 @@ As new built-in rules are added and improved, download the latest version to sta ## DevOps integrated Azure resources can be validated throughout their lifecycle to support a DevOps culture. -From as early as authoring an ARM template, resources can be validated offline before deployment. +Start testing your Bicep and ARM templates from code by validating them offline before deployment. Pre-flight validation can be integrated into a continuous integration (CI) pipeline as unit tests to: diff --git a/overrides/home.html b/overrides/home.html index c815cd99fe..abd9b77440 100644 --- a/overrides/home.html +++ b/overrides/home.html @@ -298,9 +298,11 @@

PSRule for Azure

Azure · Continuous · Consistency.

- Ready to go validation and governance controls for Azure Infrastructure as Code (IaC). + Ready to go rules for testing Azure Infrastructure as Code (IaC).
- {% include ".icons/octicons/arrow-right-24.svg" %}Get started now + {% include ".icons/octicons/arrow-right-24.svg" %}Learn more +
+ {% include ".icons/octicons/arrow-right-24.svg" %}Get started now
{% include ".icons/octicons/arrow-right-24.svg" %}Contribute on GitHub
@@ -311,26 +313,46 @@
- - + +
+ {% include ".icons/octicons/light-bulb-24.svg" %} +

Learn by example

+

Fix issues quickly, and learn how to improve your Infrastructure as Code.

+
+ + +
+ {% include ".icons/octicons/verified-24.svg" %} +

Framework aligned

+

Apply principals of Azure Well-Architected Framework to your workloads.

+
+ +
{% include ".icons/octicons/rocket-24.svg" %} -

Ready to go

+

Start day one

Leverage over 340 pre-built rules to test Azure resources.

 - +
{% include ".icons/octicons/infinity-24.svg" %} -

DevOps

-

Validate resources and infrastructure code pre or post-deployment.

+

DevOps integrated

+

Test Azure infrastructure as code such as Bicep or Azure Resource Manager templates.

 - +
{% include ".icons/octicons/cpu-24.svg" %}

Cross-platform

-

Run on MacOS, Linux, and Windows.

+

Run locally or in the cloud on MacOS, Linux, and Windows.

+
+ + +
+ {% include ".icons/octicons/code-of-conduct-24.svg" %} +

Open community

+

Open source rules for the Azure community.