diff --git a/hosted_control_planes/hcp-managing.adoc b/hosted_control_planes/hcp-managing.adoc index 8b02751060..98f9d275c4 100644 --- a/hosted_control_planes/hcp-managing.adoc +++ b/hosted_control_planes/hcp-managing.adoc @@ -15,7 +15,7 @@ include::modules/updates-for-hosted-control-planes.adoc[leveloffset=+1] include::modules/updating-node-pools-for-hcp.adoc[leveloffset=+1] include::modules/configuring-node-pools-for-hcp.adoc[leveloffset=+1] //restarting hosted control plane components -//pausing reconciliation +include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1] //debugging why nodes have not joined the cluster //using service-level DNS for control plane services //configuring metrics sets diff --git a/modules/hosted-control-planes-pause-reconciliation.adoc b/modules/hosted-control-planes-pause-reconciliation.adoc new file mode 100644 index 0000000000..28ceab1f69 --- /dev/null +++ b/modules/hosted-control-planes-pause-reconciliation.adoc @@ -0,0 +1,47 @@ +// Module included in the following assemblies: +// +// * hosted_control_planes/hcp-managing.adoc + +:_content-type: PROCEDURE +[id="hosted-control-planes-pause-reconciliation_{context}"] += Pausing the reconciliation of a hosted cluster and hosted control plane + +If you are a cluster instance administrator, you can pause the reconciliation of a hosted cluster and hosted control plane. You might want to pause reconciliation when you back up and restore an etcd database or when you need to debug problems with a hosted cluster or hosted control plane. + +.Procedure + +. To pause reconciliation for a hosted cluster and hosted control plane, populate the `pausedUntil` field of the `HostedCluster` resource, as shown in the following examples: ++ +** To pause the reconciliation until a specific time, specify an RFC339 timestamp: ++ +[source,terminal] +---- +PAUSED_UNTIL="2022-03-03T03:28:48Z" +kubectl patch -n hostedclusters/ -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge +---- ++ +The reconciliation is paused until the specified time is passed. ++ +** To pause the reconciliation indefinitely, pass a Boolean value of `true`: ++ +[source,terminal] +---- +PAUSED_UNTIL="true" +kubectl patch -n hostedclusters/ -p '{"spec":{"pausedUntil":"'${PAUSED_UNTIL}'"}}' --type=merge +---- ++ +The reconciliation is paused until you remove the field from the `HostedCluster` resource. ++ +When the pause reconciliation field is populated for the `HostedCluster` resource, the field is automatically added to the associated `HostedControlPlane` resource. + +. To remove the `pausedUntil` field, enter the following patch command: ++ +[source,terminal] +---- +kubectl patch -n hostedclusters/ -p '{"spec":{"pausedUntil":null}}' --type=merge +---- + + + + +