|
1 | 1 | # Applications in the GitOps Console |
2 | 2 |
|
3 | | -The GitOps Console plugin shows key details of an Argo CD Application. You can view and create Applications directly from the OpenShift Container Platform web console. A **Graphical view** in the **Resources** tab of the Details page shows the application’s resources in a tree structure. |
| 3 | +The GitOps Console plugin provides list and details pages for Argo CD Applications in the OpenShift web console. You can search and filter Applications, create them from a YAML template, review health and sync status, inspect sources, managed resources, sync history, and events. |
4 | 4 |
|
5 | 5 | > **IMPORTANT** |
6 | 6 | > |
7 | | -> The GitOps Console plugin displays the health status stored in the Application custom resource (CR). By default, this behavior depends on the configuration set by the Operator. If the Application CR does not contain the health status or the GitOps Console plugin does not display it correctly, set `controller.resource.health.persist: "true"` in the `argocd-cmd-params-cm` config map. |
| 7 | +> The plugin displays the health status stored on the Application custom resource (CR). If health is missing or incorrect, set `controller.resource.health.persist: "true"` in the `argocd-cmd-params-cm` ConfigMap. For more information, see [Troubleshooting](troubleshooting.md). |
8 | 8 |
|
9 | | -## List page |
| 9 | +## Prerequisites |
10 | 10 |
|
11 | | -The Applications list page displays all Applications with the following features: |
| 11 | +* You have access to the OpenShift web console. |
| 12 | +* The GitOps Console plugin is enabled. See [Enable the GitOps Console plugin](admin-enable-plugin.md). |
| 13 | +* You can list Applications in the selected namespace (or across namespaces, depending on your permissions). |
12 | 14 |
|
13 | | -* **Table columns**: name, namespace, sync status, health, revision, AppProject, and actions |
14 | | -* **Filtering**: Filter Applications by health status (Healthy, Progressing, Degraded, Missing) and sync status (Synced, OutOfSync, Unknown) |
15 | | -* **Sorting and search**: Sort columns and search by name |
16 | | -* **Pagination**: After filters and search, browse results in pages of 10, 20, 50, or 100 items (default 50). Page and page size are stored in the URL. See [Filter and paginate resources](filter-resources.md). |
17 | | -* **Create action**: Click **Create Application** to open the YAML editor with a starter template that includes repository URL, destination, and sync policy placeholders |
18 | | -* **Namespace view**: From the GitOps Operator namespace path, an optional control can list operands in all namespaces for operator-focused workflows |
| 15 | +## Applications list page |
19 | 16 |
|
20 | | -## Details page |
| 17 | +1. In the **Administrator** perspective, navigate to **GitOps** → **Applications**. |
21 | 18 |
|
22 | | -The Application details page provides the following tabs: |
| 19 | +2. Optional: Use the **Project** dropdown to limit the list to one project (namespace), or choose all projects to view Applications across namespaces. |
23 | 20 |
|
24 | | -* **Details tab**: Displays summary information, health and sync indicators, revision links, destination and project information, conditions, toggles for automated sync, self-heal, and prune (when you have update permission), and detection of an Argo CD Route so you can open the Argo CD UI for the same application when routing is configured. |
25 | | -* **YAML tab**: Provides a live manifest editor for the Application resource. |
26 | | -* **Sources tab**: Displays repository sources with icons and metadata for Helm, Git, and OCI sources. The sources table supports pagination. |
27 | | -* **Resources tab**: Combines a resource table with an interactive topology graph: |
28 | | - * The graph shows immediate managed resources for the Application, not the full Argo CD resource tree. |
29 | | - * Use the Argo CD link on the tab to open the complete resource hierarchy in the Argo CD UI. |
30 | | - * Pan, zoom, and select resources in the graph; status filters apply to both table and graph. |
31 | | - * In list view, the resources table supports filtering, sorting, and pagination like other GitOps tables. See [Filter and paginate resources](filter-resources.md). |
32 | | - * Context-menu actions on graph nodes include viewing details, editing labels and annotations, deleting resources, and viewing resources in Argo CD. |
33 | | - * Related resources of the same kind can be grouped or ungrouped in the graph. |
34 | | -* **Sync Status tab**: Provides fine-grained sync and operation status information for the Application, including a paginated table of resources last synced. |
35 | | -* **History tab**: Displays the deployment and sync history for the Application in a paginated table (newest first by default; column sort keeps the selected direction). |
36 | | -* **Events tab**: Shows Kubernetes events for the Application object. |
| 21 | +  |
37 | 22 |
|
38 | | -## Additional features |
| 23 | +### Search and filter |
39 | 24 |
|
40 | | -* **Favorites**: You can mark Applications as favorites based on console user settings. |
41 | | -* **Standard actions**: The page header provides access to standard actions such as editing labels, annotations, and deleting the Application. |
| 25 | +Use the list page controls to narrow results: |
42 | 26 |
|
43 | | -## View, sync, and rollback |
| 27 | +* **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**). |
44 | 29 |
|
45 | | -* **View**: Use the list page and the details tabs. |
46 | | -* **Sync**: The Application kebab does not include a **Sync** action. Use the automated, self-heal, and prune toggles on the **Details** tab, the Argo CD UI, the `argocd` CLI, or YAML. |
47 | | -* **Rollback**: The Application kebab does not include a **Rollback** action. Use the **History** tab as a reference, then the Argo CD UI or CLI. For Rollout rollback, see [Rollouts in the GitOps Console](rollouts.md). |
| 30 | +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). |
| 31 | + |
| 32 | +### Table columns |
| 33 | + |
| 34 | +The Applications table includes: |
| 35 | + |
| 36 | +| Column | Description | |
| 37 | +| --- | --- | |
| 38 | +| **Name** | Application name, with a link to the details page. | |
| 39 | +| **Namespace** | Namespace of the Application (shown when browsing more than one namespace). | |
| 40 | +| **Sync Status** | Current sync state, with quiet operation state when a sync is in progress or recently finished. | |
| 41 | +| **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. | |
| 45 | +| **Actions** | Row kebab menu. | |
| 46 | + |
| 47 | +### Pagination |
| 48 | + |
| 49 | +Browse results in pages of **10**, **20**, **50**, or **100** items (default **50**). Search and filters change which rows are included. Page and page size are stored in the URL. See [Filter, search, and paginate resources](filter-resources.md). |
| 50 | + |
| 51 | +### Create an Application |
| 52 | + |
| 53 | +1. On the Applications list page, click **Create Application**. |
| 54 | + |
| 55 | +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`). |
| 56 | + |
| 57 | +3. Edit the YAML for your repository and cluster destination, then create the resource. |
| 58 | + |
| 59 | +Application creation uses YAML only. There is no guided form. |
| 60 | + |
| 61 | +### Row actions |
| 62 | + |
| 63 | +From the row kebab, you can: |
| 64 | + |
| 65 | +* **Edit labels** |
| 66 | +* **Edit annotations** |
| 67 | +* **Edit Application** (opens the YAML editor) |
| 68 | +* **Delete Application** |
| 69 | + |
| 70 | +> **NOTE** |
| 71 | +> |
| 72 | +> The Application kebab does not include **Sync** or **Rollback**. Use sync policy toggles on the Details tab, the Argo CD UI, the `argocd` CLI, or YAML. Use the History tab as a reference for past revisions, then roll back from the Argo CD UI or CLI if needed. |
| 73 | +
|
| 74 | +### Favorites |
| 75 | + |
| 76 | +You can mark Applications as favorites by using the console favorites control on the list and details pages. Favorites follow your console user settings. |
| 77 | + |
| 78 | +## Application details page |
| 79 | + |
| 80 | +1. From the Applications list, click an Application name. |
| 81 | + |
| 82 | +2. The details page breadcrumb shows **Applications** → **Application details**. |
| 83 | + |
| 84 | +3. Use the page header **Actions** menu for the same edit, delete, and (when available) **View in Argo CD** actions as the list. **View in Argo CD** requires a Route to the Argo CD server. |
| 85 | + |
| 86 | +The details page includes the following tabs. |
| 87 | + |
| 88 | +### Details tab |
| 89 | + |
| 90 | +The **Details** tab summarizes identity, status, and sync policy. |
| 91 | + |
| 92 | +**Application summary (left)** |
| 93 | + |
| 94 | +* **Name**, with an optional **Argo CD** link when a Route is available |
| 95 | +* **Namespace** |
| 96 | +* **Labels**, with **Edit** |
| 97 | +* **Annotations** |
| 98 | +* **Created at** |
| 99 | +* **Owner** |
| 100 | + |
| 101 | +**Application status and destination (right)** |
| 102 | + |
| 103 | +* **Health Status**: Overall health of the Application |
| 104 | +* **Current Sync Status**: Sync state and revision information |
| 105 | +* **Last Sync Status**: Last operation state, with Application conditions when present (errors, warnings, or notices) |
| 106 | +* **Target Revision**: Desired revision, or **HEAD** |
| 107 | +* **Project**: Link to the AppProject |
| 108 | +* **Destination**: Destination cluster and namespace |
| 109 | +* **Sync Policy** toggles (when you have update permission): |
| 110 | + * **Automated** |
| 111 | + * **Prune** (requires automated sync) |
| 112 | + * **Self Heal** (requires automated sync) |
| 113 | + |
| 114 | +Without update permission, the sync policy toggles are disabled. |
| 115 | + |
| 116 | +### YAML tab |
| 117 | + |
| 118 | +The **YAML** tab provides a live editor for the Application manifest. Use it to inspect or update the full resource definition. |
| 119 | + |
| 120 | +### Sources tab |
| 121 | + |
| 122 | +The **Sources** tab lists repository sources for the Application (single-source and multi-source). |
| 123 | + |
| 124 | +Section title: **Application sources**. |
| 125 | + |
| 126 | +The sources table includes: |
| 127 | + |
| 128 | +| Column | Description | |
| 129 | +| --- | --- | |
| 130 | +| **Type** | Source type such as **Git**, **Helm**, or **OCI**. | |
| 131 | +| **Repository** | Repository URL. | |
| 132 | +| **Target Revision** | Desired revision for that source. | |
| 133 | +| **Path / Chart** | Git path or Helm chart (root path can appear as **(root)**). | |
| 134 | +| **Ref** | Source reference name when used in multi-source Applications. | |
| 135 | + |
| 136 | +The table supports pagination. An Argo CD link on the tab can open source parameters in the Argo CD UI when a Route is available. |
| 137 | + |
| 138 | +### Resources tab |
| 139 | + |
| 140 | +The **Resources** tab shows the Application’s immediate managed resources in list or graph form. |
| 141 | + |
| 142 | +Section title: **Application resources**. |
| 143 | + |
| 144 | +The graph and table show health and sync status for the Application’s **immediate** resources only, not the full Argo CD resource tree. Use the **Argo CD** link on the tab to open the complete hierarchy in the Argo CD UI. |
| 145 | + |
| 146 | +#### List view and graph view |
| 147 | + |
| 148 | +* Switch between **List view** and **Graph view**. The console remembers your preference. |
| 149 | +* Filters apply to both views: |
| 150 | + * **Sync Status** |
| 151 | + * **Health Status** |
| 152 | + * **Kind** |
| 153 | + * Search by resource name |
| 154 | +* In list view, the table columns include **Name**, **Namespace**, **Sync Wave**, **Sync Status**, **Health Status**, and row actions. |
| 155 | +* Row actions can include **View in Argo CD** and **Delete**, depending on the resource and your permissions. |
| 156 | +* The list supports sorting and pagination. See [Filter, search, and paginate resources](filter-resources.md). |
| 157 | + |
| 158 | +#### Graph view |
| 159 | + |
| 160 | +* Pan, zoom, and select nodes. |
| 161 | +* Toggle OpenShift shapes and Argo CD shapes. |
| 162 | +* Group or ungroup resources of the same kind. |
| 163 | +* Context-menu actions on nodes can include viewing details, editing labels and annotations, deleting resources, editing the Application, and opening **View in Argo CD**. |
| 164 | + |
| 165 | +For more about graphical views, see [Topology view](topology.md). |
| 166 | + |
| 167 | +### Sync Status tab |
| 168 | + |
| 169 | +The **Sync Status** tab shows the latest sync operation and the resources involved in that sync. |
| 170 | + |
| 171 | +**Sync status** |
| 172 | + |
| 173 | +* **Operation**, with conditions when present |
| 174 | +* **Phase** |
| 175 | +* **Message** |
| 176 | +* **Initiated By** (for example, a user name or automated sync policy) |
| 177 | +* **Started At**, **Duration**, and **Finished At** |
| 178 | + |
| 179 | +**Resources Last Synced** |
| 180 | + |
| 181 | +A paginated table of resources from the last sync operation: |
| 182 | + |
| 183 | +| Column | Description | |
| 184 | +| --- | --- | |
| 185 | +| **Name** | Resource name. | |
| 186 | +| **Namespace** | Resource namespace. | |
| 187 | +| **Status** | Sync result for that resource. | |
| 188 | +| **Hook** | Hook information when applicable. | |
| 189 | +| **Message** | Status message. | |
| 190 | + |
| 191 | +Row actions follow the same resource actions pattern as the Resources tab. |
| 192 | + |
| 193 | +### History tab |
| 194 | + |
| 195 | +The **History** tab shows Application sync and deployment history. |
| 196 | + |
| 197 | +Section title: **Sync history**. |
| 198 | + |
| 199 | +The history table includes: |
| 200 | + |
| 201 | +| Column | Description | |
| 202 | +| --- | --- | |
| 203 | +| **ID** | History entry identifier. | |
| 204 | +| **Deploy Started At** | When the deploy started. | |
| 205 | +| **Deployed At** | When the deploy completed. | |
| 206 | +| **Initiated By** | User or **Automated**. | |
| 207 | +| **Revision(s) and Source Repo URL(s)** | Revision and repository information for the entry. | |
| 208 | + |
| 209 | +Entries display newest first by default. Column sorting keeps the direction you select. The table supports pagination. |
| 210 | + |
| 211 | +This tab is informational. It does not provide an in-console **Rollback** action. Use the Argo CD UI or CLI to roll back. |
| 212 | + |
| 213 | +### Events tab |
| 214 | + |
| 215 | +The **Events** tab shows Kubernetes events for the Application object, using the standard console event stream for that resource. |
| 216 | + |
| 217 | +## Related information |
| 218 | + |
| 219 | +* [Filter, search, and paginate resources](filter-resources.md) |
| 220 | +* [Topology view](topology.md) |
| 221 | +* [ApplicationSets in the GitOps Console](applicationsets.md) |
| 222 | +* [AppProjects in the GitOps Console](appprojects-rbac.md) |
| 223 | +* [Troubleshooting](troubleshooting.md) |
0 commit comments