Skip to content
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

docs: Fixes + Corrections in Docs #5335

Merged
merged 3 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/FAQs/devtron-troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ kubectl get pods -n devtroncd
kubectl delete jobs <job1-name> <job2-name> -n devtroncd
```

- Now download `migrator.yaml` file from our github repository using the command:
- Now download `migrator.yaml` file from our GitHub repository using the command:
```bash
wget https://raw.githubusercontent.com/devtron-labs/devtron/main/manifests/yamls/migrator.yaml
```
Expand Down
1 change: 0 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@
* [CI Pipeline](user-guide/creating-application/workflow/ci-pipeline.md)
* [Pre-Build/Post-Build Stages](user-guide/creating-application/workflow/ci-build-pre-post-plugins.md)
* [Override Build Configuration](user-guide/creating-application/container-registry-override.md)
* [CI Pipeline (Legacy)](user-guide/creating-application/workflow/ci-pipeline-legacy.md)
* [CD Pipeline](user-guide/creating-application/workflow/cd-pipeline.md)
* [ConfigMaps](user-guide/creating-application/config-maps.md)
* [Secrets](user-guide/creating-application/secrets.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ However, in case you don't have a Dockerfile, Devtron helps you create one. Go t

Evacuating pods from a node before cordoning it, ensuring that running pods are gracefully rescheduled on other nodes.

In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/clusters.md#drain-a-node)
In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/resource-browser.md#drain-a-node)

### Environment

Expand Down Expand Up @@ -164,7 +164,7 @@ In Devtron, you can view a list of namespaces by going to Resource Browser → (

A setting applied to a node that influences the scheduling of pods. Taints can restrict which pods are allowed to run on the node.

In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/clusters.md#taint-a-node)
In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/resource-browser.md#taint-a-node)

### NodePort

Expand All @@ -174,7 +174,7 @@ A Kubernetes service type that exposes a port on each node in the cluster, makin

The physical or virtual machines that make up a Kubernetes cluster, where containers are scheduled to run.

In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/clusters.md#nodes)
In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/resource-browser.md#nodes)

### Objects

Expand Down
15 changes: 11 additions & 4 deletions docs/user-guide/creating-application/environment-overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

You will see all your environments associated with an application under the `Environment Overrides` section.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override.jpg)
![Figure 1: App Configuration → Environment Overrides](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override-v2.jpg)


You can customize your `Deployment template, ConfigMap, Secrets` in Environment Overrides section to add separate customizations for different environments such as dev, test, integration, prod, etc.
Expand Down Expand Up @@ -50,9 +50,16 @@ The same goes for `ConfigMap` and `Secrets`. You can also create an environment-

If you want to configure your ConfigMap and secrets at the application level then you can provide them in [ConfigMaps](config-maps.md) and [Secrets](secrets.md), but if you want to have environment-specific ConfigMap and secrets then provide them under the Environment override Section. At the time of deployment, it will pick both of them and provide them inside your cluster.

Click on `Update ConfigMap` to update Configmaps.
To update a ConfigMap, follow the steps below:
1. In your environment, click **ConfigMaps**.
2. Click the ConfigMap you wish to update.
3. Click **Allow Override**.
4. Edit your ConfigMap.
5. Click **Save Changes**.

Click on `Update Secrets` to update Secrets.
![Figure 2: Updating ConfigMap](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/update-configmap.gif)

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/arora4.gif)
Similarly, you can update Secrets too as shown below.

![Figure 3: Updating Secret](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/update-secret.gif)

18 changes: 10 additions & 8 deletions docs/user-guide/creating-application/gitops-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,23 +59,25 @@ You can [deploy a helm chart](../deploy-chart/overview-of-charts.md#deploying-ch

![Figure 6: Configure & Deploy Button](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/configure-deploy.jpg)

3. After you enter the `App Name`, `Project`, and `Environment`; an option to choose the deployment approach (i.e., Helm or GitOps) would appear.
3. After you enter the `App Name`, `Project`, and `Environment`; an option to choose the deployment approach (i.e., Helm or GitOps) would appear. Select **GitOps**.

![Figure 7: Deployment Approach](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/deployment-method.jpg)
{% hint style="info" %}
The option to choose between 'Helm' or 'GitOps' is only available in <img src="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg">
{% endhint %}

4. Select **GitOps**.
![Figure 7a: Deployment Approach](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/deployment-method.jpg)

![Figure 8: Selecting GitOps Method](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/select-gitops.jpg)
![Figure 7b: Selecting GitOps Method](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/select-gitops.jpg)

5. A modal window will appear for you to enter a Git repository. Just like [Devtron Apps](#for-devtron-apps) (step 2), you get two options:
4. A modal window will appear for you to enter a Git repository. Just like [Devtron Apps](#for-devtron-apps) (step 2), you get two options:
* Auto-create repository
* Commit manifests to a desired repository

![Figure 9: Adding a Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/git-repository-helm-app.jpg)
![Figure 8: Adding a Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/git-repository-helm-app.jpg)

6. Enter your custom Git Repo URL, and click **Save**.
5. Enter your custom Git Repo URL, and click **Save**.

![Figure 10: Saved GitOps Config for Helm App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/custom-git-repo-helm-apps.jpg)
![Figure 9: Saved GitOps Config for Helm App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/custom-git-repo-helm-apps.jpg)

Next, you may proceed to deploy the chart.

Expand Down
Loading
Loading