Skip to content

Commit db071e1

Browse files
committed
apply Keith's review comments
Signed-off-by: Atif Ali <atali@redhat.com>
1 parent 944b079 commit db071e1

9 files changed

Lines changed: 39 additions & 28 deletions

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The GitOps Console plugin extends the OpenShift Container Platform web console by adding GitOps resources. The plugin is available as part of the Red Hat OpenShift GitOps Operator and provides a console UI for managing Argo CD and Argo Rollouts custom resources.
44

5-
After you install the Red Hat OpenShift GitOps Operator, the OpenShift web console displays a **GitOps** navigation tab in the **Administrator** perspective. The plugin is enabled by default. The GitOps navigation tab replaces the previous **Environments** tab and related pages in the **Developer** perspective.
5+
After you install the Red Hat OpenShift GitOps Operator, the OpenShift web console displays a **GitOps** navigation tab in the **Administrator** or **Core platform** perspective. The plugin is enabled by default. The GitOps navigation tab replaces the previous **Environments** tab and related pages in the **Developer** perspective.
66

77
The GitOps navigation tab provides access to the following Argo CD and Argo Rollouts resources:
88

@@ -14,7 +14,7 @@ The GitOps navigation tab provides access to the following Argo CD and Argo Roll
1414

1515
## Prerequisites
1616

17-
* You have access to OpenShift Container Platform 4.19 or later.
17+
* You have access to OpenShift Container Platform 4.18 or later.
1818
* You have installed the Red Hat OpenShift GitOps Operator.
1919

2020
## GitOps resources in the web console

docs/applications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The GitOps Console plugin provides list and details pages for Argo CD Applicatio
1414

1515
## Applications list page
1616

17-
1. In the **Administrator** perspective, navigate to **GitOps****Applications**.
17+
1. In the **Administrator** or **Core platform** perspective, navigate to **GitOps****Applications**.
1818

1919
2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects to view Applications across namespaces.
2020

docs/applicationsets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The GitOps Console plugin shows list and details pages for Argo CD ApplicationSe
1010

1111
## List page
1212

13-
1. In the **Administrator** perspective, navigate to **GitOps****ApplicationSets**.
13+
1. In the **Administrator** or **Core platform** perspective, navigate to **GitOps****ApplicationSets**.
1414

1515
2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects.
1616

docs/appprojects-rbac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The GitOps Console plugin provides list and details pages for Argo CD AppProject
1010

1111
## List page
1212

13-
1. In the **Administrator** perspective, navigate to **GitOps****AppProjects**.
13+
1. In the **Administrator** or **Core platform** perspective, navigate to **GitOps****AppProjects**.
1414

1515
2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects.
1616

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Use the OpenShift web console to install GitOps, enable the Console plugin, and
66

77
## Prerequisites
88

9-
* You have access to an OpenShift Container Platform 4.19 or later cluster.
9+
* You have access to an OpenShift Container Platform 4.18 or later cluster.
1010
* You can log in to the web console with cluster-admin permission to install the Operator and enable the plugin.
1111

