From 414f151448cf03c92eb3c2f2d5c302d24869e05d Mon Sep 17 00:00:00 2001 From: Janelle Neczypor Date: Wed, 18 Jun 2025 15:12:42 -0700 Subject: [PATCH] OSDOCS-14988 --- _topic_maps/_topic_map_rosa_hcp.yml | 7 +- modules/about-administrator_web-console.adoc | 5 ++ modules/about-developer_web-console.adoc | 19 +++++- modules/adding-tab-pods-page.adoc | 12 +++- modules/deployment-plug-in-cluster.adoc | 8 +++ modules/dynamic-plug-in-development.adoc | 36 +++++++++- modules/dynamic-plugin-localization.adoc | 3 +- modules/dynamic-plugin-proxy-service.adoc | 12 +++- ...ing-developer-perspective_web-console.adoc | 6 +- modules/odc-access-web-terminal.adoc | 9 ++- ...-configure-web-terminal-image-session.adoc | 9 ++- ...onfigure-web-terminal-timeout-session.adoc | 9 ++- modules/optional-capabilities-operators.adoc | 8 +++ modules/removing-devworkspace-operator.adoc | 13 +++- modules/rhdh-install-web-console.adoc | 8 +++ modules/rhdh-web-console.adoc | 8 +++ modules/serverless-web-console.adoc | 12 +++- modules/troubleshooting-dynamic-plugin.adoc | 2 +- .../virt-about-the-overview-dashboard.adoc | 66 +++++++++++++++---- snippets/unified-perspective-web-console.adoc | 9 ++- web_console/adding-user-preferences.adoc | 1 + .../capabilities_products-web-console.adoc | 1 + web_console/configuring-web-console.adoc | 1 + .../creating-quick-start-tutorials.adoc | 8 ++- web_console/customizing-the-web-console.adoc | 1 + web_console/disabling-web-console.adoc | 13 +++- .../content-security-policy.adoc | 3 + .../dynamic-plugin/deploy-plugin-cluster.adoc | 10 ++- .../dynamic-plugin-example.adoc | 1 + .../dynamic-plugins-get-started.adoc | 1 + .../dynamic-plugins-reference.adoc | 1 + .../overview-dynamic-plugin.adoc | 10 +++ ...-dashboard-to-get-cluster-information.adoc | 22 ++++++- web_console/web-console-overview.adoc | 17 ++++- web_console/web-console.adoc | 1 + .../configuring-web-terminal.adoc | 1 + .../web_terminal/installing-web-terminal.adoc | 13 +++- .../web_terminal/odc-using-web-terminal.adoc | 1 + .../troubleshooting-web-terminal.adoc | 1 + .../uninstalling-web-terminal.adoc | 1 + 40 files changed, 327 insertions(+), 42 deletions(-) diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 741a89ed67..562ca1a990 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -208,7 +208,7 @@ Topics: File: web-console-overview - Name: Accessing the web console File: web-console -- Name: Viewing cluster information +- Name: Using the OpenShift Container Platform dashboard to get cluster information File: using-dashboard-to-get-cluster-information - Name: Adding user preferences File: adding-user-preferences @@ -222,6 +222,8 @@ Topics: File: dynamic-plugins-get-started - Name: Deploy your plugin on a cluster File: deploy-plugin-cluster + - Name: Content Security Policy + File: content-security-policy - Name: Dynamic plugin example File: dynamic-plugin-example - Name: Dynamic plugin reference @@ -241,6 +243,9 @@ Topics: - Name: About quick start tutorials File: creating-quick-start-tutorials Distros: openshift-rosa-hcp +- Name: Optional capabilities and products + File: capabilities_products-web-console + Distros: openshift-rosa-hcp --- Name: CLI tools Dir: cli_reference diff --git a/modules/about-administrator_web-console.adoc b/modules/about-administrator_web-console.adoc index e3f2fdb081..de5ff6ce86 100644 --- a/modules/about-administrator_web-console.adoc +++ b/modules/about-administrator_web-console.adoc @@ -8,7 +8,12 @@ The cluster administrator role enables you to view the cluster inventory, capacity, general and specific utilization information, and the stream of important events, all of which help you to simplify planning and troubleshooting tasks. Both project administrators and cluster administrators can use all features in the web console. +ifndef::openshift-rosa-hcp[] Cluster administrators can also open an embedded command-line terminal instance with the web terminal Operator in {product-title} 4.7 and later. +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +Cluster administrators can also open an embedded command-line terminal instance with the web terminal Operator. +endif::openshift-rosa-hcp[] The *Administrator* perspective provides workflows specific to administrator use cases, such as the ability to: diff --git a/modules/about-developer_web-console.adoc b/modules/about-developer_web-console.adoc index c7df0fc3ee..d7a378341b 100644 --- a/modules/about-developer_web-console.adoc +++ b/modules/about-developer_web-console.adoc @@ -13,15 +13,30 @@ The developer role in the web console offers several built-in ways to deploy app * Share your project with others. * Troubleshoot problems with your applications by running Prometheus Query Language (PromQL) queries on your project and examining the metrics visualized on a plot. The metrics provide information about the state of a cluster and any user-defined workloads that you are monitoring. +ifndef::openshift-rosa-hcp[] Cluster administrators can also open an embedded command-line terminal instance in the web console in {product-title} 4.7 and later. +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +Cluster developers can also open an embedded command-line terminal instance in the web console. +endif::openshift-rosa-hcp[] Developers have access to workflows specific to their use cases, such as the ability to: -* Create and deploy applications on {product-title} by importing existing codebases, images, and container files. +* Create and deploy applications on +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +by importing existing codebases, images, and container files. * Visually interact with applications, components, and services associated with them within a project and monitor their deployment and build status. * Group components within an application and connect the components within and across applications. * Integrate serverless capabilities (Technology Preview). -* Create workspaces to edit your application code using Eclipse Che. +* Create workspaces to edit their application code using Eclipse Che. You can use the *Topology* view to display applications, components, and workloads of your project. If you have no workloads in the project, the *Topology* view will show some links to create or import them. You can also use the *Quick Search* to import components directly. diff --git a/modules/adding-tab-pods-page.adoc b/modules/adding-tab-pods-page.adoc index 5d6c15172c..319c2b317f 100644 --- a/modules/adding-tab-pods-page.adoc +++ b/modules/adding-tab-pods-page.adoc @@ -10,7 +10,17 @@ There are different customizations you can make to the {product-title} web conso [NOTE] ==== -The {product-title} web console runs in a container connected to the cluster you have logged into. See "Dynamic plugin development" for information to test the plugin before creating your own. +The +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +web console runs in a container connected to the cluster you have logged into. See "Dynamic plugin development" for information to test the plugin before creating your own. ==== .Procedure diff --git a/modules/deployment-plug-in-cluster.adoc b/modules/deployment-plug-in-cluster.adoc index 447a0f8c07..3d10d5d757 100644 --- a/modules/deployment-plug-in-cluster.adoc +++ b/modules/deployment-plug-in-cluster.adoc @@ -34,10 +34,18 @@ Where: `--set plugin.image=my-plugin-image-location`:: Specifies the location of the image within the `plugin.image` parameter. -- + +ifndef::openshift-rosa-hcp[] [NOTE] ==== If you are deploying on {product-title} 4.10 and later, it is recommended to exclude configurations related to pod security by adding the parameter `--set plugin.securityContext.enabled=false`. ==== +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +[NOTE] +==== +If you are deploying on {product-title}, it is recommended to exclude configurations related to pod security by adding the parameter `--set plugin.securityContext.enabled=false`. +==== +endif::openshift-rosa-hcp[] . Optional: You can specify any additional parameters by using the set of supported parameters in the `charts/openshift-console-plugin/values.yaml` file. + diff --git a/modules/dynamic-plug-in-development.adoc b/modules/dynamic-plug-in-development.adoc index 1637b60b72..710c7ecfeb 100644 --- a/modules/dynamic-plug-in-development.adoc +++ b/modules/dynamic-plug-in-development.adoc @@ -15,7 +15,17 @@ You can run the plugin using a local development environment. The {product-title ==== Red{nbsp}Hat does not support custom plugin code. Only link:https://access.redhat.com/solutions/5893251[Cooperative community support] is available for your plugin. ==== -* You must have an {product-title} cluster running. +* You must have +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +a {rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +a {rosa-classic-short} +endif::openshift-rosa[] +cluster running. * You must have the {oc-first} installed. * You must have link:https://yarnpkg.com/[`yarn`] installed. * You must have link:https://www.docker.com/[Docker] v3.2.0 or later or link:https://podman.io/[Podman] v3.2.0 or later installed and running. @@ -40,14 +50,34 @@ $ yarn install $ yarn run start ---- -. In another terminal window, login to the {product-title} through the CLI. +. In another terminal window, login to the +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +through the CLI. + [source,terminal] ---- $ oc login ---- -. Run the {product-title} web console in a container connected to the cluster you have logged into by running the following command: +. Run the +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +web console in a container connected to the cluster you have logged in to by running the following command: + [source,terminal] ---- diff --git a/modules/dynamic-plugin-localization.adoc b/modules/dynamic-plugin-localization.adoc index 5713dce083..c6eb6bf986 100644 --- a/modules/dynamic-plugin-localization.adoc +++ b/modules/dynamic-plugin-localization.adoc @@ -10,7 +10,8 @@ The link:https://github.com/openshift/console-plugin-template[plugin template] d .Prerequisites * You must have the plugin template cloned locally. -* Optional: To test your plugin locally, run the {product-title} web console in a container. You can use either Docker or Podman 3.2.0 or later. +* Optional: To test your plugin locally, run the +{product-title} web console in a container. You can use either Docker or Podman 3.2.0 or later. .Procedure diff --git a/modules/dynamic-plugin-proxy-service.adoc b/modules/dynamic-plugin-proxy-service.adoc index 033b36ee90..0ccd5107d3 100644 --- a/modules/dynamic-plugin-proxy-service.adoc +++ b/modules/dynamic-plugin-proxy-service.adoc @@ -39,7 +39,17 @@ spec: + [NOTE] ==== -If the service proxy request does not contain the logged-in user's {product-title} access token, set the authorization field to `None`. +If the service proxy request does not contain the logged-in user's +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +access token, set the authorization field to `None`. ==== <3> If the service uses a custom service CA, the `caCertificate` field must contain the certificate bundle. <4> Endpoint of the proxy. \ No newline at end of file diff --git a/modules/enabling-developer-perspective_web-console.adoc b/modules/enabling-developer-perspective_web-console.adoc index 7c725dd54d..08af101492 100644 --- a/modules/enabling-developer-perspective_web-console.adoc +++ b/modules/enabling-developer-perspective_web-console.adoc @@ -6,8 +6,12 @@ [id="enabling-developer-perspective_web-console_{context}"] = Enabling the *Developer* perspective in the web console - +ifndef::openshift-rosa-hcp[] Starting with {product-title} 4.19, the perspectives in the web console have unified. There is no longer a *Developer* perspective by default; however, cluster administrators can enable the *Developer* perspective for developers to use. +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa-hcp[] +Cluster administrators can enable the *Developer* perspective for developers to use. +endif::openshift-rosa-hcp[] You can enable the *Developer* perspective with the following steps: diff --git a/modules/odc-access-web-terminal.adoc b/modules/odc-access-web-terminal.adoc index df686a0699..037d92ec6c 100644 --- a/modules/odc-access-web-terminal.adoc +++ b/modules/odc-access-web-terminal.adoc @@ -12,7 +12,14 @@ The web terminal remains open until you close it or until you close the browser .Prerequisites -* You have access to an {product-title} cluster and are logged into the web console. +* You have access to +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp,openshift-rosa[] +a {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +cluster and are logged into the web console. * The {web-terminal-op} is installed on your cluster. .Procedure diff --git a/modules/odc-configure-web-terminal-image-session.adoc b/modules/odc-configure-web-terminal-image-session.adoc index 53cbc68faf..3cb0100e53 100644 --- a/modules/odc-configure-web-terminal-image-session.adoc +++ b/modules/odc-configure-web-terminal-image-session.adoc @@ -11,7 +11,14 @@ You can change the default image for the web terminal for your current session. .Prerequisites -* You have access to an {product-title} cluster that has the {web-terminal-op} installed. +* You have access to +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp,openshift-rosa[] +a {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +cluster that has the {web-terminal-op} installed. * You are logged into the web console. .Procedure diff --git a/modules/odc-configure-web-terminal-timeout-session.adoc b/modules/odc-configure-web-terminal-timeout-session.adoc index 4a25f45447..719746b487 100644 --- a/modules/odc-configure-web-terminal-timeout-session.adoc +++ b/modules/odc-configure-web-terminal-timeout-session.adoc @@ -11,7 +11,14 @@ You can change the default timeout period for the web terminal for your current .Prerequisites -* You have access to an {product-title} cluster that has the {web-terminal-op} installed. +* You have access to +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp,openshift-rosa[] +a {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +cluster that has the {web-terminal-op} installed. * You are logged into the web console. .Procedure diff --git a/modules/optional-capabilities-operators.adoc b/modules/optional-capabilities-operators.adoc index a2f1a6ee25..a0c2fe119a 100644 --- a/modules/optional-capabilities-operators.adoc +++ b/modules/optional-capabilities-operators.adoc @@ -4,6 +4,14 @@ :_mod-docs-content-type: CONCEPT [id="optional-capabilities-operators_{context}"] +ifndef::openshift-rosa-hcp,openshift-rosa[] = Enhancing the {product-title} web console with Operators +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] += Enhancing the {rosa-short} web console with Operators +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] += Enhancing the {rosa-classic-short} web console with Operators +endif::openshift-rosa[] Cluster administrators can install Operators on clusters in the {product-title} web console by using the OperatorHub to provide customization outside of layered products for developers. For example, the Web Terminal Operator allows you to start a web terminal in your browser with common CLI tools for interacting with the cluster. \ No newline at end of file diff --git a/modules/removing-devworkspace-operator.adoc b/modules/removing-devworkspace-operator.adoc index 4c84a088c1..42d75d602b 100644 --- a/modules/removing-devworkspace-operator.adoc +++ b/modules/removing-devworkspace-operator.adoc @@ -15,7 +15,14 @@ The {devworkspace-op} is a standalone Operator and may be required as a dependen .Prerequisites -* You have access to an {product-title} cluster with cluster administrator permissions. +* You have access to +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp,openshift-rosa[] +a {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +cluster with cluster administrator permissions. * You have installed the `oc` CLI. // Hide step 2, cannot delete resource "customresourcedefinitions" in ROSA/OSD @@ -41,7 +48,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[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Remove the CRDs used by the Operator: + [WARNING] @@ -97,7 +104,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[] +endif::openshift-rosa,openshift-rosa-hcp,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. + diff --git a/modules/rhdh-install-web-console.adoc b/modules/rhdh-install-web-console.adoc index 2d162661c9..ba6f1891dc 100644 --- a/modules/rhdh-install-web-console.adoc +++ b/modules/rhdh-install-web-console.adoc @@ -4,7 +4,15 @@ :_mod-docs-content-type: PROCEDURE [id="rhdh-install-web-console_{context}"] +ifndef::openshift-rosa-hcp,openshift-rosa[] = Installing the {rh-dev-hub} using the {product-title} web console +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] += Installing the {rh-dev-hub} using the {rosa-short} web console +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] += Installing the {rh-dev-hub} using the {rosa-classic-short} web console +endif::openshift-rosa[] The web console provides a quick start with instructions on how to install the {rh-dev-hub} Operator. diff --git a/modules/rhdh-web-console.adoc b/modules/rhdh-web-console.adoc index 4311182df6..eeb3bc35cf 100644 --- a/modules/rhdh-web-console.adoc +++ b/modules/rhdh-web-console.adoc @@ -4,6 +4,14 @@ :_mod-docs-content-type: CONCEPT [id="rhdh-web-console_{context}"] +ifndef::openshift-rosa-hcp,openshift-rosa[] = {rh-dev-hub} in the {product-title} web console +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] += {rh-dev-hub} in the {rosa-short} web console +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] += {rh-dev-hub} in the {rosa-classic-short} web console +endif::openshift-rosa[] The {rh-dev-hub} is a platform you can use to experience a streamlined development environment. {rh-dev-hub} is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure. It enables your product team to deliver quality code without any compromises. A quick start is available for you to learn more about how to install the developer hub. \ No newline at end of file diff --git a/modules/serverless-web-console.adoc b/modules/serverless-web-console.adoc index 3706006cab..9cb432d237 100644 --- a/modules/serverless-web-console.adoc +++ b/modules/serverless-web-console.adoc @@ -6,4 +6,14 @@ [id="using-serverless-with-openshift_{context}"] = Red Hat {serverlessproductname} in the web console -Red Hat {serverlessproductname} enables developers to create and deploy serverless, event-driven applications on {product-title}. You can use the {product-title} web console OperatorHub to install the {serverlessproductname} Operator. \ No newline at end of file +Red Hat {serverlessproductname} enables developers to create and deploy serverless, event-driven applications on {product-title}. You can use the +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +web console OperatorHub to install the {serverlessproductname} Operator. \ No newline at end of file diff --git a/modules/troubleshooting-dynamic-plugin.adoc b/modules/troubleshooting-dynamic-plugin.adoc index 4168e4680d..e55346d3e5 100644 --- a/modules/troubleshooting-dynamic-plugin.adoc +++ b/modules/troubleshooting-dynamic-plugin.adoc @@ -30,7 +30,7 @@ $ oc get console.operator.openshift.io cluster -o jsonpath='{.spec.plugins}' * Verify any certificates or connection errors in the console pod logs. -* Verify the feature flag your plugin relys on is not disabled. +* Verify the feature flag your plugin relies on is not disabled. * Verify your plugin does not have any `consolePlugin.dependencies` in `package.json` that are not met. ** This can include console version dependencies or dependencies on other plugins. Filter the JS console in your browser for your plugin's name to see messages that are logged. diff --git a/modules/virt-about-the-overview-dashboard.adoc b/modules/virt-about-the-overview-dashboard.adoc index bac66be5c3..dbcd0a783e 100644 --- a/modules/virt-about-the-overview-dashboard.adoc +++ b/modules/virt-about-the-overview-dashboard.adoc @@ -4,35 +4,73 @@ :_mod-docs-content-type: CONCEPT [id="virt-about-the-overview-dashboard_{context}"] +ifndef::openshift-rosa-hcp,openshift-rosa[] = About the {product-title} dashboards page +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] += About the {rosa-short} dashboards page +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] += About the {rosa-classic-short} dashboards page +endif::openshift-rosa[] Access the {product-title} dashboard, which captures high-level information about the cluster, by navigating to *Home* -> *Overview* from -the {product-title} web console. +the +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +web console. -The {product-title} dashboard provides various cluster information, captured in +The +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +dashboard provides various cluster information, captured in individual dashboard cards. -The {product-title} dashboard consists of the following cards: +The +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +dashboard consists of the following cards: * *Details* provides a brief overview of informational cluster details. + -Status include *ok*, *error*, *warning*, *in progress*, and *unknown*. Resources can add custom status names. +Statuses include *ok*, *error*, *warning*, *in progress*, and *unknown*. Resources can add custom status names. + ** Cluster ID ** Provider ** Version -* *Cluster Inventory* details number of resources and associated statuses. It is helpful when intervention is required to resolve problems, including information about: -** Number of nodes -** Number of pods -** Persistent storage volume claims -** Bare metal hosts in the cluster, listed according to their state (only available in *metal3* environment) +* *Cluster Inventory* details the number of resources and associated statuses. It is helpful when intervention is required to resolve problems, including information about: +** Number of nodes. +** Number of pods. +** Persistent storage volume claims. +** Bare-metal hosts in the cluster, listed according to their state (only available in *metal3* environment). * *Status* helps administrators understand how cluster resources are consumed. Click on a resource to jump to a detailed page listing pods and nodes that consume the largest amount of the specified cluster resource (CPU, memory, or storage). * *Cluster Utilization* shows the capacity of various resources over a specified period of time, to help administrators understand the scale and frequency of high resource consumption, including information about: -** CPU time -** Memory allocation -** Storage consumed -** Network resources consumed -** Pod count +** CPU time. +** Memory allocation. +** Storage consumed. +** Network resources consumed. +** Pod count. * *Activity* lists messages related to recent activity in the cluster, such as pod creation or virtual machine migration to another host. diff --git a/snippets/unified-perspective-web-console.adoc b/snippets/unified-perspective-web-console.adoc index ce33451916..c38abe7c72 100644 --- a/snippets/unified-perspective-web-console.adoc +++ b/snippets/unified-perspective-web-console.adoc @@ -12,7 +12,14 @@ ==== Starting with {product-title} 4.19, the perspectives in the web console have unified. The *Developer* perspective is no longer enabled by default. -All users can interact with all {product-title} web console features. However, if you are not the cluster owner, you might need to request permission to certain features from the cluster owner. +All users can interact with all +ifndef::openshift-rosa[] +{product-title} +endif::openshift-rosa[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +web console features. However, if you are not the cluster owner, you might need to request permission to certain features from the cluster owner. You can still enable the *Developer* perspective. On the *Getting Started* pane in the web console, you can take a tour of the console, find information on setting up your cluster, view a quick start for enabling the *Developer* perspective, and follow links to explore new features and capabilities. ==== \ No newline at end of file diff --git a/web_console/adding-user-preferences.adoc b/web_console/adding-user-preferences.adoc index 8499cc690c..080da2b87f 100644 --- a/web_console/adding-user-preferences.adoc +++ b/web_console/adding-user-preferences.adoc @@ -2,6 +2,7 @@ [id="adding-user-preferences"] = Adding user preferences include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: adding-user-preferences toc::[] diff --git a/web_console/capabilities_products-web-console.adoc b/web_console/capabilities_products-web-console.adoc index c549cb2adc..059fab4c13 100644 --- a/web_console/capabilities_products-web-console.adoc +++ b/web_console/capabilities_products-web-console.adoc @@ -2,6 +2,7 @@ [id="capabilities-products-web-console"] = Optional capabilities and products in the web console include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: capabilities-web-console toc::[] diff --git a/web_console/configuring-web-console.adoc b/web_console/configuring-web-console.adoc index ce59d3365b..e1b442ed94 100644 --- a/web_console/configuring-web-console.adoc +++ b/web_console/configuring-web-console.adoc @@ -2,6 +2,7 @@ [id="configuring-web-console"] = Configuring the web console in {product-title} include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: configuring-web-console toc::[] diff --git a/web_console/creating-quick-start-tutorials.adoc b/web_console/creating-quick-start-tutorials.adoc index bb652776b7..b438ca2d9c 100644 --- a/web_console/creating-quick-start-tutorials.adoc +++ b/web_console/creating-quick-start-tutorials.adoc @@ -3,6 +3,7 @@ ifndef::openshift-rosa,openshift-dedicated[] [id="creating-quick-start-tutorials"] = Creating quick start tutorials in the web console include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: creating-quick-start-tutorials endif::openshift-rosa,openshift-dedicated[] ifdef::openshift-rosa,openshift-dedicated[] @@ -10,12 +11,15 @@ ifdef::openshift-rosa,openshift-dedicated[] [id="creating-quick-start-tutorials"] = About quick start tutorials include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: creating-quick-start-tutorials endif::openshift-rosa,openshift-dedicated[] toc::[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] If you are creating quick start tutorials for the {product-title} web console, follow these guidelines to maintain a consistent user experience across all quick starts. +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/understanding-quick-starts.adoc[leveloffset=+1] @@ -24,7 +28,7 @@ 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[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/contributing-quick-starts.adoc[leveloffset=+1] include::modules/understanding-quick-start-elements.adoc[leveloffset=+2] @@ -49,4 +53,4 @@ include::modules/quick-start-content-guidelines.adoc[leveloffset=+1] * 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[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index 9fa9010734..d842b8e300 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -2,6 +2,7 @@ [id="customizing-web-console"] = Customizing the web console in {product-title} include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: customizing-web-console toc::[] diff --git a/web_console/disabling-web-console.adoc b/web_console/disabling-web-console.adoc index 86cccb3dec..af05fe33ea 100644 --- a/web_console/disabling-web-console.adoc +++ b/web_console/disabling-web-console.adoc @@ -2,6 +2,7 @@ [id="disabling-web-console"] = Disabling the web console in {product-title} include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: disabling-web-console toc::[] @@ -10,6 +11,16 @@ You can disable the {product-title} web console. == Prerequisites -* Deploy an {product-title} cluster. +* Deploy +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +a {rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +a {rosa-classic-short} +endif::openshift-rosa[] +cluster. include::modules/web-console-disable.adoc[leveloffset=+1] diff --git a/web_console/dynamic-plugin/content-security-policy.adoc b/web_console/dynamic-plugin/content-security-policy.adoc index a5373dd458..48f927c202 100644 --- a/web_console/dynamic-plugin/content-security-policy.adoc +++ b/web_console/dynamic-plugin/content-security-policy.adoc @@ -2,6 +2,7 @@ [id="content-security-policy_{context}"] = Content Security Policy (CSP) include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: content-security-policy toc::[] @@ -12,7 +13,9 @@ You can specify Content Security Policy (CSP) directives for your dynamic plugin ==== The console currently uses the `Content-Security-Policy-Report-Only` response header, so the browser will only warn about CSP violations in the web console and enforcement of CSP policies will be limited. CSP violations will be logged in the browser console, but the associated CSP directives will not be enforced. This feature is behind a `feature-gate`, so you will need to manually enable it. +ifndef::openshift-rosa-hcp,openshift-rosa[] For more information, see xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features-console_nodes-cluster-enabling[Enabling feature sets using the web console]. +endif::openshift-rosa-hcp,openshift-rosa[] ==== include::modules/csp-overview.adoc[leveloffset=+1] diff --git a/web_console/dynamic-plugin/deploy-plugin-cluster.adoc b/web_console/dynamic-plugin/deploy-plugin-cluster.adoc index bac600e462..fe3229d012 100644 --- a/web_console/dynamic-plugin/deploy-plugin-cluster.adoc +++ b/web_console/dynamic-plugin/deploy-plugin-cluster.adoc @@ -2,11 +2,19 @@ [id="deploy-plugin-cluster_{context}"] = Deploy your plugin on a cluster include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: deploy-plugin-cluster toc::[] -You can deploy the plugin to a {product-title} cluster. +You can deploy the plugin to +ifndef::openshift-rosa-hcp,openshift-rosa[] +an {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp,openshift-rosa[] +a {product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +cluster. include::modules/build-image-docker.adoc[leveloffset=+1] diff --git a/web_console/dynamic-plugin/dynamic-plugin-example.adoc b/web_console/dynamic-plugin/dynamic-plugin-example.adoc index 67fa72d4b2..b45a10a083 100644 --- a/web_console/dynamic-plugin/dynamic-plugin-example.adoc +++ b/web_console/dynamic-plugin/dynamic-plugin-example.adoc @@ -2,6 +2,7 @@ [id="dynamic-plugin-example_{context}"] = Dynamic plugin example include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: dynamic-plugin-example toc::[] diff --git a/web_console/dynamic-plugin/dynamic-plugins-get-started.adoc b/web_console/dynamic-plugin/dynamic-plugins-get-started.adoc index 049cb9619b..08e5889795 100644 --- a/web_console/dynamic-plugin/dynamic-plugins-get-started.adoc +++ b/web_console/dynamic-plugin/dynamic-plugins-get-started.adoc @@ -2,6 +2,7 @@ [id="getting-started-with-dynamic-plugins_{context}"] = Getting started with dynamic plugins include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: dynamic-plugins-get-started toc::[] diff --git a/web_console/dynamic-plugin/dynamic-plugins-reference.adoc b/web_console/dynamic-plugin/dynamic-plugins-reference.adoc index 236e428997..8014040cd4 100644 --- a/web_console/dynamic-plugin/dynamic-plugins-reference.adoc +++ b/web_console/dynamic-plugin/dynamic-plugins-reference.adoc @@ -2,6 +2,7 @@ [id="dynamic-plugins-reference_{context}"] = Dynamic plugin reference include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: dynamic-plugins-reference toc::[] diff --git a/web_console/dynamic-plugin/overview-dynamic-plugin.adoc b/web_console/dynamic-plugin/overview-dynamic-plugin.adoc index 0d27c4234b..44783bcb86 100644 --- a/web_console/dynamic-plugin/overview-dynamic-plugin.adoc +++ b/web_console/dynamic-plugin/overview-dynamic-plugin.adoc @@ -2,6 +2,7 @@ [id="overview-of-dynamic-plugins_{context}"] = Overview of dynamic plugins include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: overview-of-dynamic-plugins toc::[] @@ -53,8 +54,17 @@ conster Header: React.FC ++= () => {++ When creating your plugin, follow these guidelines for using PatternFly: * Use link:https://www.patternfly.org/components/all-components/[PatternFly] components and PatternFly CSS variables. Core PatternFly components are available through the SDK. Using PatternFly components and variables help your plugin look consistent in future console versions. +ifndef::openshift-rosa-hcp,openshift-rosa[] ** Use Patternfly 4.x if you are using {product-title} versions 4.14 and earlier. ** Use Patternfly 5.x if you are using {product-title} 4.15 or later. +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +** Use Patternfly 5.x. +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +** Use Patternfly 4.x if you are using {rosa-classic-short} versions 4.14 and earlier. +** Use Patternfly 5.x if you are using {rosa-classic-short} 4.15 or later. +endif::openshift-rosa[] * Make your plugin accessible by following link:https://www.patternfly.org/accessibility/accessibility-fundamentals/[PatternFly's accessibility fundamentals]. * Avoid using other CSS libraries such as Bootstrap or Tailwind. They might conflict with PatternFly and not match the rest of the console. Plugins should only include styles that are specific to their user interfaces to be evaluated on top of base PatternFly styles. Avoid importing styles such as `@patternfly/react-styles/**/*.css` or any styles from the `@patternfly/patternfly` package in your plugin. * The console application is responsible for loading base styles for all supported PatternFly version(s). diff --git a/web_console/using-dashboard-to-get-cluster-information.adoc b/web_console/using-dashboard-to-get-cluster-information.adoc index 980d936b32..06837b115c 100644 --- a/web_console/using-dashboard-to-get-cluster-information.adoc +++ b/web_console/using-dashboard-to-get-cluster-information.adoc @@ -1,13 +1,31 @@ +ifndef::openshift-rosa-hcp,openshift-rosa[] :_mod-docs-content-type: ASSEMBLY [id="using-dashboard-to-get-cluster-info"] = Using the {product-title} dashboard to get cluster information include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: using-dashboard-to-get-cluster-info +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +:_mod-docs-content-type: ASSEMBLY +[id="using-dashboard-to-get-cluster-info"] += Using the {rosa-short} dashboard to get cluster information +include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] +:context: using-dashboard-to-get-cluster-info +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +:_mod-docs-content-type: ASSEMBLY +[id="using-dashboard-to-get-cluster-info"] += Using the {rosa-classic-short} dashboard to get cluster information +include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] +:context: using-dashboard-to-get-cluster-info +endif::openshift-rosa[] toc::[] -The {product-title} web console captures high-level information -about the cluster. +The {product-title} web console captures high-level information about the cluster. include::modules/virt-about-the-overview-dashboard.adoc[leveloffset=+1] include::modules/recognize-resource-limits-quotas.adoc[leveloffset=+1] diff --git a/web_console/web-console-overview.adoc b/web_console/web-console-overview.adoc index d0ad85e6d3..df21822f37 100644 --- a/web_console/web-console-overview.adoc +++ b/web_console/web-console-overview.adoc @@ -2,15 +2,28 @@ [id="web-console-overview"] = Web Console Overview include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: web-console-overview toc::[] -The Red Hat {product-title} web console provides a graphical user interface to visualize your project data and perform administrative, management, and troubleshooting tasks. The web console runs as pods on the control plane nodes in the openshift-console project. It is managed by a `console-operator` pod. +The {product-title} web console provides a graphical user interface to visualize your project data and perform administrative, management, and troubleshooting tasks. The web console runs as pods on the control plane nodes in the openshift-console project. It is managed by a `console-operator` pod. +ifndef::openshift-rosa-hcp[] include::snippets/unified-perspective-web-console.adoc[] +endif::openshift-rosa-hcp[] -You can create quick start tutorials for {product-title} that provide guided steps within the web console with user tasks. They are helpful for getting oriented with an application, Operator, or other product offering. +You can create quick start tutorials for +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +that provide guided steps within the web console with user tasks. They are helpful for getting oriented with an application, Operator, or other product offering. include::modules/about-administrator_web-console.adoc[leveloffset=+1] include::modules/about-developer_web-console.adoc[leveloffset=+1] diff --git a/web_console/web-console.adoc b/web_console/web-console.adoc index 03f84a0766..0a15b099c4 100644 --- a/web_console/web-console.adoc +++ b/web_console/web-console.adoc @@ -3,6 +3,7 @@ [id="web-console"] = Accessing the web console include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: web-console toc::[] diff --git a/web_console/web_terminal/configuring-web-terminal.adoc b/web_console/web_terminal/configuring-web-terminal.adoc index 1b3585bba0..73022c4569 100644 --- a/web_console/web_terminal/configuring-web-terminal.adoc +++ b/web_console/web_terminal/configuring-web-terminal.adoc @@ -2,6 +2,7 @@ [id="configuring-web-terminal"] = Configuring the web terminal include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: configuring-web-terminal toc::[] diff --git a/web_console/web_terminal/installing-web-terminal.adoc b/web_console/web_terminal/installing-web-terminal.adoc index f8a954095a..8df7bce0f5 100644 --- a/web_console/web_terminal/installing-web-terminal.adoc +++ b/web_console/web_terminal/installing-web-terminal.adoc @@ -2,6 +2,7 @@ [id="installing-web-terminal"] = Installing the web terminal include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: installing-web-terminal toc::[] @@ -12,7 +13,17 @@ You can install the web terminal by using the {web-terminal-op} listed in the {p [id="prerequisites_installing-web-terminal"] == Prerequisites -* You are logged into the {product-title} web console. +* You are logged into the +ifndef::openshift-rosa-hcp,openshift-rosa[] +{product-title} +endif::openshift-rosa-hcp,openshift-rosa[] +ifdef::openshift-rosa-hcp[] +{rosa-short} +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] +{rosa-classic-short} +endif::openshift-rosa[] +web console. * You have cluster administrator permissions. [discrete] diff --git a/web_console/web_terminal/odc-using-web-terminal.adoc b/web_console/web_terminal/odc-using-web-terminal.adoc index e4d4c9ec9d..ffcfb1bcdc 100644 --- a/web_console/web_terminal/odc-using-web-terminal.adoc +++ b/web_console/web_terminal/odc-using-web-terminal.adoc @@ -2,6 +2,7 @@ [id="odc-using-web-terminal"] = Using the web terminal include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: odc-using-web-terminal toc::[] diff --git a/web_console/web_terminal/troubleshooting-web-terminal.adoc b/web_console/web_terminal/troubleshooting-web-terminal.adoc index 3da5e6a1f5..dbb85154e2 100644 --- a/web_console/web_terminal/troubleshooting-web-terminal.adoc +++ b/web_console/web_terminal/troubleshooting-web-terminal.adoc @@ -2,6 +2,7 @@ [id="troubleshooting-web-terminal"] = Troubleshooting the web terminal include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: troubleshooting-web-terminal toc::[] diff --git a/web_console/web_terminal/uninstalling-web-terminal.adoc b/web_console/web_terminal/uninstalling-web-terminal.adoc index d856fce3d8..2b6ffa5bbd 100644 --- a/web_console/web_terminal/uninstalling-web-terminal.adoc +++ b/web_console/web_terminal/uninstalling-web-terminal.adoc @@ -2,6 +2,7 @@ [id="uninstalling-web-terminal"] = Uninstalling the web terminal include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: uninstalling-web-terminal toc::[]