From 6ff7f5959531830fc0eda64d358022bd209f08b0 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 4 Jul 2025 16:23:27 +0530 Subject: [PATCH 01/31] docs: add flux deploment --- .../workflow/cd-pipeline.md | 4 +- docs/user-guide/integrations/fluxcd.md | 53 +++++++++++++++++++ 2 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 docs/user-guide/integrations/fluxcd.md diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index 11b84d1e0..4ff63e280 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -30,12 +30,12 @@ The **New Deployment** tab displays the following sections: This section expects four inputs from you: -| Setting | Description | Options | +| Setting | Description | Options | | ----------- | ---------------------------------------------------------- | ------------------------- | | Environment | Select the environment where you want to deploy your application | (List of available environments) | | Namespace | Automatically populated based on the selected environment | Not Applicable | | Trigger | When to execute the deployment pipeline | **Automatic**: Deployment triggers automatically when a new image completes the previous stage (build pipeline or another deployment pipeline)
**Manual**: Deployment is not initiated automatically. You can trigger deployment with a desired image. | -| Deployment Approach | How to deploy the application | **Helm** or **GitOps**
Refer [GitOps](../../global-configurations/gitops.md) | +| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../integrations/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | {% hint style="info" %} diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/integrations/fluxcd.md new file mode 100644 index 000000000..b9b46ba50 --- /dev/null +++ b/docs/user-guide/integrations/fluxcd.md @@ -0,0 +1,53 @@ +# GitOps (Flux CD) + +## Prerequisite + + Please make sure to install **Build and Deploy (CI/CD)** integration. To install it, click [here](../integrations/build-and-deploy-ci-cd.md). + +Devtron supports FluxCD to help you manage application deployments using GitOps. With FluxCD, your Git repository becomes the single source of truth for your Kubernetes apps. Any changes you make in Git are automatically applied to your Kubernetes cluster by FluxCD. Learn more in the [FluxCD documentation](https://fluxcd.io/flux/) + +{% hint style="info" %} +### Additional Resources + [What is FluxCD? A Quick Guide to GitOps with FluxCD](https://devtron.ai/blog/what-is-fluxcd/) + + [Choosing the Right GitOps Tool: ArgoCD vs. FluxCD](https://devtron.ai/blog/gitops-tool-selection-argo-cd-or-flux-cd/) + +{% endhint %} + +## Key features + +* Works with Devtron CI pipelines and other Devtron integrations. + +* Supports Helm deployment method only. + +## Installation + +To enable deployments via FluxCD, you need to enable two specific feature flags for the specific cluster and then install flux controller on that specific cluster. To do so, follow the below steps: + +### Step 1: Enable Feature Flags + +1. Navigate to Devtron Resource Browser. + +2. Select the cluster for which you want to enable the feature flags. + +3. Go to Config & Storage → ConfigMap, and select `dashboard-cm` ConfigMap + +4. Edit the `dashboard-cm` ConfigMap by clicking **Edit live manifest**. + + * To enable deployments via FluxCD, check if the below entries are present in the ConfigMap (create one if it doesn't exist) and select **Apply changes**. + + ```yaml + FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true" + FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" + ``` + +5. Restart the Pod + 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment. + + 2. Click the checkbox next to the `dashboard` Deployment workload and restart it using the ⟳ button. + +6. Perform a hard refresh of the browser to clear the cache: + + * Mac: Hold down Cmd and Shift and then press R. + + * Windows/Linux: Hold down Ctrl and then press F5. From 91a84422100e1f4cfac9d8201bf1fbc82a04354f Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 8 Jul 2025 13:06:04 +0530 Subject: [PATCH 02/31] docs: enable FluxCD integration --- docs/user-guide/integrations/fluxcd.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/integrations/fluxcd.md index b9b46ba50..e7addd9ad 100644 --- a/docs/user-guide/integrations/fluxcd.md +++ b/docs/user-guide/integrations/fluxcd.md @@ -22,7 +22,7 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. ## Installation -To enable deployments via FluxCD, you need to enable two specific feature flags for the specific cluster and then install flux controller on that specific cluster. To do so, follow the below steps: +To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the specific cluster and then install FluxCD CRD on that specific cluster. To do so, follow the below steps: ### Step 1: Enable Feature Flags @@ -51,3 +51,21 @@ To enable deployments via FluxCD, you need to enable two specific feature flags * Mac: Hold down Cmd and Shift and then press R. * Windows/Linux: Hold down Ctrl and then press F5. + +### Step:2 Install FluxCD CRD + +After enabling the feature flags, the next step is to install FluxCD CRD in the same cluster. To do so follow the below steps: + +1. Navigate to Devtron Resource Browser. + +2. Select the same cluster for which you have enabled the feature flags. + +3. Click the **Terminal** tab. + +4. Run the following command to install the FluxCD CRD. + + ```bash + kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml + ``` + +5. After the command executed successfully, you can now deploy or migrate your apps through GitOps (via FluxCD). \ No newline at end of file From 487ea7a933bc033bef7149ab810d4700f35c3a20 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 8 Jul 2025 14:55:52 +0530 Subject: [PATCH 03/31] docs: added migrate FluxCD --- .../workflow/cd-pipeline.md | 44 ++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index 4ff63e280..6b2beffd8 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -35,7 +35,7 @@ This section expects four inputs from you: | Environment | Select the environment where you want to deploy your application | (List of available environments) | | Namespace | Automatically populated based on the selected environment | Not Applicable | | Trigger | When to execute the deployment pipeline | **Automatic**: Deployment triggers automatically when a new image completes the previous stage (build pipeline or another deployment pipeline)
**Manual**: Deployment is not initiated automatically. You can trigger deployment with a desired image. | -| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../integrations/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | +| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../integrations/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | {% hint style="info" %} @@ -407,10 +407,15 @@ You can not only [view your external Argo CD apps](../../applications.md#view-ex {% hint style="warning" %} ### Prerequisites * Your app should be an Argo Helm app ([read about supported tools](https://argo-cd.readthedocs.io/en/stable/user-guide/application_sources/)). + * It must have a single Git source and a single values file. By default, Devtron expects `app-values.yaml` so make sure it is committed to Git. + * GitOps credentials required to commit in the Git repo should be configured in [Global Configurations](../../global-configurations/gitops.md). + * The cluster containing your external Argo applications should be added to Devtron. Refer [Clusters & Environments](../../global-configurations/cluster-and-environments.md). + * The target deployment cluster, its namespace, and its [environment](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster) should be added to Devtron. + * Your Argo CD app must use the same chart type as your application. If needed, you can upload or select the appropriate chart in **Global Configurations** → **Deployment Charts**. Then save the chart type at [base configuration](../deployment-template.md) of your application. * The external Argo CD should have auto-sync enabled or an alternative syncing mechanism, as Devtron does not perform manual syncs. @@ -447,6 +452,43 @@ This feature comes with certain mentioned limitations and expectations. If your If you have configured [GitOps](../gitops-config.md) for your external Argo apps in Devtron, and later install the GitOps (ArgoCD) module from [Devtron Stack Manager](../../integrations/argocd.md) to deploy your Devtron apps/Helm apps via GitOps, you must once again save your GitOps and Cluster configurations after installation. This might prevent potential errors and ensure your GitOps deployments are functional. {% endhint %} +### Migrate Flux CD Application + +You can not only [view your external Flux CD apps](../../applications.md#view-external-fluxcd-app-listing), but also manage their deployments using Devtron's CI/CD. + +{% hint style="warning" %} +### Prerequisites + + * Your app should be a Flux Helm release. + + + * GitOps credentials required to commit in the Git repo should be configured in [Global Configurations](../../global-configurations/gitops.md). + + * The cluster containing your external Flux Helm release applications should be added to Devtron. Refer [Clusters & Environments](../../global-configurations/cluster-and-environments.md). + + * The target deployment cluster, its namespace, and its [environment](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster) should be added to Devtron. + + * The external Flux CD should have auto-sync enabled or an alternative syncing mechanism, as Devtron does not perform manual syncs. + +{% endhint %} + +1. Click **Flux CD Application** in 'Select type of application to migrate'. + +2. Select the external cluster containing your Flux apps, and select the Flux CD application you wish to migrate. + + ![Figure 25: Choosing External Cluster and Flux App from Dropdown](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/choose-cluster-app2.jpg) + +3. The target cluster, its namespace, and environment would be visible. If the environment is not available, click **Add Environment**. This will open a new tab. Once you have [added the environment to your cluster](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster), return and click the refresh button. + + ![Figure 26: Adding Environment to Target](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/add-env-argo.jpg) + +4. Select the trigger (**Automatic/Manual**) and click **Create Pipeline**. + + ![Figure 27: Creating CD Pipeline for Flux CD App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/deploy-mode2.jpg) + +5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Flux CD app would be deployed using Devtron. + --- ## Updating CD Pipeline From 47211e2c3729fddf16ae7f6538451a05edaf14b9 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 8 Jul 2025 17:12:30 +0530 Subject: [PATCH 04/31] docs: technical fixes --- docs/user-guide/integrations/fluxcd.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/integrations/fluxcd.md index e7addd9ad..29c705ed0 100644 --- a/docs/user-guide/integrations/fluxcd.md +++ b/docs/user-guide/integrations/fluxcd.md @@ -22,13 +22,13 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. ## Installation -To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the specific cluster and then install FluxCD CRD on that specific cluster. To do so, follow the below steps: +To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the default cluster in Devtron and then install FluxCD CRD on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: ### Step 1: Enable Feature Flags -1. Navigate to Devtron Resource Browser. +1. Navigate to Devtron **Resource Browser**. -2. Select the cluster for which you want to enable the feature flags. +2. Select the default-cluster to enable the feature flags. 3. Go to Config & Storage → ConfigMap, and select `dashboard-cm` ConfigMap @@ -41,10 +41,14 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" ``` -5. Restart the Pod - 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment. +5. Rotate the pods: + 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Pods. - 2. Click the checkbox next to the `dashboard` Deployment workload and restart it using the ⟳ button. + 2. Select the pod `dashboard-xxxx` in the devtroncd namespace. + + 3. Select the Kebab menu (⋮) next to the `dashboard-xxxx` pod and click **Delete**. + + 4. The pod will spin up automatically again after deletion. 6. Perform a hard refresh of the browser to clear the cache: @@ -54,11 +58,11 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e ### Step:2 Install FluxCD CRD -After enabling the feature flags, the next step is to install FluxCD CRD in the same cluster. To do so follow the below steps: +After enabling the feature flags, the next step is to install FluxCD CRD in every cluster (including default cluster) in which you want to deploy the FluxCD applications. To do so follow the below steps: 1. Navigate to Devtron Resource Browser. -2. Select the same cluster for which you have enabled the feature flags. +2. Select the cluster for which you have enabled the feature flags. 3. Click the **Terminal** tab. @@ -68,4 +72,4 @@ After enabling the feature flags, the next step is to install FluxCD CRD in the kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml ``` -5. After the command executed successfully, you can now deploy or migrate your apps through GitOps (via FluxCD). \ No newline at end of file +5. After the command executed successfully, you can now deploy or migrate your applications through GitOps (via FluxCD) in that cluster. \ No newline at end of file From f0c78772b406d6b4528fbe1dc0434c3f0108a71c Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 9 Jul 2025 11:29:54 +0530 Subject: [PATCH 05/31] docs: content fixed --- docs/user-guide/integrations/fluxcd.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/integrations/fluxcd.md index 29c705ed0..8a17c4484 100644 --- a/docs/user-guide/integrations/fluxcd.md +++ b/docs/user-guide/integrations/fluxcd.md @@ -10,7 +10,7 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. ### Additional Resources [What is FluxCD? A Quick Guide to GitOps with FluxCD](https://devtron.ai/blog/what-is-fluxcd/) - [Choosing the Right GitOps Tool: ArgoCD vs. FluxCD](https://devtron.ai/blog/gitops-tool-selection-argo-cd-or-flux-cd/) + [Choosing the Right GitOps Tool: ArgoCD vs.FluxCD](https://devtron.ai/blog/gitops-tool-selection-argo-cd-or-flux-cd/) {% endhint %} @@ -22,7 +22,7 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. ## Installation -To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the default cluster in Devtron and then install FluxCD CRD on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: +To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the default cluster in Devtron and then install FluxCD controller on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: ### Step 1: Enable Feature Flags @@ -56,9 +56,9 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e * Windows/Linux: Hold down Ctrl and then press F5. -### Step:2 Install FluxCD CRD +### Step:2 Install FluxCD Controller -After enabling the feature flags, the next step is to install FluxCD CRD in every cluster (including default cluster) in which you want to deploy the FluxCD applications. To do so follow the below steps: +After enabling the feature flags, the next step is to install FluxCD Controller in every cluster (including default cluster) in which you want to deploy the FluxCD applications. To do so follow the below steps: 1. Navigate to Devtron Resource Browser. @@ -66,7 +66,7 @@ After enabling the feature flags, the next step is to install FluxCD CRD in ever 3. Click the **Terminal** tab. -4. Run the following command to install the FluxCD CRD. +4. Run the following command to install the FluxCD Controller. ```bash kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml From d4441b847d604553abb4b8b9b5a65bb396bcfa5b Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 15:50:03 +0530 Subject: [PATCH 06/31] docs: optimised for OSS and enteprise --- .../workflow/cd-pipeline.md | 11 ++++++++ docs/user-guide/integrations/fluxcd.md | 25 +++++++++++++------ 2 files changed, 29 insertions(+), 7 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index 6b2beffd8..ffa1e1727 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -489,6 +489,17 @@ You can not only [view your external Flux CD apps](../../applications.md#view-ex 5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Flux CD app would be deployed using Devtron. + +{% hint style="info" %} +### Limitations +This feature comes with certain mentioned limitations and expectations. If your use case doesn't fit and goes beyond, feel free to [**open a feature request**](https://github.com/devtron-labs/devtron/issues). + +* The Git source type should not be branch HEAD. +* The target deployment cluster’s endpoint in Devtron must be the same as the one configured in Argo CD. +* Once onboarded to Devtron, users should manage the application only through Devtron and avoid making changes directly in Git or Argo CD. This is because Devtron might not monitor or reconcile the manual changes you make outside Devtron. +{% endhint %} + + --- ## Updating CD Pipeline diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/integrations/fluxcd.md index 8a17c4484..8bb88ff37 100644 --- a/docs/user-guide/integrations/fluxcd.md +++ b/docs/user-guide/integrations/fluxcd.md @@ -28,7 +28,7 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e 1. Navigate to Devtron **Resource Browser**. -2. Select the default-cluster to enable the feature flags. +2. Select the `default-cluster` to enable the feature flags. 3. Go to Config & Storage → ConfigMap, and select `dashboard-cm` ConfigMap @@ -41,14 +41,25 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" ``` -5. Rotate the pods: - 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Pods. +5. Restart the deployment: - 2. Select the pod `dashboard-xxxx` in the devtroncd namespace. - - 3. Select the Kebab menu (⋮) next to the `dashboard-xxxx` pod and click **Delete**. + * For OSS Users: + 1. Navigate to Devtron Resource Browser. + + 2. Select the cluster for which you have enabled the feature flags. - 4. The pod will spin up automatically again after deletion. + 3. Restart the deployment using the following command: + + ```yaml + kubectl rollout restart deployment dashboard -n devtroncd + ``` + + * For Enterprise Users: + 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment + + 2. Click the checkbox next to the following Deployment workloads and restart them using the ⟳ button: + * devtron + * dashboard 6. Perform a hard refresh of the browser to clear the cache: From bb52f84e3da4012a4f3d3e940b650f79e21187b7 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 18:15:19 +0530 Subject: [PATCH 07/31] docs: added figure and captions --- .../workflow/cd-pipeline.md | 13 +++---- docs/user-guide/integrations/fluxcd.md | 34 +++++++++++++++---- 2 files changed, 34 insertions(+), 13 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index ffa1e1727..768a4459b 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -475,17 +475,19 @@ You can not only [view your external Flux CD apps](../../applications.md#view-ex 1. Click **Flux CD Application** in 'Select type of application to migrate'. + ![Figure 28: Choosing 'Flux CD Application'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-fluxcd.jpg) + 2. Select the external cluster containing your Flux apps, and select the Flux CD application you wish to migrate. - ![Figure 25: Choosing External Cluster and Flux App from Dropdown](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/choose-cluster-app2.jpg) + ![Figure 29: Choosing External Cluster and Flux App from Dropdown](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-app.jpg) 3. The target cluster, its namespace, and environment would be visible. If the environment is not available, click **Add Environment**. This will open a new tab. Once you have [added the environment to your cluster](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster), return and click the refresh button. - ![Figure 26: Adding Environment to Target](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/add-env-argo.jpg) + ![Figure 30: Target Environment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-target-cluster.jpg) 4. Select the trigger (**Automatic/Manual**) and click **Create Pipeline**. - ![Figure 27: Creating CD Pipeline for Flux CD App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/deploy-mode2.jpg) + ![Figure 31: Creating CD Pipeline for Flux CD App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-how-to-deploy.jpg) 5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Flux CD app would be deployed using Devtron. @@ -499,7 +501,6 @@ This feature comes with certain mentioned limitations and expectations. If your * Once onboarded to Devtron, users should manage the application only through Devtron and avoid making changes directly in Git or Argo CD. This is because Devtron might not monitor or reconcile the manual changes you make outside Devtron. {% endhint %} - --- ## Updating CD Pipeline @@ -508,7 +509,7 @@ You can update the deployment stages and the deployment strategy of the CD Pipel To update a CD Pipeline, go to the `App Configurations` section, Click on `Workflow editor` and then click on the CD Pipeline you want to Update. -![Figure 28: Updating CD Pipeline](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/ca-workflow-update.gif) +![Figure 32: Updating CD Pipeline](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/ca-workflow-update.gif) Make changes as needed and click on `Update Pipeline` to update this CD Pipeline. @@ -539,7 +540,7 @@ Please follow the steps mentioned below to create sequential pipelines: 2. To add another CD Pipeline sequentially after previous one, again click on + sign on the last CD pipeline. 3. Similarly, you can add multiple CD pipelines by clicking + sign of the last CD pipeline, each deploying in different environments. -![Figure 29: Adding Multiple CD Pipelines](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/sequential-workflow.jpg) +![Figure 33: Adding Multiple CD Pipelines](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/sequential-workflow.jpg) {% hint style="info" %} ### Tip diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/integrations/fluxcd.md index 8bb88ff37..894ed8cc6 100644 --- a/docs/user-guide/integrations/fluxcd.md +++ b/docs/user-guide/integrations/fluxcd.md @@ -28,18 +28,28 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e 1. Navigate to Devtron **Resource Browser**. -2. Select the `default-cluster` to enable the feature flags. + ![Figure 1: Navigating to Resource Browser](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-resource-browser.jpg) + +2. Select the `default_cluster` to enable the feature flags. + + ![Figure 2: Selecting 'default_cluster'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-cluster.jpg) 3. Go to Config & Storage → ConfigMap, and select `dashboard-cm` ConfigMap + ![Figure 3: Selecting 'dashboard-cm'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-dashboard-cm.jpg) + 4. Edit the `dashboard-cm` ConfigMap by clicking **Edit live manifest**. - * To enable deployments via FluxCD, check if the below entries are present in the ConfigMap (create one if it doesn't exist) and select **Apply changes**. + * To enable deployments via FluxCD, check if the below entries are present in the ConfigMap (create one if it doesn't exist) and select **Apply changes**. - ```yaml - FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true" - FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" - ``` + ```yaml + FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true" + FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" + ``` + + ![Figure 4: Editing Live Manifest](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-edit-live-manifest.jpg) + + ![Figure 5: Adding Feature Flags](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-add-flags.jpg) 5. Restart the deployment: @@ -47,20 +57,28 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e 1. Navigate to Devtron Resource Browser. 2. Select the cluster for which you have enabled the feature flags. + + 3. Click the **Terminal** tab. - 3. Restart the deployment using the following command: + 4. Restart the deployment using the following command: ```yaml kubectl rollout restart deployment dashboard -n devtroncd ``` + ![Figure 6: Restarting Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-restart-deployment.gif) + * For Enterprise Users: 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment 2. Click the checkbox next to the following Deployment workloads and restart them using the ⟳ button: + * devtron + * dashboard + ![Figure 7: Restart 'devtron' and 'dashboard' deployment workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/devtron-intelligence/restart-deployments.jpg) + 6. Perform a hard refresh of the browser to clear the cache: * Mac: Hold down Cmd and Shift and then press R. @@ -83,4 +101,6 @@ After enabling the feature flags, the next step is to install FluxCD Controller kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml ``` + ![Figure 8: Installing FluxCD Controller](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-install-controller.gif) + 5. After the command executed successfully, you can now deploy or migrate your applications through GitOps (via FluxCD) in that cluster. \ No newline at end of file From 71d947a4abf89ca35c9d1402f7ed987a5ad6b8d0 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 19:38:01 +0530 Subject: [PATCH 08/31] docs: fixes --- .../fluxcd.md | 47 ++++++++++--------- .../workflow/cd-pipeline.md | 13 +++-- 2 files changed, 34 insertions(+), 26 deletions(-) rename docs/user-guide/{integrations => creating-application}/fluxcd.md (72%) diff --git a/docs/user-guide/integrations/fluxcd.md b/docs/user-guide/creating-application/fluxcd.md similarity index 72% rename from docs/user-guide/integrations/fluxcd.md rename to docs/user-guide/creating-application/fluxcd.md index 894ed8cc6..b72d51d46 100644 --- a/docs/user-guide/integrations/fluxcd.md +++ b/docs/user-guide/creating-application/fluxcd.md @@ -40,12 +40,12 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e 4. Edit the `dashboard-cm` ConfigMap by clicking **Edit live manifest**. - * To enable deployments via FluxCD, check if the below entries are present in the ConfigMap (create one if it doesn't exist) and select **Apply changes**. + * To enable deployments via FluxCD, check if the below entries are present in the ConfigMap (create one if it doesn't exist) and select **Apply changes**.
- ```yaml - FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true" - FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" - ``` + ```yaml + FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true" + FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true" + ``` ![Figure 4: Editing Live Manifest](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-edit-live-manifest.jpg) @@ -53,31 +53,31 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e 5. Restart the deployment: - * For OSS Users: - 1. Navigate to Devtron Resource Browser. - - 2. Select the cluster for which you have enabled the feature flags. + * For OSS Users: + 1. Navigate to Devtron Resource Browser. - 3. Click the **Terminal** tab. - - 4. Restart the deployment using the following command: + 2. Select the cluster for which you have enabled the feature flags. - ```yaml - kubectl rollout restart deployment dashboard -n devtroncd - ``` + 3. Click the **Terminal** tab. + + 4. Restart the deployment using the following command: - ![Figure 6: Restarting Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-restart-deployment.gif) + ```yaml + kubectl rollout restart deployment dashboard -n devtroncd + ``` +
+ ![Figure 6: Restarting Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-restart-deployment.gif) - * For Enterprise Users: - 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment + * For Enterprise Users: + 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment - 2. Click the checkbox next to the following Deployment workloads and restart them using the ⟳ button: + 2. Click the checkbox next to the following Deployment workloads and restart them using the ⟳ button: - * devtron + * devtron - * dashboard + * dashboard - ![Figure 7: Restart 'devtron' and 'dashboard' deployment workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/devtron-intelligence/restart-deployments.jpg) + ![Figure 7: Restart 'devtron' and 'dashboard' deployment workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/devtron-intelligence/restart-deployments.jpg) 6. Perform a hard refresh of the browser to clear the cache: @@ -95,11 +95,12 @@ After enabling the feature flags, the next step is to install FluxCD Controller 3. Click the **Terminal** tab. -4. Run the following command to install the FluxCD Controller. +4. Run the following command to install the FluxCD Controller:
```bash kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml ``` +
![Figure 8: Installing FluxCD Controller](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-install-controller.gif) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index 768a4459b..a2840fb67 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -35,7 +35,12 @@ This section expects four inputs from you: | Environment | Select the environment where you want to deploy your application | (List of available environments) | | Namespace | Automatically populated based on the selected environment | Not Applicable | | Trigger | When to execute the deployment pipeline | **Automatic**: Deployment triggers automatically when a new image completes the previous stage (build pipeline or another deployment pipeline)
**Manual**: Deployment is not initiated automatically. You can trigger deployment with a desired image. | -| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../integrations/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | +| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../creating-application/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | + +{% hint style="warning" %} +### FluxCD Deployment Failed +Make sure that FluxCD controller must be installed in the cluster in which you want to deploy the application. Refer [GitOps (Flux CD)](../../creating-application/fluxcd.md#step2-install-fluxcd-controller) to learn more. +{% endhint %} {% hint style="info" %} @@ -460,8 +465,10 @@ You can not only [view your external Flux CD apps](../../applications.md#view-ex ### Prerequisites * Your app should be a Flux Helm release. - + + * The Helm chart values will be referenced from the file (e.g., values.yaml) mentioned in the helm release at `spec.chart.spec.valuesFiles`, otherwise, they will be taken from `spec.extFluxValues`. + + * Devtron only supports [Refer to values inside the chart](https://fluxcd.io/flux/guides/helmreleases/#refer-to-values-inside-the-chart) only. * GitOps credentials required to commit in the Git repo should be configured in [Global Configurations](../../global-configurations/gitops.md). From 54cb50a082dd2d855c38229c996f99e0d26a8c80 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 21:05:57 +0530 Subject: [PATCH 09/31] docs: optimised for gitbook --- .../user-guide/creating-application/fluxcd.md | 30 +++++++++++-------- .../workflow/cd-pipeline.md | 4 +-- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/user-guide/creating-application/fluxcd.md b/docs/user-guide/creating-application/fluxcd.md index b72d51d46..fba53ab30 100644 --- a/docs/user-guide/creating-application/fluxcd.md +++ b/docs/user-guide/creating-application/fluxcd.md @@ -1,10 +1,13 @@ # GitOps (Flux CD) -## Prerequisite +{% hint style="info" %} +### Prerequisite - Please make sure to install **Build and Deploy (CI/CD)** integration. To install it, click [here](../integrations/build-and-deploy-ci-cd.md). +Please make sure to install **Build and Deploy (CI/CD)** integration. To install it, click [here](../integrations/build-and-deploy-ci-cd.md). -Devtron supports FluxCD to help you manage application deployments using GitOps. With FluxCD, your Git repository becomes the single source of truth for your Kubernetes apps. Any changes you make in Git are automatically applied to your Kubernetes cluster by FluxCD. Learn more in the [FluxCD documentation](https://fluxcd.io/flux/) +{% endhint %} + +Devtron supports FluxCD to help you manage application deployments using GitOps. With FluxCD, your Git repository becomes the single source of truth for your Kubernetes apps. Any changes you make in Git are automatically applied to your Kubernetes cluster by FluxCD. Refer the [FluxCD documentation](https://fluxcd.io/flux/) to learn more. {% hint style="info" %} ### Additional Resources @@ -22,7 +25,7 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. ## Installation -To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the default cluster in Devtron and then install FluxCD controller on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: +To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the `default_cluster` in **Devtron** and then install FluxCD controller on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: ### Step 1: Enable Feature Flags @@ -53,7 +56,7 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e 5. Restart the deployment: - * For OSS Users: + * For OSS Users: 1. Navigate to Devtron Resource Browser. 2. Select the cluster for which you have enabled the feature flags. @@ -66,24 +69,25 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e kubectl rollout restart deployment dashboard -n devtroncd ```
+ ![Figure 6: Restarting Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-restart-deployment.gif) - * For Enterprise Users: - 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment + * For Enterprise Users: + 1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment - 2. Click the checkbox next to the following Deployment workloads and restart them using the ⟳ button: + 2. Click the checkbox next to the following Deployment workloads and restart them using the ⟳ button: - * devtron + * devtron - * dashboard + * dashboard - ![Figure 7: Restart 'devtron' and 'dashboard' deployment workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/devtron-intelligence/restart-deployments.jpg) + ![Figure 7: Restart 'devtron' and 'dashboard' deployment workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/devtron-intelligence/restart-deployments.jpg) 6. Perform a hard refresh of the browser to clear the cache: - * Mac: Hold down Cmd and Shift and then press R. + * Mac: Hold down Cmd and Shift and then press R. - * Windows/Linux: Hold down Ctrl and then press F5. + * Windows/Linux: Hold down Ctrl and then press F5. ### Step:2 Install FluxCD Controller diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index a2840fb67..9eff4ea80 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -120,14 +120,14 @@ Make sure your cluster has [devtron-agent](../../global-configurations/cluster-a * After the deployment, edit the devtron-cm configmap and add the following key-value pair: - ```bash + ```bash ORCH_HOST: /orchestrator/webhook/msg/nats Example: ORCH_HOST: http://xyz.devtron.com/orchestrator/webhook/msg/nats - ``` + ``` `ORCH_HOST` value should be same as of `CD_EXTERNAL_LISTENER_URL` value which is passed in values.yaml. From 89b84440ee2e313697b341f492260fbc59970b1f Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 22:35:01 +0530 Subject: [PATCH 10/31] docs: added enterprise tagging --- docs/user-guide/creating-application/workflow/cd-pipeline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index 9eff4ea80..e916ea242 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -35,7 +35,7 @@ This section expects four inputs from you: | Environment | Select the environment where you want to deploy your application | (List of available environments) | | Namespace | Automatically populated based on the selected environment | Not Applicable | | Trigger | When to execute the deployment pipeline | **Automatic**: Deployment triggers automatically when a new image completes the previous stage (build pipeline or another deployment pipeline)
**Manual**: Deployment is not initiated automatically. You can trigger deployment with a desired image. | -| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../creating-application/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | +| Deployment Approach | How to deploy the application | **Helm**, [GitOps(ArgoCD)](../../integrations/argocd.md) or [Gitops (FluxCD)](../../creating-application/fluxcd.md)
Refer [GitOps](../../global-configurations/gitops.md) to learn more | {% hint style="warning" %} ### FluxCD Deployment Failed From 0cb055e2a5ec546decc6f1c75202276a1f75d3d8 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 22:39:45 +0530 Subject: [PATCH 11/31] docs: added rbac --- docs/user-guide/creating-application/fluxcd.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/user-guide/creating-application/fluxcd.md b/docs/user-guide/creating-application/fluxcd.md index fba53ab30..0459bb626 100644 --- a/docs/user-guide/creating-application/fluxcd.md +++ b/docs/user-guide/creating-application/fluxcd.md @@ -25,6 +25,13 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. ## Installation +{% hint style="warning" %} +### Who Can Perform This Action? +User must have permissions to: + * Edit the ConfigMaps of 'default-cluster' + * Restart the pods +{% endhint %} + To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the `default_cluster` in **Devtron** and then install FluxCD controller on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: ### Step 1: Enable Feature Flags From 589282bfed65070953bb03659c4a55e39bb0a4b5 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 10 Jul 2025 22:42:19 +0530 Subject: [PATCH 12/31] docs: gitbook optimizations --- .../creating-application/workflow/cd-pipeline.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index e916ea242..8008421ad 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -482,19 +482,19 @@ You can not only [view your external Flux CD apps](../../applications.md#view-ex 1. Click **Flux CD Application** in 'Select type of application to migrate'. - ![Figure 28: Choosing 'Flux CD Application'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-fluxcd.jpg) + ![Figure 28: Choosing 'Flux CD Application'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-fluxcd.jpg) 2. Select the external cluster containing your Flux apps, and select the Flux CD application you wish to migrate. - ![Figure 29: Choosing External Cluster and Flux App from Dropdown](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-app.jpg) + ![Figure 29: Choosing External Cluster and Flux App from Dropdown](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-app.jpg) 3. The target cluster, its namespace, and environment would be visible. If the environment is not available, click **Add Environment**. This will open a new tab. Once you have [added the environment to your cluster](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster), return and click the refresh button. - ![Figure 30: Target Environment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-target-cluster.jpg) + ![Figure 30: Target Environment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-target-cluster.jpg) 4. Select the trigger (**Automatic/Manual**) and click **Create Pipeline**. - ![Figure 31: Creating CD Pipeline for Flux CD App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-how-to-deploy.jpg) + ![Figure 31: Creating CD Pipeline for Flux CD App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-how-to-deploy.jpg) 5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Flux CD app would be deployed using Devtron. From 559de95366e5103792aacf52a955aff62fa01d29 Mon Sep 17 00:00:00 2001 From: Arpit Agrawal Date: Fri, 11 Jul 2025 11:57:05 +0530 Subject: [PATCH 13/31] docs: minor fixes docs: minor fixes --- docs/user-guide/creating-application/fluxcd.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/creating-application/fluxcd.md b/docs/user-guide/creating-application/fluxcd.md index 0459bb626..fd1ddead1 100644 --- a/docs/user-guide/creating-application/fluxcd.md +++ b/docs/user-guide/creating-application/fluxcd.md @@ -7,7 +7,7 @@ Please make sure to install **Build and Deploy (CI/CD)** integration. To install {% endhint %} -Devtron supports FluxCD to help you manage application deployments using GitOps. With FluxCD, your Git repository becomes the single source of truth for your Kubernetes apps. Any changes you make in Git are automatically applied to your Kubernetes cluster by FluxCD. Refer the [FluxCD documentation](https://fluxcd.io/flux/) to learn more. +Devtron supports FluxCD to help you manage application deployments using GitOps. With FluxCD, your Git repository becomes the single source of truth for your Kubernetes apps. Any changes you make in Git are automatically applied to your Kubernetes cluster by FluxCD. Refer to the [FluxCD documentation](https://fluxcd.io/flux/) to learn more. {% hint style="info" %} ### Additional Resources @@ -27,12 +27,12 @@ Devtron supports FluxCD to help you manage application deployments using GitOps. {% hint style="warning" %} ### Who Can Perform This Action? -User must have permissions to: +The user must have permissions to: * Edit the ConfigMaps of 'default-cluster' * Restart the pods {% endhint %} -To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the `default_cluster` in **Devtron** and then install FluxCD controller on that clusters in which you want to deploy the FluxCD applications. To do so, follow the below steps: +To enable deployments through GitOps via FluxCD or if you want to migrate your existing FluxCD application to Devtron, you need to enable two specific feature flags for the `default_cluster` in **Devtron** and then install the FluxCD controller on those clusters in which you want to deploy the FluxCD applications. To do so, follow the steps below: ### Step 1: Enable Feature Flags @@ -96,9 +96,9 @@ To enable deployments through GitOps via FluxCD or if you want to migrate your e * Windows/Linux: Hold down Ctrl and then press F5. -### Step:2 Install FluxCD Controller +### Step 2: Install FluxCD Controller -After enabling the feature flags, the next step is to install FluxCD Controller in every cluster (including default cluster) in which you want to deploy the FluxCD applications. To do so follow the below steps: +After enabling the feature flags, the next step is to install FluxCD Controller in every cluster (including the default cluster) in which you want to deploy the FluxCD applications. To do so, follow the steps below: 1. Navigate to Devtron Resource Browser. @@ -115,4 +115,4 @@ After enabling the feature flags, the next step is to install FluxCD Controller ![Figure 8: Installing FluxCD Controller](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-install-controller.gif) -5. After the command executed successfully, you can now deploy or migrate your applications through GitOps (via FluxCD) in that cluster. \ No newline at end of file +5. After the command is executed successfully, you can deploy or migrate your applications in that cluster through GitOps (via FluxCD). From e9b2fdea4298aa9a1dd92e03289215ec3277803b Mon Sep 17 00:00:00 2001 From: Arpit Agrawal Date: Fri, 11 Jul 2025 12:00:09 +0530 Subject: [PATCH 14/31] docs: minor fixes docs: minor fixes --- .../workflow/cd-pipeline.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index 8008421ad..f8f7ff3d4 100644 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -13,7 +13,7 @@ A basic `Create deployment pipeline` window will pop up. ![Figure 2: Creating CD Pipeline](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/new-cd-pipeline.jpg) Here, you get two tabs: -* [New Deployment](#new-deployment) - Use this option to create new Helm/GitOps deployment. +* [New Deployment](#new-deployment) - Use this option to create a new Helm/GitOps deployment. * [Migrate to Devtron](#migrate-to-devtron) - Use this option if you wish to migrate your existing Helm Release/Argo CD Apps to Devtron. --- @@ -39,7 +39,7 @@ This section expects four inputs from you: {% hint style="warning" %} ### FluxCD Deployment Failed -Make sure that FluxCD controller must be installed in the cluster in which you want to deploy the application. Refer [GitOps (Flux CD)](../../creating-application/fluxcd.md#step2-install-fluxcd-controller) to learn more. +Make sure that the FluxCD controller is installed in the cluster in which you want to deploy the application. Refer [GitOps (Flux CD)](../../creating-application/fluxcd.md#step2-install-fluxcd-controller) to learn more. {% endhint %} {% hint style="info" %} @@ -60,7 +60,7 @@ Devtron supports multiple deployment strategies depending on the [deployment cha ![Figure 3: Strategies Supported by Chart Type](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/chart-and-strategy.jpg) -Refer [Deployment Strategies](#deployment-strategies) to know more about each strategy in depth. +Refer to [Deployment Strategies](#deployment-strategies) to know more about each strategy in depth. The next section is [Advanced Options](#advanced-options) and it comes with additional capabilities. This option is available at the bottom of the `Create deployment pipeline` window. However, if you don't need them, you may proceed with a basic CD pipeline and click **Create Pipeline**. @@ -102,7 +102,7 @@ If you want to use some configuration files and secrets in pre-deployment stages 4. **Execute tasks in application environment** -These `Pre-deployment CD / Post-deployment CD` pods can be created in your deployment cluster or the devtron build cluster. If your scripts/tasks has some dependency on the deployment environment, you may run these pods in the deployment cluster. Thus, your scripts \(if any\) can interact with the cluster services that may not be publicly exposed. +These `Pre-deployment CD / Post-deployment CD` pods can be created in your deployment cluster or the Devtron build cluster. If your scripts/tasks have some dependency on the deployment environment, you may run these pods in the deployment cluster. Thus, your scripts \(if any\) can interact with the cluster services that may not be publicly exposed. Some tasks require extra permissions for the node where Devtron is installed. However, if the node already has the necessary permissions for deploying applications, there is no need to assign them again. Instead, you can enable the **Execute tasks in application environment** option for the pre-CD or post-CD steps. By default, this option is disabled. @@ -143,7 +143,7 @@ Make sure your cluster has [devtron-agent](../../global-configurations/cluster-a ![Figure 9: 'migration-incluster-cd' chart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/migration-incluster-chart.jpg) -* Edit the `cluster-name` and `secret name` values within the chart. The `cluster name` refers to the name used when adding the cluster in the global configuration and for which you are going to enable `Execute tasks in application environment` option. +* Edit the `cluster-name` and `secret name` values within the chart. The `cluster name` refers to the name used when adding the cluster in the global configuration, and for which you are going to enable the `Execute tasks in application environment` option. ![Figure 10: Configuration](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/migration-incluster.jpg) @@ -153,7 +153,7 @@ Make sure your cluster has [devtron-agent](../../global-configurations/cluster-a #### Pipeline Name -Pipeline name will be auto-generated; however, you are free to modify the name as per your requirement. +The pipeline name will be auto-generated; however, you are free to modify the name as per your requirement.