-
Notifications
You must be signed in to change notification settings - Fork 554
doc: ArgoCD + FluxCD App Listing #5636
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b0be193
Glossary Add
ashoknayak777 ab457c8
Added ArgoCD Listing
ashoknayak777 7312c4a
PM Feedback Incorporated
ashoknayak777 8ad17ae
Added Flux CD Appl Listing + Other Fixes
ashoknayak777 8fc1a45
Incorporated PM Feedback for FluxCD
ashoknayak777 03b770b
Incorporated PM Feedback 3
ashoknayak777 9255198
Merge branch 'main' into argocd-list-doc
ashoknayak777 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,98 @@ | ||
| # 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), and [ArgoCD Apps](../reference/glossary.md#argocd-apps) | ||
ashoknayak777 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| ### 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 each Argo CD app. Therefore, with multiple apps, the process becomes cumbersome for the user to manage several dashboards. | ||
|
|
||
ashoknayak777 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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 | ||
|
|
||
|  | ||
ashoknayak777 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Advantages | ||
ashoknayak777 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Devtron also bridges the gap for ArgoCD users by providing additional features as follows: | ||
|
|
||
| * **Adding Build Pipeline**: Before GitOps deployment, you can add a CI pipeline as a part of the [workflow](../user-guide/creating-application/workflow/README.md) if you use Devtron. | ||
|
|
||
| * **Supports pre-CD and post-CD tasks**: You can perform [pre-deployment](../reference/glossary.md#pre-deployment) and [post-deployment](../reference/glossary.md#post-deployment) actions on Devtron. | ||
|
|
||
| * **Resource Scanning**: You can scan for vulnerabilities using Devtron's [resource scanning](../user-guide/security-features.md#from-app-details) feature. | ||
|
|
||
| * **Singe-pane view**: All Argo CD apps will show details such as app status, environment, cluster, and namespace in one place. | ||
|
|
||
| * **Multiple Options**: Clicking an app will give you access to 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** | ||
|
|
||
| ### 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.