Updated feature docs (#2036)
This commit is contained in:
Bernie White
GitHub
Родитель
2501257550
Коммит
22556854f1
18
README.md
18
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
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
|
|
@ -298,9 +298,11 @@
|
|||
<div class="flex-item">
|
||||
<h1>PSRule for Azure</h1>
|
||||
<h2 class="text-white">Azure · Continuous · Consistency.</h2>
|
||||
<span class="text-white">Ready to go validation and governance controls for Azure Infrastructure as Code (IaC).</span>
|
||||
<span class="text-white">Ready to go rules for testing Azure Infrastructure as Code (IaC).</span>
|
||||
<div>
|
||||
<a class="link-arrow text-white mt-4 md-icon" href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}">{% include ".icons/octicons/arrow-right-24.svg" %}Get started now</a>
|
||||
<a class="link-arrow text-white mt-4 md-icon" href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}">{% include ".icons/octicons/arrow-right-24.svg" %}Learn more</a>
|
||||
<br>
|
||||
<a class="link-arrow text-white mt-4 md-icon" href="install-instructions/" title="Installation">{% include ".icons/octicons/arrow-right-24.svg" %}Get started now</a>
|
||||
<br>
|
||||
<a class="link-arrow text-white mt-4 md-icon" href="{{ config.repo_url }}" title="{{ config.repo_name }}">{% include ".icons/octicons/arrow-right-24.svg" %}Contribute on GitHub</a>
|
||||
</div>
|
||||
|
|
@ -311,26 +313,46 @@
|
|||
<section class="section-block feature-block">
|
||||
<div class="md-grid">
|
||||
<div display="flex" class="flex-grid tile-grid">
|
||||
|
||||
<a class="tile" href="{{ page.next_page.url | url }}#readytogo" target="_self" rel="noopener">
|
||||
<a class="tile" href="features/#learn-by-example" target="_self" rel="noopener">
|
||||
<div>
|
||||
{% include ".icons/octicons/light-bulb-24.svg" %}
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">Learn by example</h3>
|
||||
<p>Fix issues quickly, and learn how to improve your Infrastructure as Code.</p>
|
||||
</div>
|
||||
</a>
|
||||
<a class="tile" href="features/#framework-aligned" target="_self" rel="noopener">
|
||||
<div>
|
||||
{% include ".icons/octicons/verified-24.svg" %}
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">Framework aligned</h3>
|
||||
<p>Apply principals of Azure Well-Architected Framework to your workloads.</p>
|
||||
</div>
|
||||
</a>
|
||||
<a class="tile" href="features/#start-day-one" target="_self" rel="noopener">
|
||||
<div>
|
||||
{% include ".icons/octicons/rocket-24.svg" %}
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">Ready to go</h3>
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">Start day one</h3>
|
||||
<p>Leverage over 340 pre-built rules to test Azure resources.</p>
|
||||
</div>
|
||||
</a>
|
||||
<a class="tile" href="{{ page.next_page.url | url }}#devops" target="_self" rel="noopener">
|
||||
<a class="tile" href="features/#devops-integrated" target="_self" rel="noopener">
|
||||
<div>
|
||||
{% include ".icons/octicons/infinity-24.svg" %}
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">DevOps</h3>
|
||||
<p>Validate resources and infrastructure code pre or post-deployment.</p>
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">DevOps integrated</h3>
|
||||
<p>Test Azure infrastructure as code such as Bicep or Azure Resource Manager templates.</p>
|
||||
</div>
|
||||
</a>
|
||||
<a class="tile" href="{{ page.next_page.url | url }}#cross-platform" target="_self" rel="noopener">
|
||||
<a class="tile" href="features/#cross-platform" target="_self" rel="noopener">
|
||||
<div>
|
||||
{% include ".icons/octicons/cpu-24.svg" %}
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">Cross-platform</h3>
|
||||
<p>Run on MacOS, Linux, and Windows.</p>
|
||||
<p>Run locally or in the cloud on MacOS, Linux, and Windows.</p>
|
||||
</div>
|
||||
</a>
|
||||
<a class="tile" href="license-contributing/" target="_self" rel="noopener">
|
||||
<div>
|
||||
{% include ".icons/octicons/code-of-conduct-24.svg" %}
|
||||
<h3 class="h4 text-brand font-weight-600 mb-3">Open community</h3>
|
||||
<p>Open source rules for the Azure community.</p>
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче