Skip to content

Commit c5c51a3

Browse files
authored
Merge pull request #23 from sreeram-venkitesh/docs-and-readme-updates
Updated node type in testing doc, updated readme
2 parents 90ea16b + c01f32c commit c5c51a3

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ spec:
6060
node-role.kubernetes.io/worker: ""
6161
```
6262
63+
Find a more detailed walkthrough of setting up Node Readiness Controller in your Kind cluster [here](https://github.com/kubernetes-sigs/node-readiness-controller/blob/main/docs/TEST_README.md).
64+
6365
## High-level Roadmap
6466
6567
- [ ] Add documentation capturing design details

docs/TEST_README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The test demonstrates a realistic, production-aligned scenario where critical ad
77
### Test Topology
88

99
The test uses a 3-node Kind cluster:
10-
1. **`nrr-test-control-plane`**: The Kubernetes control plane.
11-
2. **`nrr-test-worker` (Platform Node)**: A dedicated node for running cluster-critical addons. It is labeled `reserved-for=platform` and has a corresponding taint to repel normal application workloads. Cert-manager and the NRR controller will run here.
10+
1. **`nrr-test-control-plane`**: The Kubernetes control plane. The NRR controller will run here unless specifically configured.
11+
2. **`nrr-test-worker` (Platform Node)**: A dedicated node for running cluster-critical addons. It is labeled `reserved-for=platform` and has a corresponding taint to repel normal application workloads. Cert-manager will run here.
1212
3. **`nrr-test-worker2` (Application Node)**: A standard worker node that starts with a `readiness.k8s.io/NetworkReady=pending:NoSchedule` taint, simulating a node that is not yet ready for application traffic.
1313

1414
## Running the Test
@@ -53,7 +53,7 @@ Deploy the controller image to nrr-test-worker
5353
make deploy IMG_PREFIX=controller IMG_TAG=latest
5454
```
5555

56-
Verify the controller is running on the platform node (`nrr-test-worker`):
56+
Verify the controller is running on the control plane node (`nrr-test-control-plane`):
5757
```bash
5858
kubectl get pods -n nrr-system -o wide
5959
```

0 commit comments

Comments
 (0)