e895506405 | ||
---|---|---|
.azure-pipelines | ||
.github | ||
.vscode | ||
docs | ||
src/PSRule.Rules.Kubernetes | ||
tests/PSRule.Rules.Kubernetes.Tests | ||
.gitignore | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
RuleHelp.Doc.ps1 | ||
RuleToc.Doc.ps1 | ||
pipeline.build.ps1 | ||
ps-project.yaml |
README.md
PSRule for Kubernetes
A suite of rules to validate Kubernetes resources using PSRule.
Disclaimer
This project is to be considered a proof-of-concept and not a supported product.
For issues with rules and documentation please check our GitHub issues page. If you do not see your problem captured, please file a new issue and follow the provided template.
If you have any problems with the PSRule engine, please check the project GitHub issues page instead.
Getting the modules
This project requires the PowerShell module PSRule.
You can download and install these modules from the PowerShell Gallery.
Module | Description | Downloads / instructions |
---|---|---|
PSRule.Rules.Kubernetes | Validate Kubernetes resources | latest / instructions |
Getting started
Offline with a manifest
Kubernetes resources can be evaluated within a YAML manifest file.
Invoke-PSRule -Module PSRule.Rules.Kubernetes -InputPath .\service.yaml;
Online with kubectl
Invoke-PSRule -Module PSRule.Rules.Kubernetes -InputObject (kubectl get services -o yaml | Out-String) -Format Yaml -ObjectPath items;
Rule reference
The following rules are included in the PSRule.Rules.Kubernetes
module:
Changes and versioning
Modules in this repository will use the semantic versioning model to declare breaking changes from v1.0.0. 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.
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
License
This project is licensed under the MIT License.