Skip to content

Commit 4ec8428

Browse files
author
Michael Burke
committed
Web console docs fixes during ROSA review
1 parent ab019c0 commit 4ec8428

12 files changed

+72
-52
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,7 @@ Topics:
741741
File: web-console-overview
742742
- Name: Accessing the web console
743743
File: web-console
744-
- Name: Viewing cluster information
744+
- Name: Using the OpenShift Container Platform dashboard to get cluster information
745745
File: using-dashboard-to-get-cluster-information
746746
- Name: Adding user preferences
747747
File: adding-user-preferences

modules/customizing-cli-downloads.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ the packages.
2727
apiVersion: console.openshift.io/v1
2828
kind: ConsoleCLIDownload
2929
metadata:
30-
name: example-cli-download-links-for-foo
30+
name: example-cli-download-links
3131
spec:
3232
description: |
33-
This is an example of download links for foo
34-
displayName: example-foo
33+
This is an example of download links
34+
displayName: example
3535
links:
36-
- href: 'https://www.example.com/public/foo.tar'
37-
text: foo for linux
38-
- href: 'https://www.example.com/public/foo.mac.zip'
39-
text: foo for mac
40-
- href: 'https://www.example.com/public/foo.win.zip'
41-
text: foo for windows
36+
- href: 'https://www.example.com/public/example.tar'
37+
text: example for linux
38+
- href: 'https://www.example.com/public/example.mac.zip'
39+
text: example for mac
40+
- href: 'https://www.example.com/public/example.win.zip'
41+
text: example for windows
4242
----
4343

4444
. Click the *Save* button.

modules/customizing-the-login-page.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ $ oc edit oauths cluster
6868
+
6969
[source,yaml]
7070
----
71+
apiVersion: config.openshift.io/v1
72+
kind: OAuth
73+
metadata:
74+
name: cluster
75+
# ...
7176
spec:
7277
templates:
7378
error:

modules/odc-access-web-terminal.adoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="odc-access-web-terminal_{context}"]
77
= Accessing the web terminal
88

9-
After the {web-terminal-op} is installed, you can access the web terminal.
9+
After the {web-terminal-op} is installed, you can access the web terminal. After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx` in the web terminal.
1010
You can re-run commands by selecting them from the list of commands you have run in the terminal. These commands persist across multiple terminal sessions.
1111
The web terminal remains open until you close it or until you close the browser window or tab.
1212

@@ -19,16 +19,27 @@ The web terminal remains open until you close it or until you close the browser
1919

2020
. To launch the web terminal, click the command line terminal icon (image:odc-wto-icon.png[title="wto icon"]) in the masthead of the console. A web terminal instance is displayed in the *Command line terminal* pane. This instance is automatically logged in with your credentials.
2121

22-
. Select the project where the `DevWorkspace` CR must be created from the *Project* drop-down list. By default, the current project is selected.
22+
. If a project has not been selected in the current session, select the project where the `DevWorkspace` CR must be created from the *Project* drop-down list. By default, the current project is selected.
2323
+
2424
[NOTE]
2525
====
2626
* The `DevWorkspace` CR is created only if it does not already exist.
2727
ifndef::openshift-rosa,openshift-dedicated[]
28-
* The `openshift-terminal` project is the default project used for cluster administrators. They do not have the option to choose another project.
28+
* The `openshift-terminal` project is the default project used for cluster administrators. They do not have the option to choose another project. The {web-terminal-op} installs the DevWorkspace Operator as a dependency.
2929
endif::openshift-rosa,openshift-dedicated[]
3030
====
3131
32-
. Click *Start* to initialize the web terminal using the selected project. After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx` in the web terminal.
32+
ifndef::openshift-rosa,openshift-dedicated[]
33+
. Optional: Set the web terminal timeout for the current session:
34+
.. Click Timeout.
35+
.. In the field that appears, enter the timeout value.
36+
.. From the drop-down list, select a timeout interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*.
37+
38+
. Optional: Select a custom image for the web terminal to use.
39+
.. Click Image.
40+
.. In the field that appears, enter the URL of the image that you want to use.
41+
endif::openshift-rosa,openshift-dedicated[]
42+
43+
. Click *Start* to initialize the web terminal using the selected project.
3344

3445
. Click *+* to open multiple tabs within the web terminal in the console.

modules/odc-configure-web-terminal-timeout-session.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ You can change the default timeout period for the web terminal for your current
1717
.Procedure
1818

1919
. Click the web terminal icon (image:odc-wto-icon.png[title="web terminal icon"]).
20-
. Click *Timeout* to display advanced configuration options for the web terminal timeout.
21-
. Set a value for the timeout. From the drop-down list, select a time interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*.
22-
. Click *Start* to begin a terminal instance using the specified timeout setting.
20+
. Optional: Set the web terminal timeout for the current session:
21+
.. Click Timeout.
22+
.. In the field that appears, enter the timeout value.
23+
.. From the drop-down list, select a timeout interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*.
24+
. Optional: Select a custom image for the web terminal to use.
25+
.. Click Image.
26+
.. In the field that appears, enter the URL of the image that you want to use.
27+
. Click *Start* to begin a terminal instance using the specified timeout setting.

