Merge pull request #65263 from lahinson/osdocs-7925-add-tp-boilerplate-to-debug-nodes

/lgtm, merging

Author: JoeAldinger

_topic_maps/_topic_map.yml

@@ -2186,8 +2186,8 @@ Topics:
   File: hcp-managing
 - Name: Backup, restore, and disaster recovery for hosted control planes
   File: hcp-backup-restore-dr
-- Name: Troubleshooting worker node issues
-  File: hcp-debugging-nodes
+- Name: Troubleshooting hosted control planes
+  File: hcp-troubleshooting
 ---
 Name: Nodes
 Dir: nodes

hosted_control_planes/hcp-debugging-nodes.adoc

@@ -15,10 +15,8 @@ include::modules/updates-for-hosted-control-planes.adoc[leveloffset=+1]
 include::modules/updating-node-pools-for-hcp.adoc[leveloffset=+1]
 //restarting hosted control plane components
 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
 include::modules/hosted-control-planes-metrics-sets.adoc[leveloffset=+1]
 //automated machine management
-include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
 include::modules/delete-hosted-cluster.adoc[leveloffset=+1]
 

hosted_control_planes/hcp-managing.adoc

@@ -0,0 +1,12 @@
+:_content-type: ASSEMBLY
+[id="hcp-troubleshooting"]
+= Troubleshooting hosted control planes
+include::_attributes/common-attributes.adoc[]
+:context: hcp-troubleshooting
+
+toc::[]
+
+If you encounter issues with hosted control planes, see the following information to guide you through troubleshooting.
+
+include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
+include::modules/debug-nodes-hcp.adoc[leveloffset=+1]

hosted_control_planes/hcp-troubleshooting.adoc

@@ -1,15 +1,18 @@
 // Module included in the following assemblies:
 //
-// * hosted_control_planes/hcp-debugging-nodes.adoc
+// * hosted_control_planes/hcp-troubleshooting.adoc
 
 :_content-type: PROCEDURE
 [id="debug-nodes-hcp_{context}"]
 = Checking why worker nodes did not join the hosted cluster
 
-To troubleshoot why worker nodes did not join the hosted cluster on AWS, you can check the following information.
+If your control plane API endpoint is available, but worker nodes did not join the hosted cluster on AWS, you can debug worker node issues. To troubleshoot why worker nodes did not join the hosted cluster on AWS, you can check the following information.
 
-.Prerequisites
+:FeatureName: Hosted control planes on AWS
+include::snippets/technology-preview.adoc[]
 
+.Prerequisites
+//lahinson - sept. 2023 - after ACM 2.9 is GA on 13 Nov., update this link to point to 2.9
 * You have link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[configured the hosting cluster on AWS].
 * Your control plane API endpoint is available.
 
@@ -103,4 +106,4 @@ $ SSH_PRIVATE_KEY=/tmp/ssh/id_rsa
 $ ./test/e2e/util/dump/copy-machine-journals.sh /tmp/journals
 ----
 +
-You must place journal logs in the `/tmp/journals` directory in a compressed format. Check for the error that indicates why kubelet did not join the cluster.
+You must place journal logs in the `/tmp/journals` directory in a compressed format. Check for the error that indicates why kubelet did not join the cluster.

modules/debug-nodes-hcp.adoc

@@ -1,10 +1,10 @@
 // Module included in the following assemblies:
 //
-// * hosted_control_planes/hcp-managing.adoc
+// * hosted_control_planes/hcp-troubleshooting.adoc
 
 :_content-type: PROCEDURE
 [id="hosted-control-planes-troubleshooting_{context}"]
-= Troubleshooting hosted control planes
+= Gathering information to troubleshoot hosted control planes
 
 When you need to troubleshoot an issue with hosted control plane clusters, you can gather information by running the `hypershift dump cluster` command. The command generates output for the management cluster and the hosted cluster.