Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rbren committed Jul 21, 2020
1 parent cf7eb00 commit 38a9ba6
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ brew install reactiveops/tap/polaris
polaris dashboard --port 8080
```

You can also point the dashboard to the local filesystem, instead of a live cluster:
```bash
polaris dashboard --port 8080 --audit-path=./deploy/
```

## Webhook
### kubectl
```bash
Expand Down Expand Up @@ -145,13 +150,19 @@ polaris audit --format score
# 92
```

Both the dashboard and audits can run against a local directory or YAML file
rather than a cluster:
Audits can run against a local directory or YAML file rather than a cluster:
```bash
polaris audit --audit-path ./deploy/

# or to use STDIN
cat pod.yaml | polaris audit --audit-path -
```

You can also run the audit on a single resource instead of the entire cluster:
```bash
polaris audit --resource "nginx-ingress/Deployment.apps/v1/default-backend"
```

#### Running with CI/CD
You can integrate Polaris into CI/CD for repositories containing infrastructure-as-code.
For example, to fail if polaris detects *any* danger-level issues, or if the score drops below 90%:
Expand Down Expand Up @@ -207,6 +218,8 @@ webhook
# audit flags
--audit-path string
If specified, audits one or more YAML files instead of a cluster
--resource string
If specified, audit a specific resource, in the format namespace/kind/version/name, e.g. nginx-ingress/Deployment.apps/v1/default-backend
--display-name string
An optional identifier for the audit
--format string
Expand Down

0 comments on commit 38a9ba6

Please sign in to comment.