Merge pull request #66934 from mburke5678/rosa-web-console

[OSDOCS-8077] OCP content port to ROSA and OSD:Web Console

Author: mburke5678

_topic_maps/_topic_map_osd.yml

@@ -189,6 +189,62 @@ Topics:
     File: osd-managed-resources
     Distros: openshift-dedicated
 ---
+Name: Web console
+Dir: web_console
+Distros: openshift-dedicated
+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
+  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
+#  Distros: openshift-rosa
+- Name: Customizing the web console
+  File: customizing-the-web-console
+  Distros: openshift-dedicated
+- Name: Dynamic plugins
+  Dir: dynamic-plugin
+  Distros: openshift-dedicated
+  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-dedicated
+  Topics:
+  - Name: Installing the web terminal
+    File: installing-web-terminal
+# Do not have sufficient permissions to read any cluster configuration. 
+#  - Name: Configuring the web terminal
+#    File: configuring-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: Disabling the web console
+  File: disabling-web-console
+  Distros: openshift-dedicated
+- Name: About quick start tutorials
+  File: creating-quick-start-tutorials
+  Distros: openshift-dedicated
+---
 Name: CLI tools
 Dir: cli_reference
 Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

@@ -300,6 +300,62 @@ Topics:
     File: rosa-managed-resources
     Distros: openshift-rosa
 ---
+Name: Web console
+Dir: web_console
+Distros: openshift-rosa
+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
+  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
+#  Distros: openshift-rosa
+- Name: Customizing the web console
+  File: customizing-the-web-console
+  Distros: openshift-rosa
+- Name: Dynamic plugins
+  Dir: dynamic-plugin
+  Distros: openshift-rosa
+  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
+  Topics:
+  - Name: Installing the web terminal
+    File: installing-web-terminal
+# Do not have sufficient permissions to read any cluster configuration. 
+#  - Name: Configuring the web terminal
+#    File: configuring-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: Disabling the web console
+  File: disabling-web-console
+  Distros: openshift-rosa
+- Name: About quick start tutorials
+  File: creating-quick-start-tutorials
+  Distros: openshift-rosa
+---
 Name: CLI tools
 Dir: cli_reference
 Distros: openshift-rosa

modules/odc-access-web-terminal.adoc

@@ -24,7 +24,9 @@ The web terminal remains open until you close it or until you close the browser
 [NOTE]
 ====
 * The `DevWorkspace` CR is created only if it does not already exist.
+ifndef::openshift-rosa,openshift-dedicated[]
 * The `openshift-terminal` project is the default project used for cluster administrators. They do not have the option to choose another project.
+endif::openshift-rosa,openshift-dedicated[]
 ====
 
 . Click *Start* to initialize the web terminal using the selected project. After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx` in the web terminal.

modules/removing-devworkspace-operator.adoc

@@ -18,6 +18,10 @@ The {devworkspace-op} is a standalone Operator and may be required as a dependen
 * You have access to an {product-title} cluster with cluster administrator permissions.
 * You have installed the `oc` CLI.
 
+// Hide step 2, cannot delete resource "customresourcedefinitions" in ROSA/OSD
+// Hide step 4, cannot delete resource "mutatingwebhookconfigurations" in ROSA/OSD, do not delete deployment/devworkspace-webhook-server, see NOTE 
+
+
 .Procedure
 
 . Remove the `DevWorkspace` custom resources used by the Operator, along with any related Kubernetes objects:
@@ -37,6 +41,7 @@ $ oc delete devworkspaceroutings.controller.devfile.io --all-namespaces --all --
 If this step is not complete, finalizers make it difficult to fully uninstall the Operator.
 ====
 
+ifndef::openshift-rosa,openshift-dedicated[]
 . Remove the CRDs used by the Operator:
 +
 [WARNING]
@@ -92,6 +97,7 @@ $ oc delete validatingwebhookconfigurations controller.devfile.io
 ====
 If you remove the `devworkspace-webhook-server` deployment without removing the mutating and validating webhooks, you can not use `oc exec` commands to run commands in a container in the cluster. After you remove the webhooks you can use the `oc exec` commands again.
 ====
+endif::openshift-rosa,openshift-dedicated[]
 
 . Remove any remaining services, secrets, and config maps. Depending on the installation, some resources included in the following commands may not exist in the cluster.
 +

modules/web-console-overview.adoc

@@ -5,7 +5,10 @@
 [id="web-console-overview_{context}"]
 = Understanding and accessing the web console
 
-The web console runs as a pod on the master. The static assets required to run the web console are served by the pod. After {product-title} is successfully installed using `openshift-install create cluster`, find the URL for the web console and login credentials for your installed cluster in the CLI output of the installation program. For example:
+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[]
+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]
 .Example output
@@ -24,4 +27,16 @@ For existing clusters that you did not install, you can use `oc whoami --show-co
 [IMPORTANT]
 ====
 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=<install_directory>/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[]
