Skip to content

Commit 6a87bb5

Browse files
committed
update taint key naming instructions
1 parent 14781eb commit 6a87bb5

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

docs/book/src/user-guide/getting-started.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,24 @@ Use unique, descriptive taint keys for different readiness checks.
144144

145145
#### Taint Key Naming
146146

147-
Follow [Kubernetes naming conventions](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/):
147+
Follow [Kubernetes naming conventions](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/).
148148

149-
* Use DNS-style prefixes: `readiness.k8s.io/`, `example.com/`
150-
* Be descriptive: `readiness.k8s.io/cni-ready` vs. `rdy`
151-
* Use alphanumeric, `-`, `.`, `/`, `_`
149+
Taint keys must have the `readiness.k8s.io/` prefix to clearly identify readiness-related taints and avoid conflicts with other controllers
150+
151+
**Valid:**
152+
```yaml
153+
taint:
154+
key: "readiness.k8s.io/NetworkReady"
155+
key: "readiness.k8s.io/StorageReady"
156+
```
157+
158+
**Invalid:**
159+
```yaml
160+
taint:
161+
key: "network-ready" # Missing prefix
162+
key: "node.kubernetes.io/ready" # Wrong prefix
163+
```
152164

153-
<!-- TODO: Update this section once PR #112 is merged to document the readiness.k8s.io/ prefix restriction -->
154165

155166
## Configuration
156167

0 commit comments

Comments
 (0)