Merge pull request #47809 from mpandya15/admin-dev-webconsole

ahardin-rh · web-flow · commit ce5cfe898d48 · 2022-08-03T18:25:10.000-04:00
[OSDOCS-2719] Adding the web console overview and Administrator perspective
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -612,6 +612,8 @@ Name: Web console
 Dir: web_console
 Distros: openshift-enterprise,openshift-origin,openshift-online
 Topics:
+- Name: Web console overview
+  File: web-console-overview
 - Name: Accessing the web console
   File: web-console
 - Name: Viewing cluster information
@@ -628,8 +630,6 @@ Topics:
 - Name: Dynamic plug-ins
   File: dynamic-plug-ins
   Distros: openshift-enterprise,openshift-origin
-- Name: Developer perspective
-  File: odc-about-developer-perspective
 - Name: Web terminal
   File: odc-about-web-terminal
   Distros: openshift-enterprise,openshift-online
diff --git a/applications/application-health.adoc b/applications/application-health.adoc
@@ -29,5 +29,5 @@ include::modules/odc-monitoring-health-checks.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* For details on switching to the *Developer* perspective in the web console, see xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[About *Developer* perspective].
+* For details on switching to the *Developer* perspective in the web console, see xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[About the *Developer* perspective].
 * For details on adding health checks while creating and deploying an application, see *Advanced Options* in the xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective] section.
diff --git a/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc b/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc
@@ -57,7 +57,6 @@ endif::[]
 To create applications using the *Developer* perspective ensure that:
 
 * You have xref:../../web_console/web-console.adoc#web-console[logged in to the web console].
-* You are in the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
 * You have created a project or have access to a project with the appropriate xref:../../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] to create applications and other workloads in {product-title}.
 
 ifdef::openshift-enterprise,openshift-webscale[]
diff --git a/applications/odc-editing-applications.adoc b/applications/odc-editing-applications.adoc
@@ -10,9 +10,10 @@ You can edit the configuration and the source code of the application you create
 
 == Prerequisites
 
-* You have xref:../web_console/web-console.adoc#web-console[logged in to the web console] and have switched to the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
+* You have xref:../web_console/web-console.adoc#web-console[logged in to the web console] and have switched to the xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[About the *Developer* perspective].
 * You have the appropriate xref:../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create and modify applications in {product-title}.
 * You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed an application on {product-title} using the *Developer* perspective].
+* You have xref:../web_console/web-console.adoc#web-console[logged in to the web console] and have switched to xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective].
 
 include::modules/odc-editing-source-code-using-developer-perspective.adoc[leveloffset=+1]
 
diff --git a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc
@@ -12,8 +12,8 @@ The *Observe* view in the *Developer* perspective provides options to monitor yo
 [id="prerequisites_odc-monitoring-project-and-application-metrics-using-developer-perspective"]
 == Prerequisites
 
-* You have xref:../web_console/web-console.adoc#web-console-overview[logged in to the web console] and have switched to the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
 * You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed applications on {product-title}].
+* You have xref:../web_console/web-console.adoc#web-console[logged in to the web console] and have switched to xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective].
 
 include::modules/odc-monitoring-your-project-metrics.adoc[leveloffset=+1]
 
diff --git a/applications/odc-viewing-application-composition-using-topology-view.adoc b/applications/odc-viewing-application-composition-using-topology-view.adoc
@@ -12,10 +12,9 @@ The *Topology* view in the *Developer* perspective of the web console provides a
 To view your applications in the *Topology* view and interact with them, ensure that:
 
 * You have xref:../web_console/web-console.adoc#web-console[logged in to the web console].
-* You are in the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
 * You have the appropriate xref:../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create applications and other workloads in {product-title}.
 * You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed an application on {product-title} using the *Developer* perspective].
-
+* You are in xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective].
 
 include::modules/odc-viewing-application-topology.adoc[leveloffset=+1]
 
