Skip to content

Commit 342ece9

Browse files
authored
Merge pull request #93644 from opayne1/OSDOCS-12145
OSDOCS#12145: Updates to the web console overview for 4.19
2 parents 6360073 + 4027644 commit 342ece9

File tree

5 files changed

+58
-37
lines changed

5 files changed

+58
-37
lines changed

modules/about-administrator-perspective.adoc renamed to modules/about-administrator_web-console.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,18 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="about-administrator-perspective_{context}"]
7-
= About the Administrator perspective in the web console
7+
= Administrator role in the web console
88

9-
The *Administrator* perspective 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 view the *Administrator* perspective.
9+
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.
1010

1111
Cluster administrators can also open an embedded command-line terminal instance with the web terminal Operator in {product-title} 4.7 and later.
1212

13-
[NOTE]
14-
====
15-
The default web console perspective that is shown depends on the role of the user. The *Administrator* perspective is displayed by default if the user is recognized as an administrator.
16-
====
17-
1813
The *Administrator* perspective provides workflows specific to administrator use cases, such as the ability to:
1914

2015
* Manage workload, storage, networking, and cluster settings.
21-
* Install and manage Operators using the Operator Hub.
16+
* Install and manage Operators using the OperatorHub.
2217
* Add identity providers that allow users to log in and manage user access through roles and role bindings.
2318
* View and manage a variety of advanced settings such as cluster updates, partial cluster updates, cluster Operators, custom resource definitions (CRDs), role bindings, and resource quotas.
2419
* Access and manage monitoring features such as metrics, alerts, and monitoring dashboards.
2520
* View and manage logging, metrics, and high-status information about the cluster.
26-
* Visually interact with applications, components, and services associated with the *Administrator* perspective in {product-title}.
21+
* Visually interact with applications, components, and services.

modules/about-developer-perspective.adoc renamed to modules/about-developer_web-console.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
// web_console/web-console-overview.adoc
44

55
:_mod-docs-content-type: CONCEPT
6-
[id="about-developer-perspective_{context}"]
7-
= About the Developer perspective in the web console
6+
[id="about-developer_web-console_{context}"]
7+
= Developer role in the web console
88

9-
The *Developer* perspective offers several built-in ways to deploy applications, services, and databases. In the *Developer* perspective, you can:
9+
The developer role in the web console offers several built-in ways to deploy applications, services, and databases. With the developer role, you can:
1010

1111
* View real-time visualization of rolling and recreating rollouts on the component.
1212
* View the application status, resource utilization, project event streaming, and quota consumption.
@@ -15,12 +15,7 @@ The *Developer* perspective offers several built-in ways to deploy applications,
1515
1616
Cluster administrators can also open an embedded command-line terminal instance in the web console in {product-title} 4.7 and later.
1717

18-
[NOTE]
19-
====
20-
The default web console perspective that is shown depends on the role of the user. The *Developer* perspective is displayed by default if the user is recognised as a developer.
21-
====
22-
23-
The *Developer* perspective provides workflows specific to developer use cases, such as the ability to:
18+
Developers have access to workflows specific to their use cases, such as the ability to:
2419

2520
* Create and deploy applications on {product-title} by importing existing codebases, images, and container files.
2621
* Visually interact with applications, components, and services associated with them within a project and monitor their deployment and build status.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Module included in the following assemblies:
2+
//
3+
// web_console/web-console-overview.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="enabling-developer-perspective_web-console_{context}"]
7+
= Enabling the *Developer* perspective in the web console
8+
9+
10+
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.
11+
12+
You can enable the *Developer* perspective with the following steps:
13+
14+
.Prerequisites
15+
16+
* You have access to the web console as a user with `cluster-admin` privileges.
17+
18+
.Procedure
19+
20+
. Navigate to the *Cluster Settings* page by clicking *Administration* -> *Cluster Settings*.
21+
22+
. Select the *Configuration* tab on the *Cluster Settings* page.
23+
24+
. Type `console` in the search to locate the Console Operator resource and select `operator.openshift.io`.
25+
26+
. On the *Cluster Details* page, click the *Actions* menu and select *Customize*.
27+
28+
. In the *General* tab, locate the *Perspectives* section. You can enable or disable the *Developer* perspective as needed. Changes are automatically applied.
29+
30+
. Optional: You can enable the *Developer* perspective with the CLI by running the following command:
31+
+
32+
[source,terminal]
33+
----
34+
$ oc patch console.operator.openshift.io/cluster --type='merge' -p '{"spec":{"customization":{"perspectives":[{"id":"dev","visibility":{"state":"Enabled"}}]}}}'
35+
----
36+
+
37+
[NOTE]
38+
====
39+
It will take some time for the change to reflect in the web console as the console pod restarts.
40+
====

web_console/web-console-overview.adoc

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,21 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
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. Both *Administrator* and *Developer* perspectives are supported.
9+
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.
1010

11-
Both *Administrator* and *Developer* perspectives enable you to create quick start tutorials for {product-title}. A quick start is a guided tutorial with user tasks and is useful for getting oriented with an application, Operator, or other product offering.
11+
include::snippets/unified-perspective-web-console.adoc[]
1212

13-
include::modules/about-administrator-perspective.adoc[leveloffset=+1]
14-
include::modules/about-developer-perspective.adoc[leveloffset=+1]
15-
include::modules/odc-accessing-perspectives.adoc[leveloffset=+1]
13+
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.
14+
15+
include::modules/about-administrator_web-console.adoc[leveloffset=+1]
16+
include::modules/about-developer_web-console.adoc[leveloffset=+1]
17+
include::modules/enabling-developer-perspective_web-console.adoc[leveloffset=+1]
1618

1719
[role="_additional-resources"]
1820
.Additional resources
1921

2022
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
2123
* xref:../welcome/learn_more_about_openshift.adoc#cluster-administrator[Learn more about Cluster Administrator]
22-
// TODO: Update once this is moved to the About book
23-
// * xref :../getting_started/openshift-overview.adoc#for-administrators[Overview of the *Administrator* perspective]
24-
* 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]
2524
* 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]
2625
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
2726
* xref:../web_console/using-dashboard-to-get-cluster-information.adoc#using-dashboard-to-get-cluster-info[Viewing cluster information]

web_console/web-console.adoc

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,14 @@ include::_attributes/common-attributes.adoc[]
77

88
toc::[]
99

10-
The {product-title} web console is a user interface accessible from a web browser.
11-
Developers can use the web console to visualize, browse, and manage the contents
12-
of projects.
10+
The {product-title} web console is a user interface accessible from a web browser. You can use the web console to visualize, browse, and manage the contents of projects.
1311

1412
== Prerequisites
1513

16-
* JavaScript must be enabled to use the web console. For the best experience, use
17-
a web browser that supports
18-
link:http://caniuse.com/#feat=websockets[WebSockets].
19-
* Review the link:https://access.redhat.com/articles/4128421[OpenShift Container
20-
Platform 4.x Tested Integrations] page before you create the supporting
21-
infrastructure for your cluster.
14+
* You must use one of the following supported web browsers: Edge, Chrome, Safari, or Mozilla Firefox. IE 11 and earlier is not supported.
15+
* 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.
2216

2317
include::modules/web-console-overview.adoc[leveloffset=+1]
24-
// include::modules/multi-cluster-about.adoc[leveloffset=+1]
25-
//include::modules/enabling-multi-cluster-console.adoc[leveloffset=+2]
2618

2719
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
2820
[role="_additional-resources"]

0 commit comments

Comments
 (0)