|
1 | 1 | # ApplicationSets in the GitOps Console |
2 | 2 |
|
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). |
4 | 10 |
|
5 | 11 | ## List page |
6 | 12 |
|
7 | | -The ApplicationSets list page follows the same list patterns as other custom resources: |
| 13 | +1. In the **Administrator** perspective, navigate to **GitOps** → **ApplicationSets**. |
8 | 14 |
|
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. |
12 | 22 | * **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). |
13 | 25 |
|
14 | 26 | > **NOTE** |
15 | 27 | > |
16 | 28 | > Creation uses the YAML editor. The console does not provide an ApplicationSet form wizard. |
17 | 29 |
|
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. |
19 | 127 |
|
20 | | -The ApplicationSet details page provides the following tabs: |
| 128 | +## Related information |
21 | 129 |
|
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