Skip to content

OSDOCS-14988: Read Through of "Web Console" book for HCP migration #94986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OSDOCS-14988: Read Through of "Web Console" book for HCP migration #94986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions modules/about-administrator_web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
16 changes: 14 additions & 2 deletions modules/about-developer_web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,27 @@ 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[]
{product-title}
endif::openshift-rosa-hcp[]
ifdef::openshift-rosa-hcp[]
{hcp-title}
endif::openshift-rosa-hcp[]
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.

Expand Down
6 changes: 5 additions & 1 deletion modules/enabling-developer-perspective_web-console.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
11 changes: 10 additions & 1 deletion web_console/web-console-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,18 @@ 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.

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[]
{product-title}
endif::openshift-rosa-hcp[]
ifdef::openshift-rosa-hcp[]
{hcp-title}
endif::openshift-rosa-hcp[]
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]
Expand Down