openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 06:46:26 +01:00
Code Issues Releases Activity

Adding docs about pausing reconciliation for hosted control planes

Browse Source
This commit is contained in:
Laura Hinson
2023-07-18 13:33:20 -04:00
committed by openshift-cherrypick-robot
parent aa017ad025
commit 116ae6558f
2 changed files with 48 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
hosted_control_planes/hcp-managing.adoc
View File

@@ -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

47
modules/hosted-control-planes-pause-reconciliation.adoc Normal file
View File

@@ -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 <hosted-cluster-namespace> hostedclusters/<hosted-cluster-name> -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 <hosted-cluster-namespace> hostedclusters/<hosted-cluster-name> -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 <hosted-cluster-namespace> hostedclusters/<hosted-cluster-name> -p '{"spec":{"pausedUntil":null}}' --type=merge
----