Merge pull request #88428 from AedinC/OSDOCS-13073

EricPonvelle · web-flow · commit 19d221652195 · 2025-02-27T09:28:20.000-05:00
OSDOCS-13073:Added new HCP installation troubleshooting section.
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -383,6 +383,8 @@ Topics:
 #    File: troubleshooting-installations
   - Name: Troubleshooting ROSA installations
     File: rosa-troubleshooting-installations
+  - Name: Troubleshooting ROSA with HCP installations
+    File: rosa-troubleshooting-installations-hcp
   - Name: Troubleshooting networking
     File: rosa-troubleshooting-networking
   - Name: Verifying node health
diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml
@@ -316,6 +316,8 @@ Topics:
 #    File: troubleshooting-installations
   - Name: Troubleshooting ROSA installations
     File: rosa-troubleshooting-installations
+  - Name: Troubleshooting ROSA with HCP installations
+    File: rosa-troubleshooting-installations-hcp
   - Name: Troubleshooting networking
     File: rosa-troubleshooting-networking
   - Name: Verifying node health
diff --git a/modules/rosa-hcp-no-console-access.adoc b/modules/rosa-hcp-no-console-access.adoc
@@ -0,0 +1,13 @@
+// Module included in the following assemblies:
+//
+// * support/rosa-troubleshooting-installations-hcp .adoc
+:_mod-docs-content-type: PROCEDURE
+[id="rosa-hcp-no-console-access_{context}"]
+= Troubleshooting access to {hybrid-console}
+
+In {hcp-title} clusters, the {product-title} OAuth server is hosted in the Red Hat service's AWS account while the web console service is published using the cluster's default ingress controller in the cluster's AWS account. If you can log in to your cluster using the OpenShift CLI (oc) but cannot access the {product-title} web console, verify the following criteria are met:
+
+* The console workloads are running.
+* The default ingress controller's load balancer is active.
+* You are accessing the console from a machine that has network connectivity to the cluster's VPC network.
+
diff --git a/modules/rosa-hcp-private-ready-no-console-access.adoc b/modules/rosa-hcp-private-ready-no-console-access.adoc
@@ -0,0 +1,12 @@
+// Module included in the following assemblies:
+//
+// * support/rosa-troubleshooting-installations-hcp .adoc
+:_mod-docs-content-type: PROCEDURE
+[id="rosa-hcp-private-ready-no-console-access_{context}"]
+= Verifying access to {hybrid-console} for private {hcp-title} clusters
+
+The console of the private cluster is private by default. During cluster installation, the default Ingress Controller managed by OpenShift's Ingress Operator is configured with an internal AWS Network Load Balancer (NLB).
+
+If your private {hcp-title} cluster shows a `ready` status but you cannot access the {product-title} web console for the cluster, try accessing the cluster console from either within the cluster VPC or from a network that is connected to the VPC.
+
+
diff --git a/modules/rosa-hcp-ready-no-console-access.adoc b/modules/rosa-hcp-ready-no-console-access.adoc
@@ -0,0 +1,12 @@
+// Module included in the following assemblies:
+//
+// * support/rosa-troubleshooting-installations-hcp .adoc
+:_mod-docs-content-type: PROCEDURE
+[id="rosa-hcp-ready-no-console-access_{context}"]
+= Verifying access to {product-title} web console for {hcp-title} cluster in ready state
+
+{hcp-title} clusters return a `ready` status when the control plane hosted in the {product-title} service account becomes ready. Cluster console workloads are deployed on the cluster's worker nodes. The {product-title} web console will not be available and accessible until the worker nodes have joined the cluster and console workloads are running.
+
+If your {hcp-title} cluster is ready but you are unable to access the {product-title} web console for the cluster, wait for the worker nodes to join the cluster and retry accessing the console.
+
+You can either log in to the {hcp-title} cluster or use the `rosa describe machinepool` command in the `rosa` CLI watch the nodes.
diff --git a/modules/rosa-verify-hcp-install.adoc b/modules/rosa-verify-hcp-install.adoc
@@ -0,0 +1,8 @@
+// Module included in the following assemblies:
+//
+// * support/rosa-troubleshooting-installations-hcp .adoc
+:_mod-docs-content-type: PROCEDURE
+[id="rosa-verify-hcp-install_{context}"]
+= Verifying installation of {hcp-title} clusters
+
+If the {hcp-title} cluster is in the installing state for over 30 minutes and has not become ready, ensure the AWS account environment is prepared for the required cluster configurations. If the AWS account environment is prepared for the required cluster configurations correctly, try to delete and recreate the cluster. If the problem persists, contact support.
diff --git a/rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc b/rosa_hcp/rosa-hcp-aws-private-creating-cluster.adoc
@@ -30,5 +30,5 @@ xref:../rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.a
 * xref:../rosa_getting_started/rosa-sts-getting-started-workflow.adoc#rosa-sts-overview-of-the-deployment-workflow[Overview of the ROSA with STS deployment workflow]
 * xref:../rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc#rosa-sts-deleting-cluster[Deleting a ROSA cluster]
 * xref:../architecture/rosa-architecture-models.adoc#rosa-architecture-models[ROSA architecture models]
-* xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installing[Troubleshooting Red{nbsp}Hat OpenShift Service on AWS installations]
+* xref:../support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc#rosa-troubleshooting-installations-hcp[Troubleshooting ROSA with HCP cluster installations]
 endif::openshift-rosa-hcp[]
diff --git a/rosa_hcp/rosa-hcp-creating-cluster-with-aws-kms-key.adoc b/rosa_hcp/rosa-hcp-creating-cluster-with-aws-kms-key.adoc
@@ -81,6 +81,6 @@ ifndef::openshift-rosa-hcp[]
 * For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
 * For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes].
 * For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers].
-* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations].
+* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc#rosa-troubleshooting-installations-hcp[Troubleshooting ROSA with HCP cluster installations].
 * For steps to contact Red{nbsp}Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS].
 endif::openshift-rosa-hcp[]
diff --git a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc
@@ -83,5 +83,5 @@ include::modules/rosa-hcp-sts-creating-a-cluster-external-auth-provider-delete-c
 * For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
 * For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes].
 * For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers] in the AWS documentation.
-* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations].
+* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc#rosa-troubleshooting-installations-hcp[Troubleshooting ROSA with HCP cluster installations].
 * For steps to contact Red{nbsp}Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS].
diff --git a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc
@@ -137,6 +137,6 @@ ifndef::openshift-rosa-hcp[]
 * For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
 * For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes].
 * For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers] in the AWS documentation.
-* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations].
+* For more information about troubleshooting {hcp-title} cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc#rosa-troubleshooting-installations-hcp[Troubleshooting ROSA with HCP installations].
 * For steps to contact Red{nbsp}Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red{nbsp}Hat OpenShift Service on AWS].
 endif::openshift-rosa-hcp[]
diff --git a/support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc b/support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc
@@ -0,0 +1,42 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/attributes-openshift-dedicated.adoc[]
+[id="rosa-troubleshooting-installations-hcp"]
+= Troubleshooting ROSA with HCP cluster installations
+:context: rosa-troubleshooting-installations-hcp
+//Remove this adoc from rosa-classic docs and add xrefs back in once HCP migration occurs.
+toc::[]
+
+For help with the installation of {hcp-title} clusters, refer to the following sections.
+
+include::modules/rosa-verify-hcp-install.adoc[leveloffset=+1]
+
+ifndef::openshift-rosa-hcp[]
+[role="_additional-resources"]
+.Additional resources
+* For information about the prerequisites to installing {hcp-title} clusters, see xref:../../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS].
+endif::openshift-rosa-hcp[]
+
+include::modules/rosa-hcp-no-console-access.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+ifndef::openshift-rosa-hcp[]
+* For more information about the {product-title} OAuth server, see xref:../../authentication/understanding-authentication.adoc#oauth-server-overview[ROSA OAuth server].
+* For more information about the {product-title} ingress operator, xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller].
+endif::openshift-rosa-hcp[]
+* For more information about the web console, see xref:../../web_console/web-console-overview.adoc#web-console-overview[Web Console Overview].
+
+include::modules/rosa-hcp-ready-no-console-access.adoc[leveloffset=+1]
+
+ifndef::openshift-rosa-hcp[]
+[role="_additional-resources"]
+.Additional resources
+* For more information about the `rosa describe machinepool` command, see xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-objects[List and describe objects].
+endif::openshift-rosa-hcp[]
+
+include::modules/rosa-hcp-private-ready-no-console-access.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* For more information about connecting the cluster VPC to other networks, see https://docs.aws.amazon.com/vpc/latest/userguide/extend-intro.html[AWS VPC Documentation].
+
