Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update operation generate in deployment yaml and add docs #3738

Merged
merged 4 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion website/docs/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ At a high level, this requires:
* It will also need the ability to write to the webhook secret in Gatekeeper's namespace
* If you have events enabled, you will need permissions to create events in Gatekeeper's namespace


## Mutating Webhook

__--operation key:__ `mutation-webhook`
Expand Down Expand Up @@ -185,3 +184,25 @@ At a high level, this requires:
"Read" implies the `get`, `list`, and `watch` permissions. In some cases, like scraping audit results,
`watch` is unnecessary, but does not substantially increase the power delegated to the service account
under the theory that a `watch` is simply a more efficient version of polling `list`.

## Generation

__--operation key:__ `generate`

This operation serves .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

incomplete?


### Required Behaviors

At a high level, this requires:

* Creating CRDs for a corresponding constraint template
* Creating ValidatingAdmissionPolicies for ConstraintTemplates
* Creating ValidatingAdmissionPolicyBindings for Constraints

### Permissions Required

* The ability to read all `ConstraintTemplate` objects
* The ability to create CRDs (unfortunately RBAC doesn't have the syntax to scope this down to just CRDs in the `constraints.gatekeeper.sh` group)
* The ability to read all `Constraint` resources (members of the group `constraints.gatekeeper.sh`)
* The ability to read all `ValidatingAdmissionPolicy` objects
* The ability to read all `ValidatingAdmissionPolicyBinding` objects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vap and vapb should be "write"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated it

22 changes: 22 additions & 0 deletions website/versioned_docs/version-v3.18.x/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,3 +185,25 @@ At a high level, this requires:
"Read" implies the `get`, `list`, and `watch` permissions. In some cases, like scraping audit results,
`watch` is unnecessary, but does not substantially increase the power delegated to the service account
under the theory that a `watch` is simply a more efficient version of polling `list`.

## Generation

__--operation key:__ `generate`

This operation serves .

### Required Behaviors

At a high level, this requires:

* Creating CRDs for a corresponding constraint template
* Creating ValidatingAdmissionPolicies for ConstraintTemplates
* Creating ValidatingAdmissionPolicyBindings for Constraints

### Permissions Required

* The ability to read all `ConstraintTemplate` objects
* The ability to create CRDs (unfortunately RBAC doesn't have the syntax to scope this down to just CRDs in the `constraints.gatekeeper.sh` group)
* The ability to read all `Constraint` resources (members of the group `constraints.gatekeeper.sh`)
* The ability to read all `ValidatingAdmissionPolicy` objects
* The ability to read all `ValidatingAdmissionPolicyBinding` objects