Skip to content

Commit da4f51f

Browse files
committed
OSDOCS-14988
1 parent e97f0d7 commit da4f51f

40 files changed

+327
-42
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Topics:
208208
File: web-console-overview
209209
- Name: Accessing the web console
210210
File: web-console
211-
- Name: Viewing cluster information
211+
- Name: Using the OpenShift Container Platform dashboard to get cluster information
212212
File: using-dashboard-to-get-cluster-information
213213
- Name: Adding user preferences
214214
File: adding-user-preferences
@@ -222,6 +222,8 @@ Topics:
222222
File: dynamic-plugins-get-started
223223
- Name: Deploy your plugin on a cluster
224224
File: deploy-plugin-cluster
225+
- Name: Content Security Policy
226+
File: content-security-policy
225227
- Name: Dynamic plugin example
226228
File: dynamic-plugin-example
227229
- Name: Dynamic plugin reference
@@ -241,6 +243,9 @@ Topics:
241243
- Name: About quick start tutorials
242244
File: creating-quick-start-tutorials
243245
Distros: openshift-rosa-hcp
246+
- Name: Optional capabilities and products
247+
File: capabilities_products-web-console
248+
Distros: openshift-rosa-hcp
244249
---
245250
Name: CLI tools
246251
Dir: cli_reference

modules/about-administrator_web-console.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@
88

99
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

11+
ifndef::openshift-rosa-hcp[]
1112
Cluster administrators can also open an embedded command-line terminal instance with the web terminal Operator in {product-title} 4.7 and later.
13+
endif::openshift-rosa-hcp[]
14+
ifdef::openshift-rosa-hcp[]
15+
Cluster administrators can also open an embedded command-line terminal instance with the web terminal Operator.
16+
endif::openshift-rosa-hcp[]
1217

1318
The *Administrator* perspective provides workflows specific to administrator use cases, such as the ability to:
1419

modules/about-developer_web-console.adoc

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,30 @@ The developer role in the web console offers several built-in ways to deploy app
1313
* Share your project with others.
1414
* 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.
1515
16+
ifndef::openshift-rosa-hcp[]
1617
Cluster administrators can also open an embedded command-line terminal instance in the web console in {product-title} 4.7 and later.
18+
endif::openshift-rosa-hcp[]
19+
ifdef::openshift-rosa-hcp[]
20+
Cluster developers can also open an embedded command-line terminal instance in the web console.
21+
endif::openshift-rosa-hcp[]
1722

1823
Developers have access to workflows specific to their use cases, such as the ability to:
1924

20-
* Create and deploy applications on {product-title} by importing existing codebases, images, and container files.
25+
* Create and deploy applications on
26+
ifndef::openshift-rosa-hcp,openshift-rosa[]
27+
{product-title}
28+
endif::openshift-rosa-hcp,openshift-rosa[]
29+
ifdef::openshift-rosa-hcp[]
30+
{rosa-short}
31+
endif::openshift-rosa-hcp[]
32+
ifdef::openshift-rosa[]
33+
{rosa-classic-short}
34+
endif::openshift-rosa[]
35+
by importing existing codebases, images, and container files.
2136
* Visually interact with applications, components, and services associated with them within a project and monitor their deployment and build status.
2237
* Group components within an application and connect the components within and across applications.
2338
* Integrate serverless capabilities (Technology Preview).
24-
* Create workspaces to edit your application code using Eclipse Che.
39+
* Create workspaces to edit their application code using Eclipse Che.
2540
2641
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.
2742

modules/adding-tab-pods-page.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,17 @@ There are different customizations you can make to the {product-title} web conso
1010

1111
[NOTE]
1212
====
13-
The {product-title} web console runs in a container connected to the cluster you have logged into. See "Dynamic plugin development" for information to test the plugin before creating your own.
13+
The
14+
ifndef::openshift-rosa-hcp,openshift-rosa[]
15+
{product-title}
16+
endif::openshift-rosa-hcp,openshift-rosa[]
17+
ifdef::openshift-rosa-hcp[]
18+
{rosa-short}
19+
endif::openshift-rosa-hcp[]
20+
ifdef::openshift-rosa[]
21+
{rosa-classic-short}
22+
endif::openshift-rosa[]
23+
web console runs in a container connected to the cluster you have logged into. See "Dynamic plugin development" for information to test the plugin before creating your own.
1424
====
1525

1626
.Procedure

modules/deployment-plug-in-cluster.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,18 @@ Where:
3434
`--set plugin.image=my-plugin-image-location`:: Specifies the location of the image within the `plugin.image` parameter.
3535
--
3636
+
37+
ifndef::openshift-rosa-hcp[]
3738
[NOTE]
3839
====
3940
If you are deploying on {product-title} 4.10 and later, it is recommended to exclude configurations related to pod security by adding the parameter `--set plugin.securityContext.enabled=false`.
4041
====
42+
endif::openshift-rosa-hcp[]
43+
ifdef::openshift-rosa-hcp[]
44+
[NOTE]
45+
====
46+
If you are deploying on {product-title}, it is recommended to exclude configurations related to pod security by adding the parameter `--set plugin.securityContext.enabled=false`.
47+
====
48+
endif::openshift-rosa-hcp[]
4149