modules/odc-setting-user-preferences.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ You can set the default user preferences for your cluster.
1212
. Log in to the {product-title} web console using your login credentials.
1313
. Use the masthead to access the user preferences under the user profile.
1414
. In the *General* section:
15+
.. 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.
1516
.. 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.
16-
.. In the *Project* field, select a project you want to work in. The console will default to the project every time you log in.
17+
.. In the *Project* field, select a project you want to work in. The console defaults to the project every time you log in.
1718
.. 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.
1819
.. 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.
1920
. In the *Language* section, select *Default browser language* to use the default browser language settings. Otherwise, select the language that you want to use for the console.
21+
. In the *Notifications* section, you can toggle display notifications created by users for specific projects on the *Overview* page or notification drawer.
2022
. In the *Applications* section:
2123
.. You can view the default *Resource type*. For example, if the {ServerlessOperatorName} is installed, the default resource type is *Serverless Deployment*. Otherwise, the default resource type is *Deployment*.
2224
.. You can select another resource type to be the default resource type from the *Resource Type* field.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
// * web_console/using-dashboard-to-get-cluster-information.adoc
3+
4+
:_mod-docs-content-type: CONCEPT
5+
[id="recognize-resource-limits-quotas"]
6+
= Recognizing resource and project limits and quotas
7+
8+
You can view a graphical representation of available resources in the *Topology* view of the web console *Developer* perspective.
9+
10+
If a resource has a message about resource limitations or quotas being reached, a yellow border appears around the resource name. Click the resource to open a side panel to see the message. If the *Topology* view has been zoomed out, a yellow dot indicates that a message is available.
11+
12+
If you are using *List View* from the *View Shortcuts* menu, resources appear as a list. The *Alerts* column indicates if a message is available.

modules/removing-web-terminal-operator.adoc

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,6 @@ You can uninstall the web terminal by removing the {web-terminal-op} and custom
1919
. Scroll the filter list or type a keyword into the *Filter by name* box to find the {web-terminal-op}.
2020
. Click the Options menu {kebab} for the {web-terminal-op}, and then select *Uninstall Operator*.
2121
. 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.
22-
. Remove the custom resources:
23-
+
24-
[source,terminal]
25-
----
26-
$ oc delete devworkspaces.workspace.devfile.io --all-namespaces \
27-
--selector 'console.openshift.io/terminal=true' --wait
28-
----
29-
+
30-
[source,terminal]
31-
----
32-
$ oc delete devworkspacetemplates.workspace.devfile.io --all-namespaces \
33-
--selector 'console.openshift.io/terminal=true' --wait
34-
----
22+
// Removed steps, as they are in the following module.
3523

36-
// TODO: Add a verification section
24+
// TODO: Add a verification section

modules/virt-about-the-overview-dashboard.adoc

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
[id="virt-about-the-overview-dashboard_{context}"]
77
= About the {product-title} dashboards page
88

9+
Access the {product-title} dashboard, which captures high-level information
10+
about the cluster, by navigating to *Home* -> *Overview* from
11+
the {product-title} web console.
12+
13+
The {product-title} dashboard provides various cluster information, captured in
14+
individual dashboard cards.
15+
916
The {product-title} dashboard consists of the following cards:
1017

1118
* *Details* provides a brief overview of informational cluster details.
@@ -19,13 +26,13 @@ Status include *ok*, *error*, *warning*, *in progress*, and *unknown*. Resources
1926
** Number of nodes
2027
** Number of pods
2128
** Persistent storage volume claims
22-
** Bare metal hosts in the cluster, listed according to their state (only available in *metal3* environment).
23-
* *Cluster Capacity* charts help administrators understand when additional resources are required in the cluster. The charts contain an inner ring that displays current consumption, while an outer ring displays thresholds configured for the resource, including information about:
29+
** Bare metal hosts in the cluster, listed according to their state (only available in *metal3* environment)
30+
* *Status* helps administrators understand how cluster resources are consumed. Click on a resource to jump to a detailed page listing pods and nodes that consume the largest amount of the specified cluster resource (CPU, memory, or storage).
31+
* *Cluster Utilization* shows the capacity of various resources over a specified period of time, to help administrators understand the scale and frequency of high resource consumption, including information about:
2432
** CPU time
2533
** Memory allocation
2634
** Storage consumed
2735
** Network resources consumed
28-
* *Cluster Utilization* shows the capacity of various resources over a specified period of time, to help administrators understand the scale and frequency of high resource consumption.
29-
* *Events* lists messages related to recent activity in the cluster, such as pod creation or virtual machine migration to another host.
30-
* *Top Consumers* helps administrators understand how cluster resources are consumed. Click on a resource to jump to a detailed page listing pods and nodes that consume the largest amount of the specified cluster resource (CPU, memory, or storage).
36+
** Pod count
37+
* *Activity* lists messages related to recent activity in the cluster, such as pod creation or virtual machine migration to another host.
3138

web_console/configuring-web-console.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
You can modify the {product-title} web console to set a logout redirect URL
10-
or disable the console.
10+
or disable the quick start tutorials.
1111

1212
== Prerequisites
1313

0 commit comments

Comments
 (0)