docs: Fix mutatingWebhookTimeoutSeconds default in the README#4490
docs: Fix mutatingWebhookTimeoutSeconds default in the README#4490zephyrdb wants to merge 1 commit into
Conversation
|
Signed-off-by: Danielle Zephyr Malament <danielle.zephyr@mongodb.com>
zephyrdb
force-pushed
the
fix-mutatingWebhookTimeoutSeconds-readme
branch
from
74fe2be to
0c5cfcf
Compare
There was a problem hiding this comment.
Pull request overview
Fixes an incorrect documented default for the Helm chart value mutatingWebhookTimeoutSeconds in the Gatekeeper chart README so that it matches the actual default in values.yaml.
Changes:
- Update
mutatingWebhookTimeoutSecondsdefault incharts/gatekeeper/README.mdfrom3to1.
| | mutatingWebhookObjectSelector | The label selector to further refine which namespaced resources will be selected by the webhook. Please note that an exemption label means users can circumvent Gatekeeper's mutation webhook unless measures are taken to control how exemption labels can be set. | `{}` | | ||
| | mutatingWebhookMatchConditions | The match conditions written in CEL to further refine which resources will be selected by the webhook. All match conditions must evaluate to true for the webhook to be called | `[]` | | ||
| | mutatingWebhookTimeoutSeconds | The timeout for the mutating webhook in seconds | `3` | | ||
| | mutatingWebhookTimeoutSeconds | The timeout for the mutating webhook in seconds | `1` | |
There was a problem hiding this comment.
This updates the default here to 1, but the generated chart docs still show mutatingWebhookTimeoutSeconds default as 3 in cmd/build/helmify/static/README.md (copied into manifest_staging/charts/gatekeeper/README.md by cmd/build/helmify/main.go). This creates inconsistent documentation within the repo and future chart regeneration is likely to revert this value back to 3 unless the static/template README is also updated.
JaydipGabani
left a comment
JaydipGabani
left a comment
There was a problem hiding this comment.
You need to update README here -
gatekeeper/cmd/build/helmify/static/README.md
Line 170 in 0730534
After the change in the linked file, you need to run make manifests generate so that the same change appears under manifest_staging/charts/gatekeeper/README.md and then push the changes.
Also, can you do easyCLA as well for the CI to turn green. Thanks for noticing this and fixing it.
ogulcanaydogan
left a comment
ogulcanaydogan
left a comment
There was a problem hiding this comment.
Checked values.yaml, default is indeed 1. README was out of sync. LGTM.
|
This PR has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions. |
What this PR does / why we need it:
The default value for mutatingWebhookTimeoutSeconds is incorrect in the README.
See
gatekeeper/charts/gatekeeper/values.yaml
Line 54 in 2a90be7
Maybe the whole thing needs to be regenerated from the chart, though?