diff --git a/applications/working_with_helm_charts/odc-working-with-helm-releases.adoc b/applications/working_with_helm_charts/odc-working-with-helm-releases.adoc
@@ -6,13 +6,12 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-
-You can use the *Developer* perspective in the web console to upgrade, rollback, or uninstall a Helm release.
-
+You can use the *Developer* perspective in the web console to update, rollback, or uninstall a Helm release.
 
 == Prerequisites
 
-* You have logged in to the web console and have switched to the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
+* You have logged in to the web console and have switched to xref:../../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective].
+
 
 include::modules/odc-upgrading-helm-release.adoc[leveloffset=+1]
 
diff --git a/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc b/cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc
@@ -1,5 +1,5 @@
 :_content-type: ASSEMBLY
-[id='working-with-pipelines-using-the-developer-perspective']
+[id="working-with-pipelines-using-the-developer-perspective"]
 = Working with {pipelines-title} using the Developer perspective
 include::_attributes/common-attributes.adoc[]
 :context: working-with-pipelines-using-the-developer-perspective
@@ -19,7 +19,7 @@ After you create the pipelines for your application, you can view and visually i
 [discrete]
 == Prerequisites
 
-* You have access to an {product-title} cluster and have switched to the xref:../../web_console/odc-about-developer-perspective.adoc[*Developer* perspective] in the web console.
+* You have access to an {product-title} cluster and have switched to xref:../../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective].
 * You have the xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines Operator installed] in your cluster.
 * You are a cluster administrator or a user with create and edit permissions.
 * You have created a project.
diff --git a/getting_started/openshift-overview.adoc b/getting_started/openshift-overview.adoc
@@ -41,8 +41,10 @@ Develop and deploy containerized applications with {product-title}. {product-tit
 * **xref:../applications/projects/working-with-projects.adoc#working-with-projects[Work with projects]**: Create projects from the {product-title} web console or OpenShift CLI (`oc`) to organize and share the software you develop.
 
 * **xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Work with applications]**:
-Use the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective] in the {product-title} web console to
+
+Use xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective] in the {product-title} web console to
 xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[create and deploy applications].
+
 Use the
 xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[*Topology* view]
 to see your applications, monitor status, connect and group components, and modify your code base.
diff --git a/modules/about-administrator-perspective.adoc b/modules/about-administrator-perspective.adoc
@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// web_console/web-console-overview.adoc
+
+:_content-type: CONCEPT
+[id="about-administrator-perspective_{context}"]
+= About the Administrator perspective in the web console
+
+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.
+
+Cluster administrators can also open an embedded command line terminal instance with the web terminal Operator in {product-title} 4.7 and later.
+
+[NOTE]
+====
+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.
+====
+
+The *Administrator* perspective provides workflows specific to administrator use cases, such as the ability to:
+
+* Manage workload, storage, networking, and cluster settings.
+* Install and manage Operators using the Operator Hub.
+* Add identity providers that allow users to log in and manage user access through roles and role bindings.
+* 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.
+* Access and manage monitoring features such as metrics, alerts, and monitoring dashboards.
+* View and manage logging, metrics, and high-status information about the cluster.
+* Visually interact with applications, components, and services associated with the *Administrator* perspective in {product-title}.
diff --git a/modules/about-developer-perspective.adoc b/modules/about-developer-perspective.adoc
@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// web_console/web-console-overview.adoc
+
+:_content-type: CONCEPT
+[id="about-developer-perspective_{context}"]
+= About the Developer perspective in the web console
+
+The *Developer* perspective offers several built-in ways to deploy applications, services, and databases. In the *Developer* perspective, you can:
+
+* View real-time visualization of rolling and recreating rollouts on the component.
+* View the application status, resource utilization, project event streaming, and quota consumption.
+* 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.
+
+Cluster administrators can also open an embedded command line terminal instance in the web console in {product-title} 4.7 and later.
+
+[NOTE]
+====
+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.
+====
+
+The *Developer* perspective provides workflows specific to developer use cases, such as the ability to:
+
+* Create and deploy applications on {product-title} 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.
diff --git a/modules/accessing-the-administrator-perspective.adoc b/modules/accessing-the-administrator-perspective.adoc
@@ -0,0 +1,13 @@
+// Module included in the following assemblies:
+//
+// web_console/about-administrator-perspective.adoc
+
+:_content-type: PROCEDURE
+[id="accessing-the-administrator-perspective_{context}"]
+= Accessing the Administrator perspective
+
+The *Administrator* perspective in the {product-title} web console provides workflows specific to administrator use cases. You can access the *Administrator* perspective from the web console as follows:
+
+.Procedure
+
+* Log in to the {product-title} web console using your login credentials to access the *Administrator* perspective.
diff --git a/modules/odc-accessing-developer-perspective.adoc b/modules/odc-accessing-developer-perspective.adoc
@@ -10,9 +10,11 @@ The *Developer* perspective in the {product-title} web console provides workflow
 
 You can access the *Developer* perspective from the web console as follows:
 
