Skip to content

Commit 75fa635

Browse files
ashokdevtronashokdevtron
authored
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
1 parent 18431d0 commit 75fa635

File tree

2 files changed

+155
-1
lines changed

2 files changed

+155
-1
lines changed

‎docs/reference/glossary.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ An immutable blob of data generated as an output after the execution of a job, b
1010

1111
* Once a job is complete, you can view the job artifacts by going to Jobs → Run history (tab) → (choose a pipeline and date of triggering the build) → Artifacts (tab).
1212

13+
### ArgoCD Apps
14+
15+
ArgoCD Apps are the micro-services deployed using a [GitOps](#gitops) deployment tool named [Argo CD](https://argo-cd.readthedocs.io/en/stable/).
16+
17+
If ArgoCD applications are present in your cluster, they will appear in the [ArgoCD Apps listing](../user-guide/applications.md#enabling-argocd-app-listing).
18+
1319
### Base Deployment Template
1420

1521
A deployment template is a manifest of the application defining its runtime behavior. You can select one of the default deployment charts or custom deployment charts created by super-admin.
@@ -112,6 +118,12 @@ Similarly, the CPU and memory resources can be different for each environment. T
112118

113119
You can add external links related to the application. For e.g., you can add Prometheus, Grafana, and many more to your application by going to Global Configurations → External Links. [Read More...](../user-guide/global-configurations/external-links.md)
114120

121+
### FluxCD Apps
122+
123+
FluxCD Apps are the micro-services deployed using a [GitOps](#gitops) deployment tool named [Flux CD](https://fluxcd.io/).
124+
125+
If FluxCD applications are present in your cluster, they will appear in the [FluxCD Apps listing](../user-guide/applications.md#view-fluxcd-app-listing).
126+
115127
### GitOps
116128

117129
A methodology for managing and automating Kubernetes deployments using Git repositories as the source of truth. Changes to the desired state of the cluster are driven by Git commits. [Read More...](../user-guide/global-configurations/gitops.md)

‎docs/user-guide/applications.md

Lines changed: 143 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,145 @@
11
# Applications
22

3-
Please configure Global Configurations before creating an application or cloning an existing application.
3+
{% hint style="warning" %}
4+
Configure [Global Configurations](./global-configurations/README.md) first before creating an application or cloning an existing application.
5+
{% endhint %}
6+
7+
## Introduction
8+
9+
The **Applications** page helps you create and manage your microservices, and it majorly consists of the following:
10+
11+
* [Application Listing](#application-listing)
12+
* [Create Button](#create-button)
13+
* [Other Options](#other-options)
14+
15+
### Application Listing
16+
17+
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).
18+
19+
![Figure 1: App Types](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/argocd/app-types.jpg)
20+
21+
### Create Button
22+
23+
You can use this to:
24+
* [Create a Devtron app](./create-application.md)
25+
* [Create a Helm app](./deploy-chart/deployment-of-charts.md)
26+
* [Create a Job](./jobs/create-job.md)
27+
28+
### Other Options
29+
30+
There are additional options available for you:
31+
* **Search and filters** to make it easier for you to find applications.
32+
* **Export CSV** to download the data of Devtron apps (not supported for Helm apps and Argo CD apps).
33+
* **Sync button** to refresh the app listing.
34+
35+
---
36+
37+
## View ArgoCD App Listing
38+
39+
{% hint style="warning" %}
40+
### Who Can Perform This Action?
41+
Users need super-admin permission to view/enable/disable the ArgoCD listing.
42+
{% endhint %}
43+
44+
### Preface
45+
46+
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.
47+
48+
With Devtron, you get an entire Argo CD app listing in one place. This listing includes:
49+
* Apps deployed using [GitOps](../reference/glossary.md#gitops) on Devtron
50+
* Other Argo CD apps present in your cluster
51+
52+
![Figure 2: ArgoCD App List](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/argocd/app-details-argo.gif)
53+
54+
### Advantages
55+
56+
Devtron also bridges the gap for ArgoCD users by providing additional features as follows:
57+
58+
* **Resource Scanning**: You can scan for vulnerabilities using Devtron's [resource scanning](../user-guide/security-features.md#from-app-details) feature. [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
59+
60+
* **Single-pane View**: All Argo CD apps will show details such as their app status, environment, cluster, and namespace together in one dashboard.
61+
62+
* **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.
63+
64+
{% hint style="info" %}
65+
### Additional References
66+
[ArgoCD: Standalone Configuration vs Devtron Configuration](https://devtron.ai/blog/argocd-standalone-configuration-vs-devtron-configuration/#argocd-installation-and-configuration)
67+
{% endhint %}
68+
69+
### Prerequisite
70+
The cluster in which Argo CD apps exist should be added in **Global Configurations** → **Clusters and Environments**
71+
72+
### Feature Flag
73+
74+
> **`ENABLE_EXTERNAL_ARGO_CD: "true"`**
75+
76+
### Enabling ArgoCD App Listing
77+
78+
{% embed url="https://www.youtube.com/watch?v=4KyYnsAEpqo" caption="Enabling External ArgoCD Listing" %}
79+
80+
1. Go to the **Resource Browser** of Devtron.
81+
82+
2. Select the cluster (in which your Argo CD app exists).
83+
84+
3. Type `ConfigMap` in the 'Jump to Kind' field.
85+
86+
4. Search for `dashboard-cm` using the available search bar and click it.
87+
88+
5. Click **Edit Live Manifest**.
89+
90+
6. Set the feature flag **ENABLE_EXTERNAL_ARGO_CD** to **"true"**
91+
92+
7. Click **Apply Changes**.
93+
94+
8. Go back to the 'Jump to Kind' field and type `Pod`.
95+
96+
9. Search for `dashboard` pod and use the kebab menu (3 vertical dots) to delete the pod.
97+
98+
10. Go to **Applications** and refresh the page. A new tab named **ArgoCD Apps** will be visible.
99+
100+
11. Select the cluster(s) from the dropdown to view the Argo CD apps available in the chosen cluster(s).
101+
102+
![Figure 3: Cluster Selection for Argo CD Listing](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/argocd/argo-cluster-selection.jpg)
103+
104+
---
105+
106+
## View FluxCD App Listing
107+
108+
{% hint style="warning" %}
109+
### Who Can Perform This Action?
110+
Users need super-admin permission to view/enable/disable the FluxCD listing.
111+
{% endhint %}
112+
113+
### Preface
114+
115+
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).
116+
117+
![Figure 4: FluxCD App List and Details](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-listing.jpg)
118+
119+
### Prerequisite
120+
The cluster in which Flux CD apps exist should be added in **Global Configurations** → **Clusters and Environments**
121+
122+
### Feature Flag
123+
124+
> **`FEATURE_EXTERNAL_FLUX_CD_ENABLE: "true"`**
125+
126+
### Enabling FluxCD App Listing
127+
128+
{% hint style="info" %}
129+
### Tip
130+
You may refer the steps mentioned in the [Enabling ArgoCD App Listing](#enabling-argocd-app-listing) section since the procedure is similar.
131+
{% endhint %}
132+
133+
Using Devtron's Resource Browser, add the [feature flag](#feature-flag-1) in the Dashboard ConfigMap as shown below.
134+
135+
![Figure 5: Editing Dashboard ConfigMap](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/flux-feature-flag.jpg)
136+
137+
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).
138+
139+
![Figure 6: Selecting Cluster](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/cluster-selection.jpg)
140+
141+
(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/).
142+
143+
Click any Flux CD app to view its details as shown below.
144+
145+
![Figure 7: Flux App Details](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/app-details-flux.gif)

0 commit comments

Comments
 (0)