Skip to content

Commit 3268015

Browse files
authored
Merge pull request #91355 from lahinson/osdocs-13848-hcp-day-2-must-gather
[OSDOCS-13848]: Add must-gather docs for day 2 HCP
2 parents a1773d5 + 7a5358c commit 3268015

File tree

3 files changed

+87
-11
lines changed

3 files changed

+87
-11
lines changed

Diff for: hosted_control_planes/hcp-troubleshooting.adoc

+9-11
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,20 @@ include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
1212

1313
[role="_additional-resources"]
1414
.Additional resources
15-
1615
* xref:../hosted_control_planes/hcp-prepare/hcp-cli.adoc[Installing the {hcp} command-line interface]
1716
17+
[id="hcp-must-gather-day-2"]
18+
== Gathering {product-title} data for a hosted cluster
19+
20+
You can gather {product-title} debugging information for a hosted cluster by using the {mce-short} web console or by using the CLI.
21+
22+
include::modules/hcp-must-gather-cli.adoc[leveloffset=+2]
23+
include::modules/hcp-must-gather-console.adoc[leveloffset=+2]
24+
1825
include::modules/hcp-must-gather-dc.adoc[leveloffset=+1]
1926

2027
[role="_additional-resources"]
2128
.Additional resources
22-
2329
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#install-on-disconnected-networks[Install on disconnected networks]
2430

2531
[id="hcp-ts-ocp-virt"]
@@ -32,7 +38,6 @@ include::modules/hcp-ts-no-nodes-reg.adoc[leveloffset=+2]
3238

3339
[role="_additional-resources"]
3440
.Additional resources
35-
3641
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#identifying-vm-console-logs[Identifying the problem: Access the VM console logs]
3742

3843
include::modules/hcp-ts-nodes-stuck.adoc[leveloffset=+2]
@@ -45,7 +50,6 @@ include::modules/hcp-ts-non-bm.adoc[leveloffset=+2]
4550

4651
[role="_additional-resources"]
4752
.Additional resources
48-
4953
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#remove-managed-cluster[Removing a cluster from management]
5054

5155
[id="hcp-ts-bm"]
@@ -57,14 +61,8 @@ include::modules/hcp-ts-bm-nodes-not-added.adoc[leveloffset=+2]
5761

5862
[role="_additional-resources"]
5963
.Additional resources
60-
6164
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html-single/clusters/index#on-prem-creating-your-cluster-with-the-cli-pull-secret[Add the pull secret to the namespace]
6265

6366
include::modules/hosted-restart-hcp-components.adoc[leveloffset=+1]
6467
include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1]
65-
include::modules/scale-down-data-plane.adoc[leveloffset=+1]
66-
67-
[role="_additional-resources"]
68-
.Additional resources
69-
70-
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#trouble-hosted-cluster-backplane[Must-gather for a hosted cluster]
68+
include::modules/scale-down-data-plane.adoc[leveloffset=+1]

Diff for: modules/hcp-must-gather-cli.adoc

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-must-gather-cli_{context}"]
7+
= Gathering data for a hosted cluster by using the CLI
8+
9+
You can gather {product-title} debugging information for a hosted cluster by using the CLI.
10+
11+
.Prerequisites
12+
13+
* You must have `cluster-admin` access to the management cluster.
14+
15+
* You need the `name` value for the `HostedCluster` resource and the namespace where the CR is deployed.
16+
17+
* You must have the `hcp` command-line interface installed. For more information, see "Installing the {hcp} command-line interface".
18+
19+
* You must have the OpenShift CLI (`oc`) installed.
20+
21+
* You must ensure that the `kubeconfig` file is loaded and is pointing to the management cluster.
22+
23+
.Procedure
24+
25+
. Generate the `kubeconfig` file by entering the following command:
26+
+
27+
[source,terminal]
28+
----
29+
$ hcp create kubeconfig --namespace <hosted_cluster_namespace> \
30+
--name <hosted_cluster_name> > <hosted_cluster_name>.kubeconfig
31+
----
32+
33+
. After you save the `kubeconfig` file, you can access the hosted cluster by entering the following example command:
34+
+
35+
[source,terminal]
36+
----
37+
$ oc --kubeconfig <hosted_cluster_name>.kubeconfig get nodes
38+
----
39+
40+
. . Collect the must-gather information by entering the following command:
41+
+
42+
[source,terminal]
43+
----
44+
$ oc adm must-gather
45+
----

Diff for: modules/hcp-must-gather-console.adoc

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-must-gather-console_{context}"]
7+
= Gathering data for a hosted cluster by using the web console
8+
9+
You can gather {product-title} debugging information for a hosted cluster by using the {mce-short} web console.
10+
11+
.Prerequisites
12+
13+
* You must have `cluster-admin` access to the management cluster.
14+
15+
* You need the `name` value for the `HostedCluster` resource and the namespace where the CR is deployed.
16+
17+
* You must have the `hcp` command-line interface installed. For more information, see "Installing the {hcp} command-line interface".
18+
19+
* You must have the OpenShift CLI (`oc`) installed.
20+
21+
* You must ensure that the `kubeconfig` file is loaded and is pointing to the management cluster.
22+
23+
.Procedure
24+
25+
. In the web console, select *All Clusters* and select the cluster you want to troubleshoot.
26+
. In the upper-right corner, select *Download kubeconfig*.
27+
. Export the downloaded `kubeconfig` file.
28+
. Collect the must-gather information by entering the following command:
29+
+
30+
[source,terminal]
31+
----
32+
$ oc adm must-gather
33+
----

0 commit comments

Comments
 (0)