From 2bcbb42f5c99c7f7b1e2987826682fe48b2cf770 Mon Sep 17 00:00:00 2001 From: Jeff Yuan Date: Tue, 18 Jul 2023 13:10:55 +1200 Subject: [PATCH] make gator in README lower cased to keep consistent with official doc --- pkg/operator/controllers/guardrails/policies/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/operator/controllers/guardrails/policies/README.md b/pkg/operator/controllers/guardrails/policies/README.md index 9640742bf6d..96abcf672a9 100644 --- a/pkg/operator/controllers/guardrails/policies/README.md +++ b/pkg/operator/controllers/guardrails/policies/README.md @@ -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: @@ -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 @@ -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: