Document ModifySet and assign.fromMetadata #1718
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes open-policy-agent#1702 Fixes open-policy-agent#1700 Signed-off-by: Max Smythe <smythe@google.com>
maxsmythe
requested review from
shomron,
sozercan,
ritazh,
julianKatz and
willbeason
willbeason
approved these changes
Dec 3, 2021
|
This looks great! |
sozercan
reviewed
Dec 3, 2021
website/docs/mutation.md
Outdated
| Note that the `applyTo` section applies to the Assign CRD only. It allows filtering of resources by the resource GVK (group version kind). Note that the `applyTo` section does not accept globs. | ||
| Note that the `applyTo` field is required for `Assign` and `ModifySet` mutators, and does not exist for `AssignMetadata` mutators. | ||
| It allows Gatekeeper to understand the schema of the objects being modified, so that it can detect when two mutators disagree as | ||
| to a kind's schema, which can cause non-convegent mutations. Also, the `applyTo` section does not accept globs. |
There was a problem hiding this comment.
Suggested change
| to a kind's schema, which can cause non-convegent mutations. Also, the `applyTo` section does not accept globs. | |
| to a kind's schema, which can cause non-convergent mutations. Also, the `applyTo` section does not accept globs. |
sozercan
reviewed
Dec 3, 2021
website/docs/mutation.md
Outdated
| @@ -60,25 +62,27 @@ match: | |||
| excludedNamespaces: [] | |||
| ``` | |||
|
|
|||
| Note that the `applyTo` section applies to the Assign CRD only. It allows filtering of resources by the resource GVK (group version kind). Note that the `applyTo` section does not accept globs. | |||
| Note that the `applyTo` field is required for `Assign` and `ModifySet` mutators, and does not exist for `AssignMetadata` mutators. | |||
| It allows Gatekeeper to understand the schema of the objects being modified, so that it can detect when two mutators disagree as | |||
There was a problem hiding this comment.
Can we clarify initial "it" here?
There was a problem hiding this comment.
changed to applyTo
sozercan
reviewed
Dec 3, 2021
website/docs/mutation.md
Outdated
| The extent of changes section describes the resource which will be mutated. | ||
| It allows to filter the resources to be mutated by kind, label and namespace. | ||
| The extent of changes section describes which resources will be mutated. | ||
| It allows selecting resources to be mutated using the same match critia |
There was a problem hiding this comment.
Suggested change
| It allows selecting resources to be mutated using the same match critia | |
| It allows selecting resources to be mutated using the same match criteria |
sozercan
approved these changes
Dec 3, 2021
Signed-off-by: Max Smythe <smythe@google.com>
|
Thanks for the review! |
priyamshet
pushed a commit
to priyamshet/gatekeeper-1
that referenced
this pull request
Dec 14, 2021
* Document ModifySet and assign.fromMetadata Fixes open-policy-agent#1702 Fixes open-policy-agent#1700 Signed-off-by: Max Smythe <smythe@google.com> * Fix spelling errors Signed-off-by: Max Smythe <smythe@google.com> Signed-off-by: Priya Shetpriya.shet@gmail.com <priya.shet@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1702
Fixes #1700
Signed-off-by: Max Smythe smythe@google.com
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #
Special notes for your reviewer: