Include parameterNotFoundAction in Validating Admission Policy documentation #48734
Conversation
…ation - Added a description of the `parameterNotFoundAction` field to the `paramRef` section of the Validating Admission Policy documentation. - Clarified the behavior and allowed values (`Allow` and `Deny`) of the `parameterNotFoundAction` field in relevant sections. - Highlighted the importance of setting `parameterNotFoundAction` for policy bindings using parameter resources.
Updated YAML second example: binding-with-param.yaml to include the required `parameterNotFoundAction` field.
Updated YAML second example: binding-with-param-prod.yaml to include the required `parameterNotFoundAction` field.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
cncf-cla: no
|
Welcome @Lahoussine-Bouhmou! |
k8s-ci-robot
added
the
size/M
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@Lahoussine-Bouhmou Thanks you for your contribution. |
k8s-ci-robot
added
cncf-cla: yes
|
/sig api-machinery |
k8s-ci-robot
added
the
sig/api-machinery
|
|
||
| One of `name` or `selector` must be set, but not both. | ||
|
|
||
| **Note:** The `parameterNotFoundAction` field in `paramRef` is **required**. It specifies the action to take when no parameters are found matching the `paramRef`. If not specified, the policy binding may be considered invalid and will be ignored or could lead to unexpected behavior. |
There was a problem hiding this comment.
We could use note shortcode here.
Refer the guidance on how to use it : https://kubernetes.io/docs/contribute/style/style-guide/#note
content/en/docs/reference/access-authn-authz/validating-admission-policy.md
Show resolved
Hide resolved
…ss-authn-authz/validating-admission-policy.md Changed :: Deny By: Deny ``` Co-authored-by: Dipesh Rawat <[email protected]>
Replaced manual note with note shortcode for the parameterNotFoundAction section as per style guide.
|
@dipesh-rawat
Let me know if there's anything else to adjust! |
Description
This pull request updates the Kubernetes documentation for Validating Admission Policies to include details about the
parameterNotFoundActionfield inValidatingAdmissionPolicyBinding.Changes made:
parameterNotFoundActionfield to theparamRefsection invalidating-admission-policy.md, describing its purpose, allowed values (AllowandDeny), and behavior.binding-with-param.yamlandbinding-with-param-prod.yaml) to include theparameterNotFoundActionfield, ensuring consistency with the API requirements.parameterNotFoundActionfor policy bindings that use parameter resources.This change addresses the omission of
parameterNotFoundActionfrom the documentation, which can lead to misconfigurations or confusion for users configuring admission policies.