Skip to content

Commit 8e213fc

Browse files
committed
complete final sections and cleanup
Signed-off-by: Atif Ali <atali@redhat.com>
1 parent 0575401 commit 8e213fc

24 files changed

Lines changed: 704 additions & 117 deletions

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ The GitOps Console plugin provides search and template capabilities:
4848
* [ImageUpdaters in the GitOps Console](image-updaters.md)
4949
* [Rollouts in the GitOps Console](rollouts.md)
5050
* [Filter, search, and paginate resources](filter-resources.md)
51+
* [Graphs and topology views](topology.md)
5152
* [Getting started](getting-started.md)
5253
* [Troubleshooting](troubleshooting.md)
5354

docs/_sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
- [AppProjects in the GitOps Console](appprojects-rbac.md)
77
- [ImageUpdaters in the GitOps Console](image-updaters.md)
88
- [Rollouts in the GitOps Console](rollouts.md)
9+
- [Graphs and topology views](topology.md)
910
- [Filter, search, and paginate resources](filter-resources.md)
1011
- [Troubleshooting](troubleshooting.md)
11-
- [1.22 GA release notes](release-notes-ga.md)

docs/admin-enable-plugin.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,8 @@ The GitOps Console plugin is cluster-scoped. A single plugin deployment serves a
8282
When multiple Argo CD instances exist in different namespaces, their resources appear together in the GitOps pages. Use the namespace selector to limit the view to one namespace or to browse across namespaces.
8383

8484
The **View in Argo CD** action opens the selected application in the Argo CD user interface. This action requires a Route to the Argo CD server.
85+
86+
## Related information
87+
88+
* [Getting started](getting-started.md)
89+
* [Troubleshooting](troubleshooting.md)

docs/applications.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ The GitOps Console plugin provides list and details pages for Argo CD Applicatio
2020

2121
![Project dropdown on the Applications list page](assets/pics/applications-project-selector.png)
2222

23-
### Search and filter
23+
### Filter and search
2424

2525
Use the list page controls to narrow results:
2626

27+
* **Filter**: Use **Filter** to narrow by:
28+
* **Sync Status**: Synced, OutOfSync, Unknown
29+
* **Health Status**: Healthy, Progressing, Suspended, Degraded, Missing, Unknown
2730
* **Search**: Use the search field to match by **Name** or **Label**. Choose the mode from the dropdown next to the field (for example, **Name** with **Search by name...**).
28-
* **Filter**: Use **Filter** to narrow by **Sync Status** (**Synced**, **OutOfSync**, or **Unknown**) and **Health Status** (**Healthy**, **Progressing**, **Suspended**, **Degraded**, **Missing**, or **Unknown**).
2931

3032
You can combine search and filters. Clear individual chips or use **Clear all filters**. Changing filters, search, or project returns pagination to page 1. See [Filter, search, and paginate resources](filter-resources.md).
3133

@@ -36,12 +38,12 @@ The Applications table includes:
3638
| Column | Description |
3739
| --- | --- |
3840
| **Name** | Application name, with a link to the details page. |
39-
| **Namespace** | Namespace of the Application (shown when browsing more than one namespace). |
41+
| **Namespace** | Namespace of the Application. |
4042
| **Sync Status** | Current sync state, with quiet operation state when a sync is in progress or recently finished. |
4143
| **Health Status** | Overall Application health. |
42-
| **Revision** | Target revision (or **HEAD**). Multi-source Applications can show an additional revision count. |
43-
| **Labels** | Application labels (a limited set is shown in the row). |
44-
| **App Project** | Owning AppProject. |
44+
| **Revision** | Target revision (or **HEAD**). Multi-source Applications may show additional revision count. |
45+
| **Labels** | Application labels. |
46+
| **App Project** | AppProject that this Application belongs to. |
4547
| **Actions** | Row kebab menu. |
4648

