Skip to content

Commit 90a1293

Browse files
committed
[OSDOCS-7925]: Add Technology Preview boilerplate to debug nodes topic
1 parent 848b96b commit 90a1293

File tree

6 files changed

+23
-21
lines changed

6 files changed

+23
-21
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2228,8 +2228,8 @@ Topics:
22282228
File: hcp-managing
22292229
- Name: Backup, restore, and disaster recovery for hosted control planes
22302230
File: hcp-backup-restore-dr
2231-
- Name: Troubleshooting worker node issues
2232-
File: hcp-debugging-nodes
2231+
- Name: Troubleshooting hosted control planes
2232+
File: hcp-troubleshooting
22332233
---
22342234
Name: Nodes
22352235
Dir: nodes

hosted_control_planes/hcp-debugging-nodes.adoc

Lines changed: 0 additions & 11 deletions
This file was deleted.

hosted_control_planes/hcp-managing.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ include::modules/updates-for-hosted-control-planes.adoc[leveloffset=+1]
1515
include::modules/updating-node-pools-for-hcp.adoc[leveloffset=+1]
1616
//restarting hosted control plane components
1717
include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1]
18-
//debugging why nodes have not joined the cluster
1918
//using service-level DNS for control plane services
2019
include::modules/hosted-control-planes-metrics-sets.adoc[leveloffset=+1]
2120
//automated machine management
22-
include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
2321
include::modules/delete-hosted-cluster.adoc[leveloffset=+1]
2422

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:_content-type: ASSEMBLY
2+
[id="hcp-troubleshooting"]
3+
= Troubleshooting hosted control planes
4+
include::_attributes/common-attributes.adoc[]
5+
:context: hcp-troubleshooting
6+
7+
toc::[]
8+
9+
If you encounter issues with hosted control planes, see the following information to guide you through troubleshooting.
10+
11+
include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
12+
include::modules/debug-nodes-hcp.adoc[leveloffset=+1]

modules/debug-nodes-hcp.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
// Module included in the following assemblies:
22
//
3-
// * hosted_control_planes/hcp-debugging-nodes.adoc
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
44

55
:_content-type: PROCEDURE
66
[id="debug-nodes-hcp_{context}"]
77
= Checking why worker nodes did not join the hosted cluster
88

9-
To troubleshoot why worker nodes did not join the hosted cluster on AWS, you can check the following information.
9+
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.
1010

11-
.Prerequisites
11+
:FeatureName: Hosted control planes on AWS
12+
include::snippets/technology-preview.adoc[]
1213

14+
.Prerequisites
15+
//lahinson - sept. 2023 - after ACM 2.9 is GA on 13 Nov., update this link to point to 2.9
1316
* 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].
1417
* Your control plane API endpoint is available.
1518
@@ -103,4 +106,4 @@ $ SSH_PRIVATE_KEY=/tmp/ssh/id_rsa
103106
$ ./test/e2e/util/dump/copy-machine-journals.sh /tmp/journals
104107
----
105108
+
106-
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.
109+
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/hosted-control-planes-troubleshooting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * hosted_control_planes/hcp-managing.adoc
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
44

55
:_content-type: PROCEDURE
66
[id="hosted-control-planes-troubleshooting_{context}"]
7-
= Troubleshooting hosted control planes
7+
= Gathering information to troubleshoot hosted control planes
88

99
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.
1010

0 commit comments

Comments
 (0)