Updates to repo doco (#249)
This commit is contained in:
Родитель
7a13e79c92
Коммит
552940d93d
|
@ -8,12 +8,12 @@
|
|||
- [ ] Summarized changes
|
||||
- [ ] Change is not breaking
|
||||
- [ ] This PR is ready to merge and is not **Work in Progress**
|
||||
- **Code changes**
|
||||
- [ ] Unit tests created/ updated
|
||||
- [ ] Link to a filed issue
|
||||
- [ ] [Change log](https://github.com/BernieWhite/PSRule.Rules.Azure/blob/master/CHANGELOG.md) has been updated with change under unreleased section
|
||||
- **Rule changes**
|
||||
- [ ] Unit tests created/ updated
|
||||
- [ ] Rule documentation created/ updated
|
||||
- [ ] Link to a filed issue
|
||||
- [ ] [Change log](https://github.com/BernieWhite/PSRule.Rules.Azure/blob/master/CHANGELOG.md) has been updated with change under unreleased section
|
||||
- **Other code changes**
|
||||
- [ ] Unit tests created/ updated
|
||||
- [ ] Link to a filed issue
|
||||
- [ ] [Change log](https://github.com/BernieWhite/PSRule.Rules.Azure/blob/master/CHANGELOG.md) has been updated with change under unreleased section
|
||||
|
|
|
@ -6,7 +6,7 @@ A suite of rules to validate Azure resources using PSRule.
|
|||
|
||||
Features of PSRule for Azure include:
|
||||
|
||||
- [Ready to go](docs/features.md#ready-to-go) - Leverage over 70 pre-built rules to validate Azure resources.
|
||||
- [Ready to go](docs/features.md#ready-to-go) - Leverage over 80 pre-built rules to validate Azure resources.
|
||||
- [DevOps](docs/features.md#devops) - Validate resources pre or post-deployment.
|
||||
- [Cross-platform](docs/features.md#cross-platform) - Run on MacOS, Linux and Windows.
|
||||
|
||||
|
@ -182,7 +182,9 @@ Modules in this repository will use the [semantic versioning](http://semver.org/
|
|||
Prior to v1.0.0, breaking changes may be introduced in minor (0.x.0) version increments.
|
||||
For a list of module changes please see the [change log](CHANGELOG.md).
|
||||
|
||||
> Pre-release module versions are created on major commits and can be installed from the PowerShell Gallery. Pre-release versions should be considered experimental. Modules and change log details for pre-releases will be removed as standard releases are made available.
|
||||
> Pre-release module versions are created on major commits and can be installed from the PowerShell Gallery.
|
||||
> Pre-release versions should be considered experimental.
|
||||
> Modules and change log details for pre-releases will be removed as standard releases are made available.
|
||||
|
||||
## Maintainers
|
||||
|
||||
|
|
|
@ -8,21 +8,29 @@ The following sections describe key features of PSRule for Azure.
|
|||
|
||||
## Ready to go
|
||||
|
||||
PSRule for Azure includes over 70 rules for validating resources against configuration recommendations.
|
||||
PSRule for Azure includes over 80 rules for validating resources against configuration recommendations.
|
||||
Each rule includes additional information to help remediate validation issues.
|
||||
|
||||
Use the built-in rules to start enforcing release processes quickly.
|
||||
Then layer on your own rules as your organization's requirements mature.
|
||||
Custom rules can be implemented quickly and work side-by-side with built-in rules.
|
||||
|
||||
As new built-in rules are added and improved, download the latest PowerShell module to start using them.
|
||||
|
||||
## DevOps
|
||||
|
||||
Azure resources can be validated early in the lifecycle to support a DevOps culture.
|
||||
Azure resources can be validated throughout their lifecycle to support a DevOps culture.
|
||||
|
||||
- Validate templates before deployment to identify configuration issues pre-flight in continuous integration (CI) processes.
|
||||
- Validate resources after deployment to implement quality gates in-flight between environments such as dev, test, production.
|
||||
From as early as authoring a Azure Resource Manager (ARM) template, resources can be validated offline.
|
||||
Pre-flight validation can be integrated into a continuous integration (CI) processes to:
|
||||
|
||||
- Identify configuration issues and provide fast feedback in a pull request.
|
||||
- Implement quality gates between environments such as development, test and production.
|
||||
- Perform ongoing checks for configuration optimization opportunities.
|
||||
|
||||
PSRule for Azure provides the following cmdlets that extract data for analysis:
|
||||
|
||||
- [Export-AzTemplateRuleData](commands/PSRule.Rules.Azure/en-US/Export-AzTemplateRuleData.md) - Used for pre-flight analysis of one or more Azure Resource Manager templates.
|
||||
- [Export-AzTemplateRuleData](commands/PSRule.Rules.Azure/en-US/Export-AzTemplateRuleData.md) - Used for pre-flight analysis of one or more ARM templates.
|
||||
- [Export-AzRuleData](commands/PSRule.Rules.Azure/en-US/Export-AzRuleData.md) - Used for in-flight analysis of resources deployed to one or more Azure subscriptions.
|
||||
|
||||
## Cross-platform
|
||||
|
|
Загрузка…
Ссылка в новой задаче