mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-12145: Adds snippet about unified perspective
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
2d0aabc05d
commit
3e27ca9efa
@@ -6,7 +6,7 @@
|
||||
[id="adding-to-a-project_{context}"]
|
||||
= Adding to a project
|
||||
|
||||
You can add items to your project by using the *+Add* page in the *Developer* perspective.
|
||||
You can add items to your project by using the *+Add* page.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
@@ -14,7 +14,7 @@ You can add items to your project by using the *+Add* page in the *Developer* pe
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Developer* perspective, navigate to the *+Add* page.
|
||||
. Navigate to the *+Add* page.
|
||||
|
||||
. Select your project from the *Project* menu.
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ You can include one or more probes in the specification for the pod that contain
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you want to add or edit health checks in an existing pod, you must edit the pod `DeploymentConfig` object or use the *Developer* perspective in the web console. You cannot use the CLI to add or edit health checks for an existing pod.
|
||||
If you want to add or edit health checks in an existing pod, you must edit the pod `DeploymentConfig` object or use the web console. You cannot use the CLI to add or edit health checks for an existing pod.
|
||||
====
|
||||
|
||||
Readiness probe::
|
||||
|
||||
@@ -10,7 +10,7 @@ To configure readiness, liveness, and startup probes, add one or more probes to
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you want to add or edit health checks in an existing pod, you must edit the pod `DeploymentConfig` object or use the *Developer* perspective in the web console. You cannot use the CLI to add or edit health checks for an existing pod.
|
||||
If you want to add or edit health checks in an existing pod, you must edit the pod `DeploymentConfig` object or use the web console. You cannot use the CLI to add or edit health checks for an existing pod.
|
||||
====
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[id="builds-basic-edit-buildconfig_{context}"]
|
||||
= Editing a BuildConfig
|
||||
|
||||
To edit your build configurations, you use the *Edit BuildConfig* option in the *Builds* view of the *Developer* perspective.
|
||||
To edit your build configurations, you use the *Edit BuildConfig* option in the *Builds* page.
|
||||
|
||||
You can use either of the following views to edit a `BuildConfig`:
|
||||
|
||||
@@ -16,7 +16,7 @@ You can switch between the *Form view* and *YAML view* without losing any data.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Builds* view of the *Developer* perspective, click the Options menu {kebab} to see the *Edit BuildConfig* option.
|
||||
. On the *Builds* page, click the Options menu {kebab} to see the *Edit BuildConfig* option.
|
||||
. Click *Edit BuildConfig* to see the *Form view* option.
|
||||
. In the *Git* section, enter the Git repository URL for the codebase you want to use to create an application. The URL is then validated.
|
||||
* Optional: Click *Show Advanced Git Options* to add details such as:
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
{product-title} provides a comprehensive set of monitoring dashboards that help you understand the state of cluster components.
|
||||
|
||||
In the *Administrator* perspective, you can access dashboards for core {product-title} components, including:
|
||||
As an administrator, you can access dashboards for core {product-title} components, including:
|
||||
|
||||
* etcd
|
||||
|
||||
@@ -29,7 +29,7 @@ image::monitoring-dashboard-compute-resources.png[]
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Administrator* perspective in the {product-title} web console, navigate to *Observe* -> *Dashboards*.
|
||||
. As a cluster administrator in the {product-title} web console, navigate to *Observe* -> *Dashboards*.
|
||||
|
||||
. Choose a dashboard in the *Dashboard* list. Some dashboards, such as the *etcd* dashboard, produce additional sub-menus when selected.
|
||||
|
||||
|
||||
@@ -14,12 +14,6 @@ You can review the status of your project by using the web console.
|
||||
|
||||
.Procedure
|
||||
|
||||
** If you are using the *Administrator* perspective:
|
||||
.. Navigate to *Home* -> *Projects*.
|
||||
.. Select a project from the list.
|
||||
.. Review the project status in the *Overview* page.
|
||||
|
||||
** If you are using the *Developer* perspective:
|
||||
.. Navigate to the *Project* page.
|
||||
.. Select a project from the *Project* menu.
|
||||
.. Review the project status in the *Overview* page.
|
||||
. Navigate to *Home* -> *Projects*.
|
||||
. Select a project from the list.
|
||||
. Review the project status in the *Overview* page.
|
||||
|
||||
@@ -13,7 +13,6 @@ You can set the default user preferences for your cluster.
|
||||
. Use the masthead to access the user preferences under the user profile.
|
||||
. In the *General* section:
|
||||
.. In the **Theme** field, you can set the theme that you want to work in. The console defaults to the selected theme each time you log in.
|
||||
.. In the *Perspective* field, you can set the default perspective you want to be logged in to. You can select the *Administrator* or the *Developer* perspective as required. If a perspective is not selected, you are logged into the perspective you last visited.
|
||||
.. In the *Project* field, select a project you want to work in. The console defaults to the project every time you log in.
|
||||
.. In the *Topology* field, you can set the topology view to default to the graph or list view. If not selected, the console defaults to the last view you used.
|
||||
.. In the *Create/Edit resource method* field, you can set a preference for creating or editing a resource. If both the form and YAML options are available, the console defaults to your selection.
|
||||
|
||||
@@ -25,20 +25,13 @@ You can access installed applications from the web console by clicking **Operato
|
||||
[id="marketplace-deploy_{context}"]
|
||||
== Deploy applications from different perspectives
|
||||
|
||||
You can deploy Marketplace applications from the web console's Administrator and Developer perspectives.
|
||||
|
||||
[discrete]
|
||||
=== The Developer perspective
|
||||
|
||||
Developers can access newly installed capabilities by using the Developer perspective.
|
||||
Developers can access newly installed capabilities and deploy Marketplace applications from the web console.
|
||||
|
||||
For example, after a database Operator is installed, a developer can create an instance from the catalog within their project. Database usage is aggregated and reported to the cluster administrator.
|
||||
|
||||
This perspective does not include Operator installation and application usage tracking.
|
||||
Cluster administrators can access Operator installation and application usage information. They can also launch application instances by browsing custom resource definitions (CRDs) in the *Installed Operators* list.
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
[discrete]
|
||||
=== The Administrator perspective
|
||||
|
||||
Cluster administrators can access Operator installation and application usage information from the Administrator perspective.
|
||||
|
||||
They can also launch application instances by browsing custom resource definitions (CRDs) in the *Installed Operators* list.
|
||||
@@ -10,15 +10,15 @@ You can uninstall the web terminal by removing the {web-terminal-op} and custom
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have access to an {product-title} cluster with cluster administrator permissions.
|
||||
* You have access to the {product-title} web console as a user with the `cluster-admin` role.
|
||||
* You have installed the `oc` CLI.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Administrator* perspective of the web console, navigate to *Operators -> Installed Operators*.
|
||||
. In the web console, navigate to *Operators -> Installed Operators*.
|
||||
. Scroll the filter list or type a keyword into the *Filter by name* box to find the {web-terminal-op}.
|
||||
. Click the Options menu {kebab} for the {web-terminal-op}, and then select *Uninstall Operator*.
|
||||
. In the *Uninstall Operator* confirmation dialog box, click *Uninstall* to remove the Operator, Operator deployments, and pods from the cluster. The Operator stops running and no longer receives updates.
|
||||
// Removed steps, as they are in the following module.
|
||||
// Removed steps, as they are in the following module.
|
||||
|
||||
// TODO: Add a verification section
|
||||
|
||||
@@ -30,6 +30,6 @@ You can review the following information in the *Overview* page in the {product-
|
||||
|
||||
.Procedure
|
||||
|
||||
* In the *Administrator* perspective, navigate to *Home* -> *Overview*.
|
||||
* Navigate to *Home* -> *Overview*.
|
||||
|
||||
|
||||
|
||||
@@ -9,10 +9,10 @@
|
||||
The web console provides a quick start with instructions on how to install the {rh-dev-hub} Operator.
|
||||
|
||||
.Prerequisites
|
||||
* You must be logged in to the {product-title} web console with `admin` privileges.
|
||||
* You must be logged in to the {product-title} web console with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
. On the *Overview* page of the Administrator perspective, click *Install {rh-dev-hub} (RHDH) with an Operator* in the *Getting started resources* tile.
|
||||
. On the *Overview* page, click *Install {rh-dev-hub} (RHDH) with an Operator* in the *Getting started resources* tile.
|
||||
. A quick start pane is displayed with instructions for you to install the {rh-dev-hub} with an Operator. Follow the quick start for instructions on how to install the Operator, create a {rh-dev-hub} instance, and add your instance to the *OpenShift Console Application* menu.
|
||||
|
||||
.Verification
|
||||
|
||||
@@ -11,7 +11,7 @@ You can install the {rhq-cso} from the {product-title} web console Operator Hub,
|
||||
.Prerequisites
|
||||
|
||||
* You have installed the `oc` CLI.
|
||||
* You have administrator privileges to the {product-title} cluster.
|
||||
* You have access to the web console as a user with `cluster-admin` privileges.
|
||||
* You have containers that come from a Red Hat Quay or Quay.io registry running on your cluster.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You must have `admin` privileges.
|
||||
* You must have `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You must have `admin` privileges.
|
||||
* You must have access to the web console as a user with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ To remove the Security Profiles Operator, you must first delete the `seccomp` an
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Access to an {product-title} cluster that uses an account with `cluster-admin` permissions.
|
||||
* You have access to the web console as a user with `cluster-admin` privileges.
|
||||
* The Security Profiles Operator is installed.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -14,7 +14,7 @@ persistent volumes.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the {product-title} console, click *Storage* -> *Storage Classes*.
|
||||
. In the {product-title} web console, click *Storage* -> *Storage Classes*.
|
||||
|
||||
. In the storage class overview, click *Create Storage Class*.
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
[role="_abstract"]
|
||||
.Procedure
|
||||
|
||||
. In the {product-title} console, click *Storage* -> *StorageClasses*.
|
||||
. In the {product-title} web console, click *Storage* -> *StorageClasses*.
|
||||
|
||||
. On the *StorageClasses* page, click *Create StorageClass*.
|
||||
|
||||
|
||||
@@ -11,10 +11,9 @@ a volume in {product-title}.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the {product-title} console, click *Storage* -> *Persistent Volume Claims*.
|
||||
. In the {product-title} web console, click *Storage* -> *Persistent Volume Claims*.
|
||||
|
||||
. In the persistent volume claims overview, click *Create Persistent Volume
|
||||
Claim*.
|
||||
. In the persistent volume claims overview, click *Create Persistent Volume Claim*.
|
||||
|
||||
. Define the desired options on the page that appears.
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ to mount the underlying EFS storage.
|
||||
|
||||
.Procedure (UI)
|
||||
|
||||
. In the {product-title} console, click *Storage* -> *Persistent Volume Claims*.
|
||||
. In the {product-title} web console, click *Storage* -> *Persistent Volume Claims*.
|
||||
|
||||
. In the persistent volume claims overview, click *Create Persistent Volume
|
||||
Claim*.
|
||||
|
||||
@@ -4,16 +4,13 @@
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="templates-creating-from-console_{context}"]
|
||||
= Creating an application by using the web console
|
||||
= Creating an application by using the web console
|
||||
|
||||
You can use the web console to create an application from a template.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Select *Developer* from the context selector at the top of the web console
|
||||
navigation menu.
|
||||
|
||||
. While in the desired project, click *+Add*
|
||||
. Navigate to your project and click *+Add*
|
||||
|
||||
. Click *All services* in the *Developer Catalog* tile.
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Refer to this list of troubleshooting tips if you run into issues loading your p
|
||||
$ oc get console.operator.openshift.io cluster -o jsonpath='{.spec.plugins}'
|
||||
----
|
||||
|
||||
** Verify the enabled plugins on the status card of the *Overview* page in the *Administrator* perspective. You must refresh your browser if the plugin was recently enabled.
|
||||
** Verify the enabled plugins on the status card of the *Overview* page. You must refresh your browser if the plugin was recently enabled.
|
||||
|
||||
* Verify your plugin service is healthy by:
|
||||
** Verifying your plugin pod status is running and your containers are ready.
|
||||
|
||||
@@ -10,8 +10,7 @@ You can stop aggregating logs by deleting the {clo} and the `ClusterLogging` cus
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have administrator permissions.
|
||||
* You have access to the *Administrator* perspective of the {product-title} web console.
|
||||
* Have access to the {product-title} web console as a user with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
.Prerequisites
|
||||
|
||||
* You have administrator permissions.
|
||||
* You have access to the *Administrator* perspective of the {product-title} web console.
|
||||
* Have access to the {product-title} web console as a user with `cluster-admin` privileges.
|
||||
* If you have not already removed the {clo} and related resources, you must remove references to Elasticsearch from the `ClusterLogging` custom resource.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -12,7 +12,7 @@ If you do not want to keep the PVCs, you can delete them. If you want to recover
|
||||
.Prerequisites
|
||||
|
||||
* You have administrator permissions.
|
||||
* You have access to the *Administrator* perspective of the {product-title} web console.
|
||||
* Have access to the {product-title} web console as a user with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
.Prerequisites
|
||||
|
||||
* You have administrator permissions.
|
||||
* You have access to the *Administrator* perspective of the {product-title} web console.
|
||||
* You have access to the {product-title} web console with `cluster-admin` privleges.
|
||||
* If you have not already removed the {clo} and related resources, you have removed references to LokiStack from the `ClusterLogging` custom resource.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -9,6 +9,7 @@
|
||||
.Prerequisites
|
||||
|
||||
* Verify that machine config pools are unpaused.
|
||||
* Have access to the {product-title} web console as a user with `cluster-admin` privileges.
|
||||
* Update the OpenShift CLI (`oc`) to the target version before each update.
|
||||
|
||||
[IMPORTANT]
|
||||
@@ -18,7 +19,7 @@ It is highly discouraged to skip this prerequisite. If the OpenShift CLI (`oc`)
|
||||
|
||||
.Procedure
|
||||
|
||||
. Using the Administrator perspective on the web console, update any Operator Lifecycle Manager (OLM) Operators to the versions that are compatible with your intended updated version. You can find more information on how to perform this action in "Updating installed Operators"; see "Additional resources".
|
||||
. Using the web console, update any Operator Lifecycle Manager (OLM) Operators to the versions that are compatible with your intended updated version. You can find more information on how to perform this action in "Updating installed Operators"; see "Additional resources".
|
||||
|
||||
. Verify that all machine config pools display a status of `UPDATED` and that no machine config pool displays a status of `UPDATING`.
|
||||
To view the status of all machine config pools, run the following command:
|
||||
|
||||
@@ -9,11 +9,11 @@
|
||||
.Prerequisites
|
||||
|
||||
* Verify that machine config pools are unpaused.
|
||||
* Have access to the web console as a user with `admin` privileges.
|
||||
* Have access to the web console as a user with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Using the Administrator perspective on the web console, update any Operator Lifecycle Manager (OLM) Operators to the versions that are compatible with your intended updated version. You can find more information on how to perform this action in "Updating installed Operators"; see "Additional resources".
|
||||
. Using the web console, update any Operator Lifecycle Manager (OLM) Operators to the versions that are compatible with your intended updated version. You can find more information on how to perform this action in "Updating installed Operators"; see "Additional resources".
|
||||
|
||||
. Verify that all machine config pools display a status of `Up to date` and that no machine config pool displays a status of `UPDATING`.
|
||||
+
|
||||
|
||||
@@ -8,9 +8,11 @@
|
||||
|
||||
You can view the projects that you have access to by using the {product-title} web console.
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
.Procedure
|
||||
|
||||
** If you are using the *Administrator* perspective:
|
||||
** If you are logged in as an administrator:
|
||||
.. Navigate to *Home* -> *Projects* in the navigation menu.
|
||||
.. Select a project to view. The *Overview* tab includes a dashboard for your project.
|
||||
.. Select the *Details* tab to view the project details.
|
||||
@@ -18,9 +20,9 @@ You can view the projects that you have access to by using the {product-title} w
|
||||
.. Select the *Workloads* tab to see workloads in the project.
|
||||
.. Select the *RoleBindings* tab to view and create role bindings for your project.
|
||||
|
||||
** If you are using the *Developer* perspective:
|
||||
** If you are logged in as a developer:
|
||||
.. Navigate to the *Project* page in the navigation menu.
|
||||
.. Select *All Projects* from the *Project* drop-down menu at the top of the screen to list all of the projects in your cluster.
|
||||
.. Select a project to view. The *Overview* tab includes a dashboard for your project.
|
||||
.. Select a project to view.
|
||||
.. Select the *Details* tab to view the project details.
|
||||
.. If you have adequate permissions for a project, select the **Project access** tab view and update the privileges for the project.
|
||||
.. If you have adequate permissions for a project, select the **Project access** tab view and update the privileges for the project.
|
||||
@@ -13,7 +13,7 @@ The Kubernetes NMState Operator, `kubernetes-nmstate-operator`, can collect metr
|
||||
The `kubernetes_nmstate_features_applied` metrics are not an API and might change between {product-title} versions.
|
||||
====
|
||||
|
||||
In the *Developer* and *Administrator* perspectives, the Metrics UI includes some predefined CPU, memory, bandwidth, and network packet queries for the selected project. You can run custom Prometheus Query Language (PromQL) queries for CPU, memory, bandwidth, network packet and application metrics for the project.
|
||||
In the web console, the Metrics UI includes some predefined CPU, memory, bandwidth, and network packet queries for the selected project. You can run custom Prometheus Query Language (PromQL) queries for CPU, memory, bandwidth, network packet and application metrics for the project.
|
||||
|
||||
The following example demonstrates a `NodeNetworkConfigurationPolicy` manifest example that is applied to an {product-title} cluster:
|
||||
|
||||
@@ -58,6 +58,8 @@ kubernetes_nmstate_features_applied{name="dhcpv4-custom-hostname"} 1
|
||||
* You have deployed a service in a user-defined project.
|
||||
* You have created a `NodeNetworkConfigurationPolicy` manifest and applied it to your cluster.
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
.Procedure
|
||||
|
||||
. If you want to view the metrics from the *Developer* perspective in the {product-title} web console, complete the following tasks:
|
||||
@@ -72,10 +74,10 @@ kubernetes_nmstate_features_applied{name="dhcpv4-custom-hostname"} 1
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
In the *Developer* perspective, you can only run one query at a time.
|
||||
You can only run one query at a time with the developer role.
|
||||
====
|
||||
|
||||
. If you want to view the metrics from the *Administrator* perspective in the {product-title} web console, complete the following tasks:
|
||||
. If you want to view the metrics in the {product-title} web console as an administrator, complete the following tasks:
|
||||
+
|
||||
.. Click *Observe* -> *Metrics*.
|
||||
+
|
||||
|
||||
18
snippets/unified-perspective-web-console.adoc
Normal file
18
snippets/unified-perspective-web-console.adoc
Normal file
@@ -0,0 +1,18 @@
|
||||
// Snippet included in the following assemblies and modules:
|
||||
//
|
||||
// * getting-started/openshift-overview.adoc
|
||||
// * web_console/web-console-overview.adoc
|
||||
// * modules/viewing-stats-collected-kubernetes-nmstate-op.adoc
|
||||
// * modules/viewing-a-project-using-the-web-console.adoc
|
||||
// * modules/red-hat-marketplace-features.adoc
|
||||
|
||||
:_mod-docs-content-type: SNIPPET
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Starting with {product-title} 4.19, the perspectives in the web console have unified. The *Developer* perspective is no longer enabled by default.
|
||||
|
||||
All users can interact with all {product-title} web console features. However, if you are not the cluster owner, you might need to request permission to certain features from the cluster owner.
|
||||
|
||||
You can still enable the *Developer* perspective. On the *Getting Started* pane in the web console, you can take a tour of the console, find information on setting up your cluster, view a quick start for enabling the *Developer* perspective, and follow links to explore new features and capabilities.
|
||||
====
|
||||
Reference in New Issue
Block a user