+.Prerequisites
+To access the *Developer* perspective, ensure that you have logged in to the web console. The default view for the {product-title} web console is the *Developer* perspective.
+
 .Procedure
 
-. Log in to the {product-title} web console using your login credentials. The default view for the {product-title} web console is the *Administrator* perspective.
 . Use the perspective switcher to switch to the *Developer* perspective. The *Topology* view with a list of all the projects in your cluster is displayed.
 +
 .Developer perspective
diff --git a/modules/odc-installing-helm-charts-using-developer-perspective.adoc b/modules/odc-installing-helm-charts-using-developer-perspective.adoc
@@ -5,7 +5,7 @@
 You can use either the *Developer* perspective in the web console or the CLI to select and install a chart from the Helm charts listed in the *Developer Catalog*. You can create Helm releases by installing Helm charts and see them in the *Developer* perspective of the web console.
 
 .Prerequisites
-* You have logged in to the web console and have switched to the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
+* You have logged in to the web console and have switched to xref:../../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective].
 
 .Procedure
 To create Helm releases from the Helm charts provided in the *Developer Catalog*:
diff --git a/web_console/odc-about-developer-perspective.adoc b/web_console/odc-about-developer-perspective.adoc
diff --git a/web_console/web-console-overview.adoc b/web_console/web-console-overview.adoc
@@ -0,0 +1,37 @@
+:_content-type: ASSEMBLY
+[id="web-console-overview"]
+= Web Console Overview
+include::_attributes/common-attributes.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. Both *Administrator* and *Developer* perspectives are supported.
+
+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.
+
+include::modules/about-administrator-perspective.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+See xref:../web_console/odc-about-web-terminal.adoc#odc-about-web-terminal[About the web terminal in the web console] for more information on the web terminal Operator.
+
+include::modules/accessing-the-administrator-perspective.adoc[leveloffset=+2]
+
+include::modules/about-developer-perspective.adoc[leveloffset=+1]
+include::modules/odc-accessing-developer-perspective.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../welcome/learn_more_about_openshift.adoc#cluster-administrator[Learn more about Cluster Administrator]
+* xref:../getting_started/openshift-overview.adoc#for-administrators[Overview of the *Administrator* perspective]
+* 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]
+* 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]
+* xref:../web_console/using-dashboard-to-get-cluster-information.adoc#using-dashboard-to-get-cluster-info[Viewing cluster information]
+* xref:../web_console/configuring-web-console.adoc#configuring-web-console[Configuring the web console]
+* xref:../web_console/customizing-the-web-console.adoc#customizing-web-console[Customizing the web console]
+* xref:../web_console/odc-about-web-terminal.adoc#odc-about-web-terminal[Launching an embedded command line terminal instance in the web console]
+* xref:../web_console/creating-quick-start-tutorials.adoc#creating-quick-start-tutorials[Creating quick start tutorials]
+* xref:../web_console/disabling-web-console.adoc#disabling-web-console[Disabling the web console]
diff --git a/welcome/index.adoc b/welcome/index.adoc
