Skip to content

Commit 432777d

Browse files
committed
Deployment Pause: update README
Add README for deployment pause feature, added in PR#958 #837
1 parent a9566fa commit 432777d

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,23 @@ metadata:
191191
1. You want a quick restart without changing the workload spec
192192
1. Your platform restricts metadata changes
193193

194-
### 5. ❗ Annotation Behavior Rules & Compatibility
194+
### 5. ⏸️ Deployment Pause
195+
196+
Batch multiple ConfigMap/Secret updates into a single rollout by pausing deployments temporarily.
197+
198+
```yaml
199+
metadata:
200+
annotations:
201+
deployment.reloader.stakater.com/pause-period: "30s"
202+
```
203+
204+
| Annotation | Description |
205+
|--------------------------------------------------|------------------------------------------------------------------|
206+
| `deployment.reloader.stakater.com/pause-period` | Duration to pause the deployment (e.g., "30s", "5m", "1h") |
207+
208+
When a ConfigMap/Secret changes, Reloader pauses the deployment and batches any subsequent updates during the pause period into a single rollout.
209+
210+
### 6. ❗ Annotation Behavior Rules & Compatibility
195211

196212
- `reloader.stakater.com/auto` and `reloader.stakater.com/search` **cannot be used together** — the `auto` annotation takes precedence.
197213
- If both `auto` and its typed versions (`secret.reloader.stakater.com/auto`, `configmap.reloader.stakater.com/auto`) are used, **only one needs to be true** to trigger a reload.
@@ -200,7 +216,7 @@ metadata:
200216
- All workloads are treated as if they have `auto: "true"` unless they explicitly set it to `"false"`.
201217
- Missing or unrecognized annotation values are treated as `"false"`.
202218
203-
### 6. 🔔 Alerting on Reload
219+
### 7. 🔔 Alerting on Reload
204220
205221
Reloader can optionally **send alerts** whenever it triggers a rolling upgrade for a workload (e.g., `Deployment`, `StatefulSet`, etc.).
206222

0 commit comments

Comments
 (0)