-
Notifications
You must be signed in to change notification settings - Fork 482
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: ArgoCD + FluxCD App Listing (#5636)
* Glossary Add * Added ArgoCD Listing * PM Feedback Incorporated * Added Flux CD Appl Listing + Other Fixes * Incorporated PM Feedback for FluxCD * Incorporated PM Feedback 3
- Loading branch information
1 parent
18431d0
commit 75fa635
Showing
2 changed files
with
155 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,145 @@ | ||
| # Applications | ||
|
|
||
| Please configure Global Configurations before creating an application or cloning an existing application. | ||
| {% hint style="warning" %} | ||
| Configure [Global Configurations](./global-configurations/README.md) first before creating an application or cloning an existing application. | ||
| {% endhint %} | ||
|
|
||
| ## Introduction | ||
|
|
||
| The **Applications** page helps you create and manage your microservices, and it majorly consists of the following: | ||
|
|
||
| * [Application Listing](#application-listing) | ||
| * [Create Button](#create-button) | ||
| * [Other Options](#other-options) | ||
|
|
||
| ### Application Listing | ||
|
|
||
| You can view the app name, its status, environment, namespace, and many more upfront. The apps are segregated into: [Devtron Apps](../reference/glossary.md#devtron-apps), [Helm Apps](../reference/glossary.md#helm-apps), [ArgoCD Apps](../reference/glossary.md#argocd-apps), and [FluxCD Apps](../reference/glossary.md#fluxcd-apps). | ||
|
|
||
|  | ||
|
|
||
| ### Create Button | ||
|
|
||
| You can use this to: | ||
| * [Create a Devtron app](./create-application.md) | ||
| * [Create a Helm app](./deploy-chart/deployment-of-charts.md) | ||
| * [Create a Job](./jobs/create-job.md) | ||
|
|
||
| ### Other Options | ||
|
|
||
| There are additional options available for you: | ||
| * **Search and filters** to make it easier for you to find applications. | ||
| * **Export CSV** to download the data of Devtron apps (not supported for Helm apps and Argo CD apps). | ||
| * **Sync button** to refresh the app listing. | ||
|
|
||
| --- | ||
|
|
||
| ## View ArgoCD App Listing | ||
|
|
||
| {% hint style="warning" %} | ||
| ### Who Can Perform This Action? | ||
| Users need super-admin permission to view/enable/disable the ArgoCD listing. | ||
| {% endhint %} | ||
|
|
||
| ### Preface | ||
|
|
||
| In Argo CD, a user manages one dashboard for one ArgoCD instance. Therefore, with multiple ArgoCD instances, the process becomes cumbersome for the user to manage several dashboards. | ||
|
|
||
| With Devtron, you get an entire Argo CD app listing in one place. This listing includes: | ||
| * Apps deployed using [GitOps](../reference/glossary.md#gitops) on Devtron | ||
| * Other Argo CD apps present in your cluster | ||
|
|
||
|  | ||
|
|
||
| ### Advantages | ||
|
|
||
| Devtron also bridges the gap for ArgoCD users by providing additional features as follows: | ||
|
|
||
| * **Resource Scanning**: You can scan for vulnerabilities using Devtron's [resource scanning](../user-guide/security-features.md#from-app-details) feature. [](https://devtron.ai/pricing) | ||
|
|
||
| * **Single-pane View**: All Argo CD apps will show details such as their app status, environment, cluster, and namespace together in one dashboard. | ||
|
|
||
| * **Feature-rich Options**: Clicking an Argo CD app will give you access to its logs, terminal, events, manifest, available resource kinds, pod restart log, and many more. | ||
|
|
||
| {% hint style="info" %} | ||
| ### Additional References | ||
| [ArgoCD: Standalone Configuration vs Devtron Configuration](https://devtron.ai/blog/argocd-standalone-configuration-vs-devtron-configuration/#argocd-installation-and-configuration) | ||
| {% endhint %} | ||
|
|
||
| ### Prerequisite | ||
| The cluster in which Argo CD apps exist should be added in **Global Configurations** → **Clusters and Environments** | ||
|
|
||
| ### Feature Flag | ||
|
|
||
| > **`ENABLE_EXTERNAL_ARGO_CD: "true"`** | ||
| ### Enabling ArgoCD App Listing | ||
|
|
||
| {% embed url="https://www.youtube.com/watch?v=4KyYnsAEpqo" caption="Enabling External ArgoCD Listing" %} | ||
|
|
||
| 1. Go to the **Resource Browser** of Devtron. | ||
|
|
||
| 2. Select the cluster (in which your Argo CD app exists). | ||
|
|
||
| 3. Type `ConfigMap` in the 'Jump to Kind' field. | ||
|
|
||
| 4. Search for `dashboard-cm` using the available search bar and click it. | ||
|
|
||
| 5. Click **Edit Live Manifest**. | ||
|
|
||
| 6. Set the feature flag **ENABLE_EXTERNAL_ARGO_CD** to **"true"** | ||
|
|
||
| 7. Click **Apply Changes**. | ||
|
|
||
| 8. Go back to the 'Jump to Kind' field and type `Pod`. | ||
|
|
||
| 9. Search for `dashboard` pod and use the kebab menu (3 vertical dots) to delete the pod. | ||
|
|
||
| 10. Go to **Applications** and refresh the page. A new tab named **ArgoCD Apps** will be visible. | ||
|
|
||
| 11. Select the cluster(s) from the dropdown to view the Argo CD apps available in the chosen cluster(s). | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## View FluxCD App Listing | ||
|
|
||
| {% hint style="warning" %} | ||
| ### Who Can Perform This Action? | ||
| Users need super-admin permission to view/enable/disable the FluxCD listing. | ||
| {% endhint %} | ||
|
|
||
| ### Preface | ||
|
|
||
| Flux CD doesn't have any official dashboard; however, Devtron supports the listing of your [Flux CD](https://fluxcd.io/) apps in one dashboard. Here, the [advantages](#advantages) are same as those of [ArgoCD app listing](#view-argocd-app-listing). | ||
|
|
||
|  | ||
|
|
||
| ### Prerequisite | ||
| The cluster in which Flux CD apps exist should be added in **Global Configurations** → **Clusters and Environments** | ||
|
|
||
| ### Feature Flag | ||
|
|
||
| > **`FEATURE_EXTERNAL_FLUX_CD_ENABLE: "true"`** | ||
| ### Enabling FluxCD App Listing | ||
|
|
||
| {% hint style="info" %} | ||
| ### Tip | ||
| You may refer the steps mentioned in the [Enabling ArgoCD App Listing](#enabling-argocd-app-listing) section since the procedure is similar. | ||
| {% endhint %} | ||
|
|
||
| Using Devtron's Resource Browser, add the [feature flag](#feature-flag-1) in the Dashboard ConfigMap as shown below. | ||
|
|
||
|  | ||
|
|
||
| After successfully executing all the steps, a new tab named **FluxCD Apps** will be visible. Select the cluster(s) from the dropdown to view the Flux CD apps available in the chosen cluster(s). | ||
|
|
||
|  | ||
|
|
||
| (Optional) Once you choose cluster(s), you may use the **Template Type** dropdown to further filter your Flux CD app listing based on its type, i.e., [Kustomization](https://fluxcd.io/flux/components/kustomize/kustomizations/) or [Helmrelease](https://fluxcd.io/flux/components/helm/helmreleases/). | ||
|
|
||
| Click any Flux CD app to view its details as shown below. | ||
|
|
||
|  |