4250
. Optional: You can specify any additional parameters by using the set of supported parameters in the `charts/openshift-console-plugin/values.yaml` file.
4351
+

modules/dynamic-plug-in-development.adoc

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,17 @@ You can run the plugin using a local development environment. The {product-title
1515
====
1616
Red{nbsp}Hat does not support custom plugin code. Only link:https://access.redhat.com/solutions/5893251[Cooperative community support] is available for your plugin.
1717
====
18-
* You must have an {product-title} cluster running.
18+
* You must have
19+
ifndef::openshift-rosa-hcp,openshift-rosa[]
20+
an {product-title}
21+
endif::openshift-rosa-hcp,openshift-rosa[]
22+
ifdef::openshift-rosa-hcp[]
23+
a {rosa-short}
24+
endif::openshift-rosa-hcp[]
25+
ifdef::openshift-rosa[]
26+
a {rosa-classic-short}
27+
endif::openshift-rosa[]
28+
cluster running.
1929
* You must have the {oc-first} installed.
2030
* You must have link:https://yarnpkg.com/[`yarn`] installed.
2131
* You must have link:https://www.docker.com/[Docker] v3.2.0 or later or link:https://podman.io/[Podman] v3.2.0 or later installed and running.
@@ -40,14 +50,34 @@ $ yarn install
4050
$ yarn run start
4151
----
4252

43-
. In another terminal window, login to the {product-title} through the CLI.
53+
. In another terminal window, login to the
54+
ifndef::openshift-rosa-hcp,openshift-rosa[]
55+
{product-title}
56+
endif::openshift-rosa-hcp,openshift-rosa[]
57+
ifdef::openshift-rosa-hcp[]
58+
{rosa-short}
59+
endif::openshift-rosa-hcp[]
60+
ifdef::openshift-rosa[]
61+
{rosa-classic-short}
62+
endif::openshift-rosa[]
63+
through the CLI.
4464
+
4565
[source,terminal]
4666
----
4767
$ oc login
4868
----
4969

50-
. Run the {product-title} web console in a container connected to the cluster you have logged into by running the following command:
70+
. Run the
71+
ifndef::openshift-rosa-hcp,openshift-rosa[]
72+
{product-title}
73+
endif::openshift-rosa-hcp,openshift-rosa[]
74+
ifdef::openshift-rosa-hcp[]
75+
{rosa-short}
76+
endif::openshift-rosa-hcp[]
77+
ifdef::openshift-rosa[]
78+
{rosa-classic-short}
79+
endif::openshift-rosa[]
80+
web console in a container connected to the cluster you have logged in to by running the following command:
5181
+
5282
[source,terminal]
5383
----

modules/dynamic-plugin-localization.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ The link:https://github.com/openshift/console-plugin-template[plugin template] d
1010

1111
.Prerequisites
1212
* You must have the plugin template cloned locally.
13-
* Optional: To test your plugin locally, run the {product-title} web console in a container. You can use either Docker or Podman 3.2.0 or later.
13+
* Optional: To test your plugin locally, run the
14+
{product-title} web console in a container. You can use either Docker or Podman 3.2.0 or later.
1415
1516
.Procedure
1617

modules/dynamic-plugin-proxy-service.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,17 @@ spec:
3939
+
4040
[NOTE]
4141
====
42-
If the service proxy request does not contain the logged-in user's {product-title} access token, set the authorization field to `None`.
42+
If the service proxy request does not contain the logged-in user's
43+
ifndef::openshift-rosa-hcp,openshift-rosa[]
44+
{product-title}
45+
endif::openshift-rosa-hcp,openshift-rosa[]
46+
ifdef::openshift-rosa-hcp[]
47+
{rosa-short}
48+
endif::openshift-rosa-hcp[]
49+
ifdef::openshift-rosa[]
50+
{rosa-classic-short}
51+
endif::openshift-rosa[]
52+
access token, set the authorization field to `None`.
4353
====
4454
<3> If the service uses a custom service CA, the `caCertificate` field must contain the certificate bundle.
4555
<4> Endpoint of the proxy.

modules/enabling-developer-perspective_web-console.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@
66
[id="enabling-developer-perspective_web-console_{context}"]
77
= Enabling the *Developer* perspective in the web console
88

9-
9+
ifndef::openshift-rosa-hcp[]
1010
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+
endif::openshift-rosa-hcp[]
12+
ifdef::openshift-rosa-hcp[]
13+
Cluster administrators can enable the *Developer* perspective for developers to use.
14+
endif::openshift-rosa-hcp[]
1115

1216
You can enable the *Developer* perspective with the following steps:
1317

modules/odc-access-web-terminal.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,14 @@ The web terminal remains open until you close it or until you close the browser
1212

1313
.Prerequisites
1414

15-
* You have access to an {product-title} cluster and are logged into the web console.
15+
* You have access to
16+
ifndef::openshift-rosa-hcp,openshift-rosa[]
17+
an {product-title}
18+
endif::openshift-rosa-hcp,openshift-rosa[]
19+
ifdef::openshift-rosa-hcp,openshift-rosa[]
20+
a {product-title}
21+
endif::openshift-rosa-hcp,openshift-rosa[]
22+
cluster and are logged into the web console.
1623
* The {web-terminal-op} is installed on your cluster.
1724
1825
.Procedure

0 commit comments

Comments
 (0)