Skip to content

Commit a9c25fc

Browse files
committed
fix readme about evict-to-rollout annotation
1 parent d430f7d commit a9c25fc

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ helm upgrade --install evict-to-rollout \
6767
--version 0.1.0 \
6868
--namespace kube-system --create-namespace \
6969
--set schedule="*/2 * * * *" \
70-
--set annotationSelector.key="evict-with-rollout" \
70+
--set annotationSelector.key="evict-to-rollout" \
7171
--set annotationSelector.value="true"
7272
```
7373

@@ -76,7 +76,7 @@ Key values:
7676
| Value | Description | Default |
7777
| --- | --- | --- |
7878
| `schedule` | Cron expression for how often to scan nodes | `*/1 * * * *` |
79-
| `annotationSelector.key`/`.value` | Annotation pair that marks pods for rollout | `evict-with-rollout` / `true` |
79+
| `annotationSelector.key`/`.value` | Annotation pair that marks pods for rollout | `evict-to-rollout` / `true` |
8080
| `image.repository` / `.tag` | Container image that provides `kubectl` + `jq` | `ghcr.io/hivemindtechnologies/evict-to-rollout/kubectl-jq` / *(empty = use chart `appVersion`)* |
8181
| `serviceAccount.create` | Whether to create a dedicated SA | `true` |
8282
| `rbac.create` | Whether to install ClusterRole + binding | `true` |
@@ -126,7 +126,7 @@ For local testing the kind script (`devbox run test`) builds the image and loads
126126
- **Node termination grace vs schedule**: The CronJob only reacts on its schedule (default 1 minute). Ensure your node termination grace period (e.g., Karpenter’s default 2 minutes) comfortably exceeds `schedule interval + controller runtime`, otherwise the node may terminate before the rollout finishes.
127127
- **Rolling update strategy required**: Deployments must use the standard rolling update strategy so that a new pod starts before the old pod is deleted. StatefulSets or Deployments using `Recreate` will still experience downtime.
128128
- **Single replica + PDB**: Remember to pair single-replica workloads with a `PodDisruptionBudget` (`minAvailable: 1` / `maxUnavailable: 0`). Without it, Kubernetes can evict the pod immediately even if the controller is running.
129-
- **Annotation opt-in**: Only pods whose template contains the configured annotation (default `evict-with-rollout: "true"`) are handled. Forgetting the annotation means eviction proceeds as usual.
129+
- **Annotation opt-in**: Only pods whose template contains the configured annotation (default `evict-to-rollout: "true"`) are handled. Forgetting the annotation means eviction proceeds as usual.
130130
- **RBAC scope**: The included ClusterRole grants read access to nodes/pods and patch access to deployments. Tighten or namespace-scope it if your environment requires stricter permissions.
131131

132132
Missing something? [Open an issue](https://github.com/HivemindTechnologies/evict-to-rollout/issues/new) with details so we can cover your use-case.

0 commit comments

Comments
 (0)