Skip to content

Commit 5a57f33

Browse files
committed
docs: implmented requested changes
1 parent eb76c17 commit 5a57f33

File tree

1 file changed

+24
-27
lines changed
  • docs/user-guide/creating-application

1 file changed

+24
-27
lines changed

docs/user-guide/creating-application/fluxcd.md

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
{% hint style="info" %}
44
### Prerequisite
55

6-
Please make sure to install
6+
Make sure to install:
77

8-
1. **Build and Deploy (CI/CD)** integration. To install it, click [here](../integrations/build-and-deploy-ci-cd.md).
8+
1. **Build and Deploy (CI/CD)** integration. To install it, click [Build and Deploy (CI/CD) integration)](../integrations/build-and-deploy-ci-cd.md).
99

10-
2. **GitOps (ArgoCD)** integration. To install it, click [here](../integrations/argocd.md).
10+
2. **GitOps (ArgoCD)** integration. To install it, click [GitOps (ArgoCD) integration](../integrations/argocd.md).
1111

1212
{% endhint %}
1313

@@ -31,12 +31,12 @@ The user must have permissions to:
3131
* Restart the pods
3232
{% endhint %}
3333

34-
To enable deployments through GitOps via FluxCD, you need to enable a specific feature flag for the `default_cluster` in **Devtron**.
34+
To enable deployments through GitOps via FluxCD, you need to enable a specific feature flag for the `default_cluster` in Devtron.
3535

3636
|Feature|Flag|Description|
3737
|:---|:---|:---|
38-
|**Deployments via FluxCD**|`FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true"`|This Flag will enable deployments through GitOps via FluxCD.<ul><li> After enabling this flag, you also need to install FluxCD controller in order to deploy applications successfully. Refer [Installing FluxCD Controller](#installing-fluxcd-controller) to know more.</li></ul>|
39-
|**Migrating existing FluxCD applications**|`FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true"`|This Flag will enable migrations for external FluxCD apps into Devtron.|
38+
|**Deployments via FluxCD**|`FEATURE_FLUX_DEPLOYMENTS_ENABLE: " true"`|This flag will enable deployments through GitOps via FluxCD.<ul><li> After enabling this flag, you also need to install FluxCD controller in order to deploy applications successfully. Refer [Installing FluxCD Controller](#installing-fluxcd-controller) to know more.</li></ul>|
39+
|**Migrating existing FluxCD applications**|`FEATURE_LINK_EXTERNAL_FLUX_ENABLE: "true"`|This flag will enable migrations for external FluxCD apps into Devtron.|
4040

4141
{% hint style="warning" %}
4242
### Deployment Strategies for FluxCD Deployments
@@ -46,20 +46,21 @@ To enable deployments through GitOps via FluxCD, you need to enable a specific f
4646

4747
### Enabling Feature Flags
4848

49-
1. Navigate to Devtron **Resource Browser**.
49+
1. Navigate to Devtron's **Resource Browser**.
5050

5151
![Figure 1: Navigating to Resource Browser](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-resource-browser.jpg)
5252

5353
2. Select the `default_cluster` to enable the feature flags.
5454

5555
![Figure 2: Selecting 'default_cluster'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-cluster.jpg)
5656

57-
3. Go to Config & Storage → ConfigMap, and select `dashboard-cm` ConfigMap
57+
3. Go to Config & Storage → ConfigMap, and click `dashboard-cm` ConfigMap
5858

59-
![Figure 3: Selecting 'dashboard-cm'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-dashboard-cm.jpg)
59+
![Figure 3: Clicking 'dashboard-cm'](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-dashboard-cm.jpg)
6060

6161
4. Edit the `dashboard-cm` ConfigMap by clicking **Edit live manifest**.
6262

63+
![Figure 4: Editing Live Manifest](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-edit-live-manifest.jpg)
6364
1. 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**.<br>
6465

6566
```yaml
@@ -73,14 +74,12 @@ To enable deployments through GitOps via FluxCD, you need to enable a specific f
7374
```
7475
7576
<br>
76-
77-
![Figure 4: Editing Live Manifest](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-edit-live-manifest.jpg)
7877
7978
![Figure 5: Adding Feature Flags](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-add-flags.jpg)
8079
8180
5. Restart the deployment:
82-
1. For OSS Users:
83-
1. Navigate to Devtron Resource Browser.
81+
1. **For OSS Users:**
82+
1. Navigate to Devtron's Resource Browser.
8483
8584
2. Select the cluster for which you have enabled the feature flags.
8685
@@ -91,21 +90,20 @@ To enable deployments through GitOps via FluxCD, you need to enable a specific f
9190
```yaml
9291
kubectl rollout restart deployment dashboard -n devtroncd
9392
```
94-
<br>
9593

9694
![Figure 6: Restarting Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-restart-deployment.gif)
97-
2. For Enterprise Users:
98-
1. Go to Resource Browser → (Select Cluster in which you have enabled the feature flags) → Workloads → Deployment
95+
2. **For Enterprise Users:**
96+
1. Go to **Resource Browser** → (select the cluster in which you have enabled the feature flags) → **Workloads****Deployment**
9997

100-
2. Click the checkbox next to the `dashboard` Deployment workloads and restart them using the button.
98+
2. Click the checkbox next to the `dashboard` Deployment workloads and restart them using the `⟳` button.
10199

102100
![Figure 7: Restart 'dashboard' deployment workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/devtron-intelligence/restart-deployments.jpg)
103101

104102
6. Perform a hard refresh of the browser to clear the cache:
105103

106-
* Mac: Hold down Cmd and Shift and then press R.
104+
* **Mac**: Hold down Cmd and Shift and then press R.
107105

108-
* Windows/Linux: Hold down Ctrl and then press F5.
106+
* **Windows/Linux**: Hold down Ctrl and then press F5.
109107

110108
### Installing FluxCD Controller (Only for Deployments)
111109

@@ -120,20 +118,19 @@ You can install FluxCD Controller via two ways:
120118

121119
#### Install FluxCD controller via Cluster Terminal.
122120

123-
1. Navigate to Devtron Resource Browser.
121+
1. Navigate to Devtron's Resource Browser.
124122

125123
2. Select the cluster for which you have enabled the feature flags.
126124

127125
3. Click the **Terminal** tab.
128126

129-
4. Run the following command to install the FluxCD Controller:<br>
127+
4. Run the following command to install the FluxCD Controller:
130128

131-
```bash
132-
kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml
133-
```
134-
<br>
129+
```yaml
130+
kubectl apply -f https://github.com/fluxcd/flux2/releases/download/v0.35.0/install.yaml
131+
```
135132

136-
![Figure 8: Installing FluxCD Controller](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-install-controller.gif)
133+
![Figure 8: Installing FluxCD Controller](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-install-controller.gif)
137134

138135
5. After the command is executed successfully, you can deploy or migrate your applications in that cluster through GitOps (via FluxCD).
139136

@@ -149,7 +146,7 @@ To install FluxCD controller via Chart Store, follow the below steps.
149146

150147
![Figure 10: Adding Environment linked to 'flux-system' namespace](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-add-env.gif)
151148

152-
3. Navigate to Chart Store and select the `flux2` chart.
149+
3. Navigate to **Chart Store** and select the `flux2` chart.
153150

154151
![Figure 11: Selecting 'flux2' Chart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-flux2.jpg)
155152

0 commit comments

Comments
 (0)