Merge pull request #56947 from lahinson/hcp-restore-cp-components-osdocs-5328

[OSDOCS-5328]: Adding procedure to restart hosted control plane components

Author: jldohmann

hosted_control_planes/hcp-troubleshooting.adoc

@@ -9,10 +9,8 @@ toc::[]
 If you encounter issues with {hcp}, see the following information to guide you through troubleshooting.
 
 include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
-
-//restarting hosted control plane components
+include::modules/hosted-restart-hcp-components.adoc[leveloffset=+1]
 include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1]
-
 include::modules/scale-down-data-plane.adoc[leveloffset=+1]
 
 [role="_additional-resources"]

modules/hosted-restart-hcp-components.adoc

@@ -0,0 +1,50 @@
+// Module included in the following assembly:
+//
+// * hosted_control_planes/index.adoc
+
+:_content-type: PROCEDURE
+[id="hosted-restart-hcp-components_{context}"]
+= Restarting hosted control plane components
+
+If you are an administrator for hosted control planes, you can use the `hypershift.openshift.io/restart-date` annotation to restart all control plane components for a particular `HostedCluster` resource. For example, you might need to restart control plane components for certificate rotation.
+
+.Procedure
+
+To restart a control plane, annotate the `HostedCluster` resource by entering the following command:
+
+[source,terminal]
+----
+$ oc annotate hostedcluster -n <hosted_cluster_namespace> <hosted_cluster_name> hypershift.openshift.io/restart-date=$(date --iso-8601=seconds)
+----
+
+.Verification
+
+The control plane is restarted whenever the value of the anonotation changes. The `date` command in the example serves as the source of a unique string. The annotation is treated as a string, not a timestamp.
+
+The following components are restarted:
+
+* catalog-operator
+* certified-operators-catalog
+* cluster-api
+* cluster-autoscaler
+* cluster-policy-controller
+* cluster-version-operator
+* community-operators-catalog
+* control-plane-operator
+* hosted-cluster-config-operator
+* ignition-server
+* ingress-operator
+* konnectivity-agent
+* konnectivity-server
+* kube-apiserver
+* kube-controller-manager
+* kube-scheduler
+* machine-approver
+* oauth-openshift
+* olm-operator
+* openshift-apiserver
+* openshift-controller-manager
+* openshift-oauth-apiserver
+* packageserver
+* redhat-marketplace-catalog
+* redhat-operators-catalog