4749
### Pagination
@@ -54,6 +56,8 @@ Browse results in pages of **10**, **20**, **50**, or **100** items (default **5
5456

5557
2. The console opens the YAML editor with a starter Application template. The template includes placeholders for name, destination, project, repository URL, path, target revision, and sync policy (`automated`, `prune`, `selfHeal`).
5658

59+
The editor includes a **Schema** side panel that describes Application fields, and a **Download** control to save the YAML.
60+
5761
3. Edit the YAML for your repository and cluster destination, then create the resource.
5862

5963
Application creation uses YAML only. There is no guided form.
@@ -89,6 +93,8 @@ The details page includes the following tabs.
8993

9094
The **Details** tab summarizes identity, status, and sync policy.
9195

96+
![Application Details tab with Actions menu](assets/pics/application-details-tab.png)
97+
9298
**Application summary (left)**
9399

94100
* **Name**, with an optional **Argo CD** link when a Route is available
@@ -117,10 +123,14 @@ Without update permission, the sync policy toggles are disabled.
117123

118124
The **YAML** tab provides a live editor for the Application manifest. Use it to inspect or update the full resource definition.
119125

126+
The editor includes a **Schema** side panel that describes Application fields, and a **Download** control to save the YAML.
127+
120128
### Sources tab
121129

122130
The **Sources** tab lists repository sources for the Application (single-source and multi-source).
123131

132+
![Application Sources tab with multi-source table](assets/pics/application-sources-tab.png)
133+
124134
Section title: **Application sources**.
125135

126136
The sources table includes:
@@ -152,6 +162,9 @@ The graph and table show health and sync status for the Application’s **immedi
152162
* **Kind**
153163
* Search by resource name
154164
* In list view, the table columns include **Name**, **Namespace**, **Sync Wave**, **Sync Status**, **Health Status**, and row actions.
165+
166+
![Application Resources list view](assets/pics/application-resources-list-view.png)
167+
155168
* Row actions can include **View in Argo CD** and **Delete**, depending on the resource and your permissions.
156169
* The list supports sorting and pagination. See [Filter, search, and paginate resources](filter-resources.md).
157170

@@ -162,7 +175,7 @@ The graph and table show health and sync status for the Application’s **immedi
162175
* Group or ungroup resources of the same kind.
163176
* Context-menu actions on nodes can include viewing details, editing labels and annotations, deleting resources, editing the Application, and opening **View in Argo CD**.
164177

165-
For more about graphical views, see [Topology view](topology.md).
178+
For more about graph controls, see [Graphs and topology views](topology.md).
166179

167180
### Sync Status tab
168181

@@ -217,7 +230,7 @@ The **Events** tab shows Kubernetes events for the Application object, using the
217230
## Related information
218231

219232
* [Filter, search, and paginate resources](filter-resources.md)
220-
* [Topology view](topology.md)
233+
* [Graphs and topology views](topology.md)
221234
* [ApplicationSets in the GitOps Console](applicationsets.md)
222235
* [AppProjects in the GitOps Console](appprojects-rbac.md)
223236
* [Troubleshooting](troubleshooting.md)

docs/applicationsets.md

Lines changed: 120 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,134 @@
11
# ApplicationSets in the GitOps Console
22

3-
The GitOps Console plugin shows key details of Argo CD ApplicationSets. You can view and create ApplicationSets directly from the OpenShift Container Platform web console. A graphical view shows the applications managed by an ApplicationSet and the progressive sync flow from one step to the next.
3+
The GitOps Console plugin shows list and details pages for Argo CD ApplicationSets in the OpenShift web console. You can search and filter ApplicationSets, create them from a YAML template, review generated Applications, inspect generators, and use the graphical view for owner-reference and progressive sync layouts.
4+
5+
## Prerequisites
6+
7+
* You have access to the OpenShift web console.
8+
* The GitOps Console plugin is enabled. See [Enable the GitOps Console plugin](admin-enable-plugin.md).
9+
* You can list ApplicationSets in the selected namespace (or across namespaces, depending on your permissions).
410

511
## List page
612

7-
The ApplicationSets list page follows the same list patterns as other custom resources:
13+
1. In the **Administrator** perspective, navigate to **GitOps****ApplicationSets**.
814

9-
* **Table columns**: Standard columns for custom resources
10-
* **Filtering**: Filter ApplicationSets by health status (Healthy, Error, Unknown)
11-
* **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).
15+
2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects.
16+
17+
The ApplicationSets list page includes:
18+
19+
* **Filtering**: Filter ApplicationSets by:
20+
* **Health Status**: Healthy, Error, Unknown
21+
* **Search**: Use the search field to match by **Name** or **Label**. Choose the mode from the dropdown next to the field.
1222
* **Create action**: Click **Create ApplicationSet** to open the YAML editor with a default ApplicationSet template
23+
* **Table columns**: **Name**, **Namespace**, **Health Status**, **Generated Apps**, **Generators**, **Labels**, **Created At**, and row actions
24+
* **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).
1325

