Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/optional-capabilities-operators.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion modules/pipelines-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion modules/recognize-resource-limits-quotas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions modules/removing-devworkspace-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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]
----
Expand Down
7 changes: 3 additions & 4 deletions modules/virt-about-the-overview-dashboard.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,15 @@
= 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.

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
Expand All @@ -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.
Expand Down
13 changes: 9 additions & 4 deletions modules/web-console-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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*.
3 changes: 1 addition & 2 deletions modules/web-console-disable.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
5 changes: 3 additions & 2 deletions web_console/web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]