Skip to content

Commit 70e9163

Browse files
docs: follow the chart rename and fix the verification selector
The chart directory and name became node-readiness-controller in kubernetes-sigs#407, so the install, upgrade and uninstall commands in the Helm section needed updating along with the path to the bundled CRD. Also fixes the selector in Verification. It looked for component=node-readiness-controller, and nothing sets a component label, not the chart and not the kustomize manifests, so the command matched no pods on either path. Both set control-plane=controller-manager, so use that. A reader following the new Helm section lands on those commands straight after installing. Signed-off-by: tejassinghbhati <tejassinghbhati077@gmail.com>
1 parent 780a2b7 commit 70e9163

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/book/src/user-guide/installation.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ docker pull $REPO:$TAG
6464
```
6565
### Option 2: Helm Chart
6666

67-
The chart lives in the repository under `charts/nrr-controller`. Published chart releases via `registry.k8s.io` OCI are still work in progress, so install it from a checkout for now.
67+
The chart lives in the repository under `charts/node-readiness-controller`. Published chart releases via `registry.k8s.io` OCI are still work in progress, so install it from a checkout for now.
6868

6969
```sh
7070
git clone https://github.com/kubernetes-sigs/node-readiness-controller.git
7171
cd node-readiness-controller
7272

73-
helm install nrr-controller ./charts/nrr-controller \
73+
helm install node-readiness-controller ./charts/node-readiness-controller \
7474
--namespace nrr-system --create-namespace
7575
```
7676

@@ -79,9 +79,9 @@ Requires Helm 3.x. This deploys the controller with the same defaults as the sta
7979
For anything beyond a couple of overrides, keep your settings in a file instead of a long `--set` list:
8080

8181
```sh
82-
helm show values ./charts/nrr-controller > custom-values.yaml
82+
helm show values ./charts/node-readiness-controller > custom-values.yaml
8383

84-
helm install nrr-controller ./charts/nrr-controller \
84+
helm install node-readiness-controller ./charts/node-readiness-controller \
8585
--namespace nrr-system --create-namespace \
8686
-f custom-values.yaml
8787
```
@@ -99,7 +99,7 @@ Everything beyond the core controller is opt-in, matching the kustomize componen
9999
The webhook rejects rules whose taint key and effect collide with an existing rule over an overlapping node selector, so it is worth enabling in production.
100100

101101
```sh
102-
helm install nrr-controller ./charts/nrr-controller \
102+
helm install node-readiness-controller ./charts/node-readiness-controller \
103103
--namespace nrr-system --create-namespace \
104104
--set certManager.enabled=true \
105105
--set webhook.enabled=true \
@@ -157,7 +157,7 @@ Pull the version of the chart you want and upgrade the release in place. Values
157157
```sh
158158
git pull
159159
160-
helm upgrade nrr-controller ./charts/nrr-controller \
160+
helm upgrade node-readiness-controller ./charts/node-readiness-controller \
161161
--namespace nrr-system \
162162
-f custom-values.yaml
163163
```
@@ -167,7 +167,7 @@ helm upgrade nrr-controller ./charts/nrr-controller \
167167
Check what changed before applying it to a live cluster:
168168

169169
```sh
170-
helm diff upgrade nrr-controller ./charts/nrr-controller --namespace nrr-system # needs the helm-diff plugin
170+
helm diff upgrade node-readiness-controller ./charts/node-readiness-controller --namespace nrr-system # needs the helm-diff plugin
171171
```
172172

173173
Read the CRD note below first. Helm will not update the CRD for you, so a chart bump that changes the schema needs that step done by hand.
@@ -179,7 +179,7 @@ Helm installs the CRD from the chart's `crds/` directory on first install only.
179179
Before moving to a chart version that changes the `NodeReadinessRule` schema, apply the CRD yourself:
180180

181181
```sh
182-
kubectl apply -f charts/nrr-controller/crds/nodereadinessrules.readiness.node.x-k8s.io.yaml
182+
kubectl apply -f charts/node-readiness-controller/crds/nodereadinessrules.readiness.node.x-k8s.io.yaml
183183
```
184184

185185
Skipping this leaves the old schema in place, and rules using newly added fields are rejected by the API server even though the controller supports them.
@@ -230,13 +230,13 @@ After installation, verify that the controller is running successfully.
230230

231231
1. **Check Pod Status**:
232232
```sh
233-
kubectl get pods -n ${NAMESPACE} -l component=node-readiness-controller
233+
kubectl get pods -n ${NAMESPACE} -l control-plane=controller-manager
234234
```
235235
You should see the controller pods in `Running` status.
236236

237237
2. **Check Logs**:
238238
```sh
239-
kubectl logs -n ${NAMESPACE} -l component=node-readiness-controller
239+
kubectl logs -n ${NAMESPACE} -l control-plane=controller-manager
240240
```
241241
Look for "Starting EventSource" or "Starting Controller" messages indicating the manager is active.
242242

@@ -280,7 +280,7 @@ The controller uses a **finalizer** (`readiness.node.x-k8s.io/cleanup-taints`) o
280280
kubectl delete -k config/default
281281
282282
# OR if using Helm
283-
helm uninstall nrr-controller --namespace nrr-system
283+
helm uninstall node-readiness-controller --namespace nrr-system
284284
285285
# OR if using Static Pods
286286
# Remove the manifest from /etc/kubernetes/manifests/ on all control-plane nodes

0 commit comments

Comments
 (0)