mirror of
https://github.com/FairwindsOps/polaris.git
synced 2026-05-21 16:43:57 +00:00
1a8fb44b78
* first pass * fix up homepage * more work * housekeeping * add script to modify home link * add check docs * build docs site * Create CNAME * fix path to check-docs * update from template * fix logo in readme * fix link * remove logspam * remove old folders * fix all links * fix up readme * change up Insights description * add customization docs * phrasing * title * titles * titles * change webhook docs * refresh template * rebuild site * refresh from template repo * phrasing * add tagline * update readme\, add readme sync script * fix logo * rebuild * fix readme script * rebuild
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# Infrastructure as Code
|
|
Polaris can be used on the command line to audit local Kubernetes manifests stored in YAML files.
|
|
This is particularly helpful for running Polaris against your infrastructure-as-code as part of a
|
|
CI/CD pipeline. Use the available [command line flags](#running-in-a-ci-pipeline)
|
|
to cause CI/CD to fail if your Polaris score drops below a certain threshold, or if any danger-level issues arise.
|
|
|
|
|
|
## Install the CLI
|
|
To run Polaris against your YAML manifests, e.g. as part of a Continuous Integration process,
|
|
you'll need to install the CLI.
|
|
|
|
Binary releases can be downloaded from the [releases page](https://github.com/fairwindsops/polaris/releases)
|
|
or can be installed with [Homebrew](https://brew.sh/):
|
|
```bash
|
|
brew tap FairwindsOps/tap
|
|
brew install FairwindsOps/tap/polaris
|
|
polaris version
|
|
```
|
|
|
|
## Running in a CI pipeline
|
|
You can tell the CLI to set an exit code if it detects certain issues with your
|
|
YAML files.
|
|
For example, to fail if polaris detects *any* danger-level issues, or if the score drops below 90%:
|
|
```bash
|
|
polaris audit --audit-path ./deploy/ \
|
|
--set-exit-code-on-danger \
|
|
--set-exit-code-below-score 90
|
|
```
|
|
|