diff --git a/modules/optional-capabilities-operators.adoc b/modules/optional-capabilities-operators.adoc index 6984bc3eab58..0bdf233866a8 100644 --- a/modules/optional-capabilities-operators.adoc +++ b/modules/optional-capabilities-operators.adoc @@ -7,4 +7,4 @@ = Enhancing the {product-title} web console with Operators [role="_abstract"] -Cluster administrators can install Operators on clusters in the {product-title} web console by using the software catalog 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. +Cluster administrators can install Operators on clusters in the {product-title} web console by using the software catalog to provide customization outside of layered products for developers. For example, the {web-terminal-op} allows you to start a web terminal in your browser with common CLI tools for interacting with the cluster. diff --git a/modules/pipelines-web-console.adoc b/modules/pipelines-web-console.adoc index 1cc248f000f4..ea481f87ad87 100644 --- a/modules/pipelines-web-console.adoc +++ b/modules/pipelines-web-console.adoc @@ -7,4 +7,4 @@ = {pipelines-title} in the web console [role="_abstract"] -{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. Install the {pipelines-title} Operator using the software catalog in the {product-title} web console. Once the Operator is installed, you can create and modify pipeline objects on *Pipelines* page. +{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. Install the {pipelines-title} Operator by using the software catalog in the {product-title} web console. Once the Operator is installed, you can create and modify pipeline objects on *Pipelines* page. diff --git a/modules/recognize-resource-limits-quotas.adoc b/modules/recognize-resource-limits-quotas.adoc index aec52453bd1d..0f7fdea9d3ac 100644 --- a/modules/recognize-resource-limits-quotas.adoc +++ b/modules/recognize-resource-limits-quotas.adoc @@ -8,6 +8,6 @@ [role="_abstract"] You can view a graphical representation of available resources in the *Topology* view of the web console *Developer* perspective. -If a resource has a message about resource limitations or quotas being reached, a yellow border appears around the resource name. Click the resource to open a side panel to see the message. If the *Topology* view has been zoomed out, a yellow dot indicates that a message is available. +If a resource has a message about resource limitations or quotas being reached, a border is displayed around the resource name to indicate this. Click the resource to open a side panel to see the message. If the *Topology* view is zoomed out, a dot next to the resource name indicates that a message is available. If you are using *List View* from the *View Shortcuts* menu, resources appear as a list. The *Alerts* column indicates if a message is available. diff --git a/modules/removing-devworkspace-operator.adoc b/modules/removing-devworkspace-operator.adoc index 11bc1360857f..d27d0b44901c 100644 --- a/modules/removing-devworkspace-operator.adoc +++ b/modules/removing-devworkspace-operator.adoc @@ -11,7 +11,7 @@ To completely uninstall the web terminal, you must also remove the {devworkspace [IMPORTANT] ==== -The {devworkspace-op} is a standalone Operator and may be required as a dependency for other Operators installed in the cluster. Follow the steps below only if you are sure that the {devworkspace-op} is no longer needed. +The {devworkspace-op} is a standalone Operator and might be required as a dependency for other Operators installed in the cluster. Follow the steps below only if you are sure that the {devworkspace-op} is no longer needed. ==== .Prerequisites @@ -103,11 +103,11 @@ $ oc delete validatingwebhookconfigurations controller.devfile.io + [NOTE] ==== -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. +If you remove the `devworkspace-webhook-server` deployment without removing the mutating and validating webhooks, you cannot 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-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. +. Remove any remaining services, secrets, and config maps. Depending on the installation, some resources included in the following commands might not exist in the cluster. + [source,terminal] ---- diff --git a/modules/virt-about-the-overview-dashboard.adoc b/modules/virt-about-the-overview-dashboard.adoc index e2785d1e491f..e78dfceb9061 100644 --- a/modules/virt-about-the-overview-dashboard.adoc +++ b/modules/virt-about-the-overview-dashboard.adoc @@ -7,8 +7,7 @@ = About the {product-title} dashboards page [role="_abstract"] -Access the {product-title} dashboard, which captures high-level information -about the cluster, by navigating to *Home* -> *Overview* from the {product-title} web console. +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 {product-title} dashboard provides various cluster information, captured in individual dashboard cards. @@ -16,7 +15,7 @@ The {product-title} dashboard consists of the following cards: * *Details* provides a brief overview of informational cluster details. + -Statuses 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 @@ -26,7 +25,7 @@ Statuses include *ok*, *error*, *warning*, *in progress*, and *unknown*. Resourc ** 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). +* *Status* helps administrators understand how cluster resources are consumed. Click 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. diff --git a/modules/web-console-configuration.adoc b/modules/web-console-configuration.adoc index 6e6f4230c7ee..9e20287d769e 100644 --- a/modules/web-console-configuration.adoc +++ b/modules/web-console-configuration.adoc @@ -6,8 +6,11 @@ [id="web-console-configuration_{context}"] = Configuring the web console +[role="_abstract"] You can configure the web console settings by editing the `console.config.openshift.io` resource. +.Procedure + * Edit the `console.config.openshift.io` resource: + [source,terminal] @@ -25,9 +28,11 @@ metadata: name: cluster spec: authentication: - logoutRedirect: "" <1> + logoutRedirect: "" status: - consoleURL: "" <2> + consoleURL: "" ---- -<1> Specify the URL of the page to load when a user logs out of the web console. If you do not specify a value, the user returns to the login page for the web console. Specifying a `logoutRedirect` URL allows your users to perform single logout (SLO) through the identity provider to destroy their single sign-on session. -<2> The web console URL. To update this to a custom value, see *Customizing the web console URL*. ++ +The `logoutRedirect` field specifies the URL of the page to load when a user logs out of the web console. If you do not specify a value, the user returns to the login page for the web console. Specifying a `logoutRedirect` URL allows your users to perform single logout (SLO) through the identity provider to delete their single sign-on session. ++ +The `consoleURL` field is the web console URL. To update this to a custom value, see *Customizing the web console URL*. diff --git a/modules/web-console-disable.adoc b/modules/web-console-disable.adoc index 91be443b6e33..32828f6c82fe 100644 --- a/modules/web-console-disable.adoc +++ b/modules/web-console-disable.adoc @@ -17,8 +17,7 @@ You can disable the web console by editing the `consoles.operator.openshift.io` $ oc edit consoles.operator.openshift.io cluster ---- + -The following example displays the parameters from this resource that you can -modify: +The following example displays the parameters from this resource that you can modify: + [source,yaml] ---- diff --git a/web_console/web-console.adoc b/web_console/web-console.adoc index f40cea238305..1a252a62374d 100644 --- a/web_console/web-console.adoc +++ b/web_console/web-console.adoc @@ -14,13 +14,14 @@ The {product-title} web console is a user interface accessible from a web browse == Prerequisites -* You must use one of the following supported web browsers: Edge, Chrome, Safari, or Mozilla Firefox. IE 11 and earlier is not supported. -* Review the link:https://access.redhat.com/articles/4128421[OpenShift ContainerPlatform 4.x Tested Integrations] page before you create the supporting infrastructure for your cluster. +* You must use one of the following supported web browsers: Edge, Chrome, Safari, or Mozilla Firefox. Internet Explorer 11 and earlier is not supported. +* Review the {product-title} 4.x Tested Integrations page before you create the supporting infrastructure for your cluster. include::modules/web-console-overview.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources +* link:https://access.redhat.com/articles/4128421[{product-title} 4.x Tested Integrations] * xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features[Enabling feature sets using the web console] endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] \ No newline at end of file