Skip to content

Commit cb45c81

Browse files
authored
docs(reconciliation): note on ContinueReconciliationOnManualRollingUpdateFailure (strimzi#10207)
Signed-off-by: prmellor <[email protected]>
1 parent 851199a commit cb45c81

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

documentation/modules/managing/proc-manual-rolling-update-pods.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,7 @@ kubectl annotate pod <cluster_name>-mirrormaker2-<index_number> strimzi.io/manua
7070
. Wait for the next reconciliation to occur (every two minutes by default).
7171
A rolling update of the annotated `Pod` is triggered, as long as the annotation was detected by the reconciliation process.
7272
When the rolling update of a pod is complete, the annotation is automatically removed from the `Pod`.
73+
74+
NOTE: If the `ContinueReconciliationOnManualRollingUpdateFailure` feature gate is enabled, reconciliation continues even if the manual rolling update of the cluster fails.
75+
This allows the Cluster Operator to recover from certain rectifiable situations that can be addressed later in the reconciliation.
76+
For example, it can recreate a missing Persistent Volume Claim (PVC) or Persistent Volume (PV) that caused the update to fail.

documentation/modules/operators/ref-operator-cluster-feature-gates.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,13 @@ It applies to the following operands that support manual rolling updates using t
134134
* Kafka Connect
135135
* Kafka MirrorMaker 2
136136

137-
Continuing the reconciliation after the manual rolling update failure allows the operator to recover from various situations that might prevent the manual rolling update from succeeding.
137+
Continuing the reconciliation after a manual rolling update failure allows the operator to recover from various situations that might prevent the update from succeeding.
138138
For example, a missing Persistent Volume Claim (PVC) or Persistent Volume (PV) might cause the manual rolling update to fail.
139-
But the PVCs and PVs are created only in a later stage of the reconciliation.
140-
Continuing the reconciliation after the failure would allow to recreate the missing PVC or PV and recover from the failure.
139+
However, the PVCs and PVs are created only in a later stage of the reconciliation.
140+
By continuing the reconciliation after this failure, the process can recreate the missing PVC or PV and recover.
141141

142-
The `ContinueReconciliationOnManualRollingUpdateFailure` feature gate is used by the Strimzi Cluster Operator.
143-
It will be ignored by the User and Topic Operators.
142+
The `ContinueReconciliationOnManualRollingUpdateFailure` feature gate is used by the Cluster Operator.
143+
It is ignored by the User and Topic Operators.
144144

145145
.Enabling the ContinueReconciliationOnManualRollingUpdateFailure feature gate
146146
To enable the `ContinueReconciliationOnManualRollingUpdateFailure` feature gate, specify `+ContinueReconciliationOnManualRollingUpdateFailure` in the `STRIMZI_FEATURE_GATES` environment variable in the Cluster Operator configuration.

0 commit comments

Comments
 (0)