+
+ifdef::openshift-rosa,openshift-dedicated[]
+
+.Procedure
+
+. Log in to {cluster-manager-url} and click the name of your cluster.
+
+. 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[]

web_console/configuring-web-console.adoc

@@ -13,5 +13,9 @@ or disable the console.
 
 * Deploy an {product-title} cluster.
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create "consoles" resource
+ifndef::openshift-rosa,openshift-dedicated[]
 include::modules/web-console-configuration.adoc[leveloffset=+1]
+// Hiding in ROSA/OSD, as dedicated-admins do not have sufficient permissions to read any cluster configuration
 include::modules/disable-quickstarts-admin-console.adoc[leveloffset=+1]
+endif::openshift-rosa,openshift-dedicated[]

web_console/creating-quick-start-tutorials.adoc

@@ -1,8 +1,17 @@
+ifndef::openshift-rosa,openshift-dedicated[]
 :_mod-docs-content-type: ASSEMBLY
 [id="creating-quick-start-tutorials"]
 = Creating quick start tutorials in the web console
 include::_attributes/common-attributes.adoc[]
 :context: creating-quick-start-tutorials
+endif::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+:_mod-docs-content-type: ASSEMBLY
+[id="creating-quick-start-tutorials"]
+= About quick start tutorials
+include::_attributes/common-attributes.adoc[]
+:context: creating-quick-start-tutorials
+endif::openshift-rosa,openshift-dedicated[]
 
 toc::[]
 
@@ -14,6 +23,8 @@ include::modules/quick-start-user-workflow.adoc[leveloffset=+1]
 
 include::modules/quick-start-components.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create "consolequickstarts" resource 
+ifndef::openshift-rosa,openshift-dedicated[]
 include::modules/contributing-quick-starts.adoc[leveloffset=+1]
 
 include::modules/understanding-quick-start-elements.adoc[leveloffset=+2]
@@ -38,3 +49,4 @@ include::modules/quick-start-content-guidelines.adoc[leveloffset=+1]
 
 * 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].
+endif::openshift-rosa,openshift-dedicated[]

web_console/customizing-the-web-console.adoc

@@ -13,9 +13,13 @@ corporate or government requirements.
 
 include::modules/adding-a-custom-logo.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consolelinks"
+ifndef::openshift-rosa,openshift-dedicated[]
 include::modules/creating-custom-links.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "ingresses"
 include::modules/customizing-the-web-console-URL.adoc[leveloffset=+1]
+endif::openshift-rosa,openshift-dedicated[]
 
 [id="customizing-web-console-recognize"]
 == Recognizing resource and project limits and quotas
@@ -26,26 +30,40 @@ If a resource has a message about resource limitations or quotas being reached,
 
 If using *List View* from the *View Shortcuts* menu, resources appear as a list. The *Alerts* column indicates if a message is available.
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create resource "secrets" in openshift-config
+ifndef::openshift-rosa,openshift-dedicated[]
 include::modules/customizing-the-login-page.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consoleexternalloglinks"
 include::modules/defining-template-for-external-log-link.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consolenotifications"
 include::modules/adding-custom-notification-banners.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "customresourcedefinitions"
 include::modules/customizing-cli-downloads.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "customresourcedefinitions" 
 include::modules/adding-yaml-examples-to-kube-resources.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consoles"
 include::modules/odc-customizing-user-perspectives.adoc[leveloffset=+1]
 
+// Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consoles"
 include::modules/odc-customizing-a-perspective-using-YAML-view.adoc[leveloffset=+2]
 
+// Hiding in ROSA/OSD, as dedicated-admins do not have sufficient permissions to read any cluster configuration
 include::modules/odc-customizing-a-perspective-using-form-view.adoc[leveloffset=+2]
+endif::openshift-rosa,openshift-dedicated[]
 
 include::modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc[leveloffset=+1]
 
 include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc[leveloffset=+2]
 
+// Hiding in ROSA/OSD, as dedicated-admins do not have sufficient permissions to read any cluster configuration
+ifndef::openshift-rosa,openshift-dedicated[]
 include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-form-view.adoc[leveloffset=+2]
 
-include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3]
+// Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "consoles" 
+include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3]
+endif::openshift-rosa,openshift-dedicated[]

web_console/dynamic-plugin/deploy-plugin-cluster.adoc

@@ -14,7 +14,9 @@ include::modules/deployment-plug-in-cluster.adoc[leveloffset=+1]
 
 include::modules/disabling-plug-in-browser.adoc[leveloffset=+1]
 
+ifndef::openshift-rosa,openshift-dedicated[]
 [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[]

web_console/dynamic-plugin/dynamic-plugins-reference.adoc

@@ -14,6 +14,8 @@ include::modules/dynamic-plugin-api.adoc[leveloffset=+1]
 
 include::modules/troubleshooting-dynamic-plugin.adoc[leveloffset=+1]
 
+ifndef::openshift-rosa,openshift-dedicated[]
 [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[]