Skip to content

Commit

Permalink
make gator in README lower cased to keep consistent with official doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yjst2012 committed Jul 18, 2023
1 parent fd88b39 commit 2bcbb42
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions pkg/operator/controllers/guardrails/policies/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Make sure the filename of constraint is the same as the .metadata.name of the Co
Generating gktemplates/aro-deny-machine-config.yaml from gktemplates-src/aro-deny-machine-config/aro-deny-machine-config.tmpl
```

## Test policy with Gator
## Test policy with gator

Create suite.yaml and testcases in gator-test folder under the folder created for the new policy, refer example below:

Expand Down Expand Up @@ -199,7 +199,7 @@ tests:
```
gkconstraints-test here stores the target yaml files after expanding "{{.Enforcement}}" symbol.

Gator tests ConstraintTemplate and Constraint together, items under cases keyword are test cases indicator, everyone pointing to a yaml file in gator-test, which provides test input for one scenario, example:
gator tests ConstraintTemplate and Constraint together, items under cases keyword are test cases indicator, everyone pointing to a yaml file in gator-test, which provides test input for one scenario, example:

```yaml
apiVersion: v1
Expand Down Expand Up @@ -241,7 +241,7 @@ or below cmd after test.sh has been executed:
gator verify . [-v] #-v for verbose
```

Sometimes we need to mock kube admission review request especially as Gator test inputs when verifying policies that check specific operations (e.g., CREATE, DELETE or UPDATE).
Sometimes we need to mock kube admission review request especially as gator test inputs when verifying policies that check specific operations (e.g., CREATE, DELETE or UPDATE).

Please refer the yaml file below as a sample of kube admission review request:

Expand Down

0 comments on commit 2bcbb42

Please sign in to comment.