From 69dfdcf9fa35935a6644d30e6b3596a96183dc93 Mon Sep 17 00:00:00 2001 From: Janelle Neczypor Date: Tue, 14 Jan 2025 11:48:27 -0800 Subject: [PATCH] OSDOCS-12561 --- _topic_maps/_topic_map_rosa.yml | 1 - _topic_maps/_topic_map_rosa_hcp.yml | 42 +++++++++++++++++++ modules/web-console-overview.adoc | 8 ++-- .../creating-quick-start-tutorials.adoc | 4 +- .../dynamic-plugin/deploy-plugin-cluster.adoc | 8 ++-- .../dynamic-plugins-reference.adoc | 4 +- web_console/web-console-overview.adoc | 16 +++---- web_console/web-console.adoc | 4 +- 8 files changed, 62 insertions(+), 25 deletions(-) diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index c7daf60cab..6c94b98ef3 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -439,7 +439,6 @@ Topics: File: using-dashboard-to-get-cluster-information - Name: Adding user preferences File: adding-user-preferences - Distros: openshift-enterprise,openshift-origin # cannot patch resource "consoles", insufficient permissions to read any Cluster configuration #- Name: Configuring the web console # File: configuring-web-console diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index a681baab4a..74859cb319 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -214,6 +214,48 @@ Topics: - Name: Creating ROSA with HCP clusters with external authentication File: rosa-hcp-sts-creating-a-cluster-ext-auth --- +Name: Web console +Dir: web_console +Distros: openshift-rosa-hcp +Topics: +- Name: Web console overview + File: web-console-overview +- Name: Accessing the web console + File: web-console +- Name: Viewing cluster information + File: using-dashboard-to-get-cluster-information +- Name: Adding user preferences + File: adding-user-preferences +- Name: Dynamic plugins + Dir: dynamic-plugin + Distros: openshift-rosa-hcp + Topics: + - Name: Overview of dynamic plugins + File: overview-dynamic-plugin + - Name: Getting started with dynamic plugins + File: dynamic-plugins-get-started + - Name: Deploy your plugin on a cluster + File: deploy-plugin-cluster + - Name: Dynamic plugin example + File: dynamic-plugin-example + - Name: Dynamic plugin reference + File: dynamic-plugins-reference +- Name: Web terminal + Dir: web_terminal + Distros: openshift-rosa-hcp + Topics: + - Name: Installing the web terminal + File: installing-web-terminal + - Name: Using the web terminal + File: odc-using-web-terminal + - Name: Troubleshooting the web terminal + File: troubleshooting-web-terminal + - Name: Uninstalling the web terminal + File: uninstalling-web-terminal +- Name: About quick start tutorials + File: creating-quick-start-tutorials + Distros: openshift-rosa-hcp +--- Name: Red Hat OpenShift Cluster Manager Dir: ocm Distros: openshift-rosa-hcp diff --git a/modules/web-console-overview.adoc b/modules/web-console-overview.adoc index 1fce87494a..afd1c74d48 100644 --- a/modules/web-console-overview.adoc +++ b/modules/web-console-overview.adoc @@ -7,7 +7,7 @@ The web console runs as a pod on the control plane node. The static assets required to run the web console are served by the pod. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] After you install {product-title} using the `openshift-install create cluster` command, you can find the web console URL and login credentials for the installed cluster in the CLI output of the installation program. For example: [source,terminal] @@ -28,9 +28,9 @@ For existing clusters that you did not install, you can use `oc whoami --show-co ==== The `dir` parameter specifies the `assets` directory, which stores the manifest files, the ISO image, and the `auth` directory. The `auth` directory stores the `kubeadmin-password` and `kubeconfig` files. As a `kubeadmin` user, you can use the `kubeconfig` file to access the cluster with the following setting: `export KUBECONFIG=/auth/kubeconfig`. The `kubeconfig` is specific to the generated ISO image, so if the `kubeconfig` is set and the `oc` command fails, it is possible that the system did not boot with the generated ISO image. To perform debugging, during the bootstrap process, you can log in to the console as the `core` user by using the contents of the `kubeadmin-password` file. ==== -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] .Procedure @@ -39,4 +39,4 @@ ifdef::openshift-rosa,openshift-dedicated[] . On the cluster *Overview* tab, click *Open console*, and log in with your credentials. Alternatively, use the `oc whoami --show-console` command to get the web console URL. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] diff --git a/web_console/creating-quick-start-tutorials.adoc b/web_console/creating-quick-start-tutorials.adoc index d5fb364ff7..bb652776b7 100644 --- a/web_console/creating-quick-start-tutorials.adoc +++ b/web_console/creating-quick-start-tutorials.adoc @@ -47,6 +47,6 @@ include::modules/quick-start-content-guidelines.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* For voice and tone requirements, refer to link:https://www.patternfly.org/v4/ux-writing/brand-voice-and-tone[PatternFly's brand voice and tone guidelines]. -* For other UX content guidance, refer to all areas of link:https://www.patternfly.org/v4/ux-writing/about[PatternFly's UX writing style guide]. +* For voice and tone requirements, refer to link:https://www.patternfly.org/ux-writing/brand-voice-and-tone[PatternFly's brand voice and tone guidelines]. +* For other UX content guidance, refer to all areas of link:https://www.patternfly.org/ux-writing/about[PatternFly's UX writing style guide]. endif::openshift-rosa,openshift-dedicated[] diff --git a/web_console/dynamic-plugin/deploy-plugin-cluster.adoc b/web_console/dynamic-plugin/deploy-plugin-cluster.adoc index ba3c063921..bac600e462 100644 --- a/web_console/dynamic-plugin/deploy-plugin-cluster.adoc +++ b/web_console/dynamic-plugin/deploy-plugin-cluster.adoc @@ -14,21 +14,21 @@ include::modules/deployment-plug-in-cluster.adoc[leveloffset=+1] include::modules/dynamic-plugin-proxy-service.adoc[leveloffset=+1] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../security/certificate_types_descriptions/service-ca-certificates.adoc#service-ca-certificates[Service CA certificates] * xref:../../security/certificates/service-serving-certificate.adoc#service-serving-certificate[Securing service traffic using service serving certificate secrets] * xref:../../web_console/dynamic-plugin/dynamic-plugins-reference.adoc#dynamic-plugin-api_dynamic-plugins-reference[Dynamic plugin API] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] include::modules/disabling-plug-in-browser.adoc[leveloffset=+1] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [role="_additional-resources"] [id="dynamic-plugins_additional-resources"] == Additional resources * xref:../../applications/working_with_helm_charts/understanding-helm.adoc#understaning-helm[Understanding Helm] -endif::openshift-rosa,openshift-dedicated[] \ No newline at end of file +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] \ No newline at end of file diff --git a/web_console/dynamic-plugin/dynamic-plugins-reference.adoc b/web_console/dynamic-plugin/dynamic-plugins-reference.adoc index cb787ad51e..236e428997 100644 --- a/web_console/dynamic-plugin/dynamic-plugins-reference.adoc +++ b/web_console/dynamic-plugin/dynamic-plugins-reference.adoc @@ -14,8 +14,8 @@ include::modules/dynamic-plugin-api.adoc[leveloffset=+1] include::modules/troubleshooting-dynamic-plugin.adoc[leveloffset=+1] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates] -endif::openshift-rosa,openshift-dedicated[] \ No newline at end of file +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] \ No newline at end of file diff --git a/web_console/web-console-overview.adoc b/web_console/web-console-overview.adoc index 85e55e14cd..4689ca092e 100644 --- a/web_console/web-console-overview.adoc +++ b/web_console/web-console-overview.adoc @@ -17,24 +17,20 @@ include::modules/odc-accessing-perspectives.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * xref:../welcome/learn_more_about_openshift.adoc#cluster-administrator[Learn more about Cluster Administrator] * xref:../getting_started/openshift-overview.adoc#for-administrators[Overview of the *Administrator* perspective] * xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective] * xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * xref:../web_console/using-dashboard-to-get-cluster-information.adoc#using-dashboard-to-get-cluster-info[Viewing cluster information] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * xref:../web_console/configuring-web-console.adoc#configuring-web-console[Configuring the web console] -endif::openshift-rosa,openshift-dedicated[] -ifndef::openshift-rosa,openshift-dedicated[] * xref:../web_console/customizing-the-web-console.adoc#customizing-web-console[Customizing the web console] -endif::openshift-rosa,openshift-dedicated[] -ifndef::openshift-rosa,openshift-dedicated[] * xref:../web_console/customizing-the-web-console.adoc#customizing-web-console[About the web console] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * xref:../web_console/web_terminal/odc-using-web-terminal.adoc#odc-using-web-terminal[Using the web terminal] * xref:../web_console/creating-quick-start-tutorials.adoc#creating-quick-start-tutorials[Creating quick start tutorials] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * xref:../web_console/disabling-web-console.adoc#disabling-web-console[Disabling the web console] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] diff --git a/web_console/web-console.adoc b/web_console/web-console.adoc index 61fe552156..8704a20fa6 100644 --- a/web_console/web-console.adoc +++ b/web_console/web-console.adoc @@ -24,8 +24,8 @@ include::modules/web-console-overview.adoc[leveloffset=+1] // include::modules/multi-cluster-about.adoc[leveloffset=+1] //include::modules/enabling-multi-cluster-console.adoc[leveloffset=+2] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources * xref:../nodes/clusters/nodes-cluster-enabling-features.adoc[Enabling feature sets using the web console] -endif::openshift-rosa,openshift-dedicated[] \ No newline at end of file +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] \ No newline at end of file