1212
## Install the OpenShift GitOps Operator
@@ -29,7 +29,7 @@ If **GitOps** is already in the navigation, skip this step. Otherwise follow [En
2929

3030
## Open the GitOps pages
3131

32-
1. In the **Administrator** perspective, click **GitOps**.
32+
1. In the **Administrator** or **Core platform** perspective, click **GitOps**.
3333

3434
2. Verify that you can open the following pages:
3535

docs/image-updaters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The **ImageUpdaters** page is available when the ImageUpdater custom resource de
1313

1414
## List page
1515

16-
1. In the **Administrator** perspective, navigate to **GitOps****ImageUpdaters**.
16+
1. In the **Administrator** or **Core platform** perspective, navigate to **GitOps****ImageUpdaters**.
1717

1818
2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects.
1919

docs/rollouts.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# Rollouts in the GitOps Console
22

3-
The GitOps Console plugin provides list and details pages for Argo Rollouts in the OpenShift web console. You can search and filter Rollouts, create them from a YAML template, scale replicas, inspect revisions and pods, and open Rollouts in the Developer Topology view.
3+
The GitOps Console plugin provides list and details pages for Argo Rollouts in the OpenShift web console. You can search and filter Rollouts, create them from a YAML template, scale replicas, inspect revisions and pods, and open Rollouts in the Topology view.
44

5-
The **Rollouts** page is available when the Rollout custom resource definition is installed on the cluster.
5+
The **Rollouts** page is available after you install the Red Hat OpenShift GitOps Operator.
66

77
## Prerequisites
88

99
* You have access to the OpenShift web console.
1010
* The GitOps Console plugin is enabled. See [Enable the GitOps Console plugin](admin-enable-plugin.md).
11-
* The Rollout CRD is installed on the cluster.
1211
* You can list Rollouts in the selected namespace (or across namespaces, depending on your permissions).
1312

1413
## List page
1514

16-
1. In the **Administrator** perspective, navigate to **GitOps****Rollouts**.
15+
1. In the **Administrator** or **Core platform** perspective, navigate to **GitOps****Rollouts**.
1716

1817
2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects.
1918

@@ -26,7 +25,7 @@ The Rollouts list page includes:
2625
* **Table columns**: **Name**, **Namespace**, **Status**, **Pods**, **Labels**, **Selector**, **Last Updated**, and row actions
2726
* **Pagination**: Browse results in pages of 10, 20, 50, or 100 items (default 50). Search and filters change which rows are included. See [Filter, search, and paginate resources](filter-resources.md).
2827

29-
When the list has results, a **Topology view** control opens the Developer Topology graph for the current namespace (or all namespaces).
28+
When the list has results, a **Topology view** control opens the Topology graph for the current namespace (or all namespaces).
3029

3130
> **NOTE**
3231
>
@@ -43,10 +42,16 @@ From the row kebab, you can:
4342

4443
## Topology integration
4544

46-
In the **Developer** perspective, the OpenShift Console **Topology** view can show Rollout workloads when:
45+
Rollout topology requires OpenShift Container Platform **4.19** or later (not available in the release-4.18 plugin).
4746

48-
* The Rollout CRD is installed
49-
* The cluster is OpenShift Container Platform **4.19** or later
47+
| Perspective | Navigation |
48+
| --- | --- |
49+
| **Core platform** | **Workloads****Topology** |
50+
| **Developer** | **Topology** |
51+
52+
The cluster-wide perspective may be labeled **Administrator** or **Core platform** depending on your OpenShift version.
53+
54+
See [Rollouts in Topology](topology.md#rollouts-in-topology) for the full Topology page layout.
5055

5156
When those conditions are met:
5257

@@ -58,7 +63,7 @@ Use the **Topology view** control on the Rollouts list, Details tab, or Pods tab
5863

5964
![Topology view control on the Rollouts list](assets/pics/rollouts-topology-view-control.png)
6065

61-
From Details or Pods, the Rollout is selected in the graph. For more detail, see [Rollouts in Developer Topology](topology.md#rollouts-in-developer-topology).
66+
From Details or Pods, the Rollout is selected in the graph. For more detail, see [Rollouts in Topology](topology.md#rollouts-in-topology).
6267

6368
## Rollout details page
6469

@@ -78,7 +83,7 @@ Section title: **Rollout details**.
7883

7984
**Summary (left)**
8085

81-
* **Name**, with a **Topology view** control that opens the Developer Topology graph for this Rollout
86+
* **Name**, with a **Topology view** control that opens the Topology graph for this Rollout
8287
* **Namespace**
8388
* **Labels**, with **Edit**
8489
* **Annotations**
@@ -142,5 +147,5 @@ The **Events** tab shows Kubernetes events for the Rollout object, using the sta
142147
## Related information
143148

144149
* [Filter, search, and paginate resources](filter-resources.md)
145-
* [Rollouts in Developer Topology](topology.md#rollouts-in-developer-topology)
150+
* [Rollouts in Topology](topology.md#rollouts-in-topology)
146151
* [Troubleshooting](troubleshooting.md)

docs/topology.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The GitOps Console plugin provides two kinds of graphical experience:
44

55
* **Graph view** — In-plugin graphs on Application **Resources** and ApplicationSet **Applications** tabs
6-
* **Topology**The OpenShift **Developer** perspective Topology page for Rollout workloads, opened with the **Topology view** control
6+
* **Topology**Rollout workloads on the console **Topology** page (path depends on OpenShift version; see [Rollouts in Topology](#rollouts-in-topology))
77

88
## Application resource graph
99

@@ -116,14 +116,20 @@ The `template.metadata.labels` values must match the `rollingSync.steps` selecto
116116

117117
This step-based flow is separate from **sync waves** on an Application's managed resources (the **Sync Wave** column on an Application **Resources** tab). Progressive sync controls the order in which Applications sync; sync waves control the order of resources within a single Application sync.
118118

119-
## Rollouts in Developer Topology
119+
## Rollouts in Topology
120120

121-
In the **Developer** perspective, open **Topology** to see Rollout workloads in **graph** or **list** view.
121+
Rollout topology integration requires OpenShift Container Platform **4.19** or later (not available in the release-4.18 plugin).
122122

123-
Rollout topology integration requires:
123+
Open Topology using the path that matches your console layout:
124124

125-
* The Rollout CRD installed on the cluster
126-
* OpenShift Container Platform **4.19** or later
125+
| Perspective | Navigation |
126+
| --- | --- |
127+
| **Core platform** | **Workloads** → **Topology** |
128+
| **Developer** | **Topology** |
129+
130+
The cluster-wide perspective may be labeled **Administrator** or **Core platform** depending on your OpenShift version.
131+
132+
From GitOps **Rollouts** pages, the **Topology view** control opens the same graph without using the navigation paths above.
127133

128134
When available, the Topology page includes the following, from top to bottom:
129135

docs/troubleshooting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
## Prerequisites
44

55
* You have access to the OpenShift web console.
6-
* You have access to an OpenShift Container Platform 4.19 or later cluster.
6+
* You have access to an OpenShift Container Platform 4.18 or later cluster.
77
* The GitOps Console plugin is enabled. See [Enable the GitOps Console plugin](admin-enable-plugin.md).
88

99
## Common issues
1010

1111
**GitOps is missing from the navigation**
1212

13-
The plugin is disabled, the cluster is older than OpenShift 4.19, or the plugin pods are not running. See [Enable the GitOps Console plugin](admin-enable-plugin.md). Refresh the browser after you enable the plugin.
13+
The plugin is disabled, the cluster is older than OpenShift 4.18, or the plugin pods are not running. See [Enable the GitOps Console plugin](admin-enable-plugin.md). Refresh the browser after you enable the plugin.
1414

1515
**ImageUpdaters or Rollouts are missing**
1616

17-
Those list pages appear only when the matching CRDs are installed. Rollouts in the Developer **Topology** view also require OpenShift 4.19 or later. See [Rollouts in Developer Topology](topology.md#rollouts-in-developer-topology).
17+
Those list pages appear when the Red Hat OpenShift GitOps Operator is installed (it installs the Rollout and ImageUpdater CRDs). Rollouts in the **Topology** view require OpenShift 4.19 or later and are not available in the release-4.18 plugin. See [Rollouts in Topology](topology.md#rollouts-in-topology).
1818

1919
**Empty lists or disabled actions**
2020

0 commit comments

Comments
 (0)