1426
> **NOTE**
1527
>
1628
> Creation uses the YAML editor. The console does not provide an ApplicationSet form wizard.
1729
18-
## Details page
30+
### Row actions
31+
32+
From the row kebab, you can:
33+
34+
* **Edit labels**
35+
* **Edit annotations**
36+
* **Edit ApplicationSet** (opens the YAML editor)
37+
* **Delete ApplicationSet**
38+
39+
## ApplicationSet details page
40+
41+
1. From the ApplicationSets list, click an ApplicationSet name.
42+
43+
2. The details page breadcrumb shows **ApplicationSets****ApplicationSet details**.
44+
45+
3. Use the page header **Actions** menu for the same edit and delete actions as the list.
46+
47+
The details page includes the following tabs.
48+
49+
### Details tab
50+
51+
The **Details** tab summarizes identity, status, and related counts.
52+
53+
Section title: **ApplicationSet details**.
54+
55+
**Summary (left)**
56+
57+
* **Name**
58+
* **Namespace**
59+
* **Labels**, with **Edit**
60+
* **Annotations**
61+
* **Created at**
62+
* **Owner**
63+
64+
**Status and configuration (right)**
65+
66+
* **Status**: Overall health of the ApplicationSet (**Healthy**, **Error**, or **Unknown**)
67+
* **Generated Apps**: Count of Applications owned by this ApplicationSet, with a link to the **Applications** tab
68+
* **Generators**: Count of configured generators, with a link to the **Generators** tab
69+
* **App Project**: AppProject that generated Applications belong to
70+
* **Repository**: Template source repository URL when the ApplicationSet template uses a single `source` (multi-source templates may not show this field)
71+
72+
**Conditions**
73+
74+
Below the summary, the **Conditions** section shows ApplicationSet status conditions from the controller. Use this table to diagnose generation failures, progressive sync progress, and whether managed Applications are up to date.
75+
76+
The conditions table includes:
77+
78+
| Column | Description |
79+
| --- | --- |
80+
| **Type** | Condition type, such as **ErrorOccurred**, **ParametersGenerated**, **ResourcesUpToDate**, or **RolloutProgressing**. |
81+
| **Status** | **True**, **False**, or **Unknown**. |
82+
| **Updated** | When the condition last changed. |
83+
| **Reason** | Short machine-readable cause. |
84+
| **Message** | Human-readable details. |
85+
86+
Common conditions:
87+
88+
* **ErrorOccurred**: Generation or sync errors for the ApplicationSet.
89+
* **ParametersGenerated**: Whether generator parameters were produced successfully.
90+
* **ResourcesUpToDate**: Whether generated Applications match the desired state.
91+
* **RolloutProgressing**: Progressive sync or rollout is still in progress.
92+
93+
If no conditions are reported, the section shows **No conditions found**.
94+
95+
### YAML tab
96+
97+
The **YAML** tab provides a live editor for the ApplicationSet manifest. Use it to inspect or update the full resource definition.
98+
99+
The editor includes a **Schema** side panel that describes ApplicationSet fields, and a **Download** control to save the YAML.
100+
101+
### Generators tab
102+
103+
The **Generators** tab shows the ApplicationSet generator configuration in a structured view.
104+
105+
Supported generator presentations include **List**, **Cluster**, **git**, **Matrix**, **Merge**, and **Union**. Other generator types use a generic view that shows the configuration as JSON.
106+
107+
If no generators are configured, the tab shows an empty state.
108+
109+
### Applications tab
110+
111+
The **Applications** tab shows Applications generated by this ApplicationSet in list or graph form.
112+
113+
Section title: **ApplicationSet Applications**.
114+
115+
* Switch between **List view** and **Graph view**. The console remembers your preference.
116+
* Use **Filter** and **Search** (by name or label) to narrow by health and sync status, or by Application name or label.
117+
* List view uses the same Application table columns, sorting, and pagination as the main Applications list. See [Applications in the GitOps Console](applications.md).
118+
* Graph view shows the ApplicationSet and its generated Applications:
119+
* **Standard layout**: Owner-reference tree when progressive sync is not active
120+
* **Progressive Sync Flow View**: Step groups when progressive sync is enabled and step status is available
121+
122+
For graph controls and progressive sync requirements, see [Graphs and topology views](topology.md).
123+
124+
### Events tab
125+
126+
The **Events** tab shows Kubernetes events for the ApplicationSet object, using the standard console event stream for that resource.
19127

20-
The ApplicationSet details page provides the following tabs:
128+
## Related information
21129

22-
* **Details tab**: Displays status information, generator counts, conditions, links to the Generators and Applications tabs, and shows the number of generated applications of related Applications.
23-
* **YAML tab**: Provides a live manifest editor for the ApplicationSet resource.
24-
* **Generators tab**: Provides a structured view of generator configuration, including list, merge, and union generators.
25-
* **Applications tab**: Displays the list of applications generated by the ApplicationSet with a Graphical View showing visual representation of the generated applications, progressive sync visualization that shows the progressive sync flow from step to step when progressive sync is enabled, a filter widget to filter by health and sync status, and an applications table with the same rich columns, filtering, and pagination as the main Application list page.
26-
* **Events tab**: Shows Kubernetes events for the ApplicationSet object.
130+
* [Filter, search, and paginate resources](filter-resources.md)
131+
* [Graphs and topology views](topology.md)
132+
* [Applications in the GitOps Console](applications.md)
133+
* [AppProjects in the GitOps Console](appprojects-rbac.md)
134+
* [Troubleshooting](troubleshooting.md)

0 commit comments

Comments
 (0)