Skip to content

Commit b6a3c7a

Browse files
Rename clusterOperation flag "reconcilePaused" to "reconciliationPaused" (#462)
1 parent 6c9b4c1 commit b6a3c7a

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

modules/concepts/examples/cluster-operations.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ metadata:
55
name: my-cluster
66
spec:
77
clusterOperation:
8-
reconcilePaused: false # <1>
8+
reconciliationPaused: false # <1>
99
stopped: false # <2>

modules/concepts/pages/operations/cluster_operations.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Stackable operators offer different cluster operations to control the reconciliation process. This is useful when updating operators, debugging or testing of new settings:
55

6-
* `reconcilePaused` - Stop the operator from reconciling the cluster spec. The status will still be updated.
6+
* `reconciliationPaused` - Stop the operator from reconciling the cluster spec. The status will still be updated.
77
* `stopped` - Stop all running pods but keep updating all deployed resources like `ConfigMaps`, `Services` and the cluster status.
88
99
== Example
@@ -12,11 +12,11 @@ Stackable operators offer different cluster operations to control the reconcilia
1212
----
1313
include::example$cluster-operations.yaml[]
1414
----
15-
<1> The `clusterOperation.reconcilePaused` flag set to `true` stops the operator from reconciling any changes to the cluster spec. The cluster status is still updated.
15+
<1> The `clusterOperation.reconciliationPaused` flag set to `true` stops the operator from reconciling any changes to the cluster spec. The cluster status is still updated.
1616
<2> The `clusterOperation.stopped` flag set to `true` stops all pods in the cluster. This is done by setting all deployed `StatefulSet` replicas to 0.
1717

1818
== Notes
1919

20-
If not specified, `clusterOperation.reconcilePaused` and `clusterOperation.stopped` default to `false`.
20+
If not specified, `clusterOperation.reconciliationPaused` and `clusterOperation.stopped` default to `false`.
2121

22-
IMPORTANT: When setting `clusterOperation.reconcilePaused` and `clusterOperation.stopped` to true in the same step, `clusterOperation.reconcilePaused` will take precedence. This means the cluster will stop reconciling immediately and the `stopped` field is ignored. To avoid this, the cluster should first be stopped and then paused.
22+
IMPORTANT: When setting `clusterOperation.reconciliationPaused` and `clusterOperation.stopped` to true in the same step, `clusterOperation.reconciliationPaused` will take precedence. This means the cluster will stop reconciling immediately and the `stopped` field is ignored. To avoid this, the cluster should first be stopped and then paused.

0 commit comments

Comments
 (0)