docs: add Helm chart installation flow to the installation guide - #394
docs: add Helm chart installation flow to the installation guide#394Ujjwal-Gowda wants to merge 1 commit into
Conversation
kubernetes-prow
Bot
added
do-not-merge/invalid-commit-message
✅ Deploy Preview for node-readiness-controller canceled.
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Ujjwal-Gowda The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
|
|
Welcome @Ujjwal-Gowda! |
kubernetes-prow
Bot
added
needs-ok-to-test
|
Hi @Ujjwal-Gowda. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
kubernetes-prow
Bot
added
the
size/M
The Helm chart added in kubernetes-sigs#163 was not covered by the user guide, which only documented the release manifests, Kustomize and static pod paths. Add a Helm section alongside the existing options covering minimal and full (metrics + validating webhook) installs, upgrades, and the CRD lifecycle caveat: Helm installs the CRD from the chart's crds/ directory on first install only, and never upgrades or deletes it. Also note in Verification that the chart labels its pods with app.kubernetes.io/name=nrr-controller, so the documented component=node-readiness-controller selector returns nothing for a Helm install, and add the helm uninstall path to Uninstallation. All commands were verified against a kind cluster: fresh install creates the CRD and rolls out, the full-install values render the secure metrics flags and ValidatingWebhookConfiguration, and the CRD survives helm uninstall as described. Ref kubernetes-sigs#387 Signed-off-by: Ujjwal Gowda <crystalninja0123@gmail.com>
c9e59ac to
2e9d843
Compare
kubernetes-prow
Bot
removed
the
do-not-merge/invalid-commit-message
|
|
||
| A Helm chart is maintained in-tree at [`charts/nrr-controller`](https://github.com/kubernetes-sigs/node-readiness-controller/tree/main/charts/nrr-controller). Use it when you want the optional components (metrics, webhook, cert-manager integration) toggled through values rather than by composing Kustomize overlays. | ||
|
|
||
| > [!NOTE] |
There was a problem hiding this comment.
we are looking to handle this for upcoming release. I think this doc update could wait for it to not confuse readers.
kubernetes-prow
Bot
added
cncf-cla: yes
2 participants
Description
The Helm chart added in #163 was not covered by the user guide. The installation page only documented the release manifests, Kustomize and static pod paths, so there was no documented way to install the chart.
This adds a Helm section alongside the existing options:
crds/directory on first install only, and never upgrades or deletes it, so CRD changes across chart versions have to be applied by hand.Two smaller fixes in the same page:
app.kubernetes.io/name=nrr-controller, so thecomponent=node-readiness-controllerselector documented for the manifest install returns nothing for a Helm install. Noted, with the correct selector.helm uninstallpath, including the fact that the CRD is left behind.Related Issue
Fixes #387
Type of Change
/kind documentation
Testing
Docs-only change, but every command in the new section was run against a kind cluster rather than written from the chart source:
helm installcreates the CRD and the controller rolls out.ValidatingWebhookConfiguration.helm uninstall, as described.Checklist
make testpassesmake lintpassesNo Go code is touched, so neither target exercises this change; leaving them unticked rather than claiming a run I have not completed locally. CI will cover them.
Does this PR introduce a user-facing change?