Skip to content

Commit a306434

Browse files
docs: Added Videos + Fixed Typos and Navigation (#4169)
* Added Videos + Fixed Typos and Navigation * Added another unlinked tutorial
1 parent f0247e2 commit a306434

File tree

5 files changed

+89
-41
lines changed

5 files changed

+89
-41
lines changed

docs/SUMMARY.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
* [Introduction](README.md)
44
* [Getting Started](setup/getting-started/getting-started.md)
55
* [Install Devtron](setup/install/README.md)
6-
* [Install Devtron with CI/CD Integration](setup/install/install-devtron-with-cicd.md)
7-
* [Install Devtron with CI/CD along with GitOps (Argo CD)](setup/install/install-devtron-with-cicd-with-gitops.md)
8-
* [Install Devtron](setup/install/install-devtron.md)
6+
* [Install Devtron with CI/CD](setup/install/install-devtron-with-cicd.md)
7+
* [Install Devtron with CI/CD and GitOps (Argo CD)](setup/install/install-devtron-with-cicd-with-gitops.md)
8+
* [Install Devtron without Integrations](setup/install/install-devtron.md)
99
* [Install Devtron on Minikube, Microk8s, K3s, Kind](setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md)
10+
* [Demo on Popular Cloud Providers](setup/install/demo-tutorials.md)
1011
* [Backup for Disaster Recovery](setup/install/devtron-backup.md)
11-
* [FAQ on Installation](setup/install/faq-on-installation.md)
1212
* [Uninstall Devtron](setup/install/uninstall-devtron.md)
13+
* [FAQs](setup/install/faq-on-installation.md)
1314
* [Devtron Kubernetes Client](setup/install/install-devtron-Kubernetes-client.md)
1415
* [Configurations](setup/configurations/configurations-overview.md)
1516
* [Installation Configurations](setup/install/installation-configuration.md)
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Demo Tutorials
2+
3+
Here we have demonstrated the installation of Devtron on popular cloud providers. The videos are easy to follow and provide step-by-step instructions.
4+
5+
## Installing on EKS Cluster
6+
7+
**Cloud Provider**: [Amazon Web Services (AWS)](https://aws.amazon.com/)
8+
9+
{% embed url="https://www.youtube.com/watch?v=eY2vudE5jFM" caption="Installing Devtron on AWS" %}
10+
11+
---
12+
13+
## Installing on AKS Cluster
14+
15+
**Cloud Provider**: [Microsoft Azure](https://azure.microsoft.com/)
16+
17+
{% embed url="https://www.youtube.com/watch?v=8ZdhwJQ-IU4" caption="Installing Devtron on Azure" %}
18+
19+
---
20+
21+
## Installing on GKE Cluster
22+
23+
**Cloud Provider**: [Google Cloud Platform (GCP)](https://console.cloud.google.com/)
24+
25+
{% embed url="https://www.youtube.com/watch?v=7UN_Fbo3VMM" caption="Installing Devtron on Google Cloud" %}

docs/setup/install/install-devtron-with-cicd.md

Lines changed: 50 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
1-
# Install Devtron with CICD
1+
# Install Devtron with CI/CD
22

33
In this section, we describe the steps in detail on how you can install Devtron with CI/CD integration.
44

5+
---
56

6-
## Before you begin
7+
## Pre-requisites
78

8-
Install [Helm](https://helm.sh/docs/intro/install/), if you have not installed it.
9+
Install [Helm](https://helm.sh/docs/intro/install/), if you have not installed it already.
910

11+
{% hint style="info" %}
12+
If you are using EKS version 1.23 or above, you must also install [aws-ebs-csi-driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html).
1013

11-
## Install Devtron with CI/CD
14+
Run the following command to install AWS EBS CSI driver using Helm:
15+
16+
```bash
17+
helm repo add aws-ebs-csi-driver \
18+
https://kubernetes-sigs.github.io/aws-ebs-csi-driver \
19+
helm repo update \
20+
helm upgrade --install aws-ebs-csi-driver \
21+
--namespace kube-system aws-ebs-csi-driver/aws-ebs-csi-driver
22+
```
23+
{% endhint %}
24+
25+
---
26+
27+
## Command
1228

1329
Run the following command to install the latest version of Devtron along with the CI/CD module:
1430

@@ -20,34 +36,23 @@ helm install devtron devtron/devtron-operator \
2036
--set installer.modules={cicd}
2137
```
2238

23-
**Note**: If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-duing-installation).
24-
25-
26-
## Install AWS EBS CSI Driver, if require
27-
28-
If you are using EKS version 1.23 or above, you must install [aws-ebs-csi-driver](https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html).
39+
{% hint style="info" %}
40+
If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-duing-installation).
41+
{% endhint %}
2942

30-
31-
Run the following command to install aws ebs csi driver using Helm:
32-
33-
```bash
34-
helm repo add aws-ebs-csi-driver \
35-
https://kubernetes-sigs.github.io/aws-ebs-csi-driver \
36-
helm repo update \
37-
helm upgrade --install aws-ebs-csi-driver \
38-
--namespace kube-system aws-ebs-csi-driver/aws-ebs-csi-driver
39-
```
43+
---
4044

4145
## Install Multi-Architecture Nodes (ARM and AMD)
4246

4347
To install Devtron on clusters with the multi-architecture nodes (ARM and AMD), append the Devtron installation command with `--set installer.arch=multi-arch`.
4448

45-
**Note**:
49+
{% hint style="info" %}
50+
If you want to install Devtron for `production deployments`, please refer our [recommended overrides](override-default-devtron-installation-configs.md) for Devtron Installation.
51+
{% endhint %}
4652

47-
* If you want to install Devtron for `production deployments`, please refer to our recommended overrides for [Devtron Installation](override-default-devtron-installation-configs.md).
53+
---
4854

49-
50-
## Configure Blob Storage duing Installation
55+
## Configure Blob Storage during Installation
5156

5257
Configuring Blob Storage in your Devtron environment allows you to store build logs and cache.
5358
In case, if you do not configure the Blob Storage, then:
@@ -178,12 +183,15 @@ helm install devtron devtron/devtron-operator \
178183
{% endtab %}
179184
{% endtabs %}
180185

186+
---
181187

182188
## Check Status of Devtron Installation
183189

184-
**Note**: The installation takes about 15 to 20 minutes to spin up all of the Devtron microservices one by one.
190+
{% hint style="info" %}
191+
The installation takes about 15 to 20 minutes to spin up all of the Devtron microservices one by one
192+
{% endhint %}
185193

186-
Run the following command to check the status of the installation:
194+
Run the following command to check the status of the installation:
187195

188196
```bash
189197
kubectl -n devtroncd get installers installer-devtron \
@@ -197,16 +205,19 @@ The command executes with one of the following output messages, indicating the s
197205
| `Downloaded` | The installer has downloaded all the manifests, and the installation is in progress. |
198206
| `Applied` | The installer has successfully applied all the manifests, and the installation is completed. |
199207

208+
---
200209

201-
## Check the installer logs
210+
## Check the Installer Logs
202211

203212
Run the following command to check the installer logs:
204213

205214
```bash
206215
kubectl logs -f -l app=inception -n devtroncd
207216
```
208217

209-
## Devtron dashboard
218+
---
219+
220+
## Devtron Dashboard
210221

211222
Run the following command to get the Devtron dashboard URL:
212223

@@ -223,17 +234,21 @@ You will get an output similar to the example shown below:
223234
224235
Use the hostname `aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com` (Loadbalancer URL) to access the Devtron dashboard.
225236
226-
**Note**: If you do not get a hostname or receive a message that says "service doesn't exist," it means Devtron is still installing.
227-
Please wait until the installation is completed.
237+
{% hint style="info" %}
238+
If you do not get a hostname or receive a message that says "service doesn't exist," it means Devtron is still installing. Please wait until the installation is completed.
239+
{% endhint %}
228240
229-
**Note**: You can also use a `CNAME` entry corresponding to your domain/subdomain to point to the Loadbalancer URL to access at a customized domain.
241+
{% hint style="info" %}
242+
You can also use a `CNAME` entry corresponding to your domain/subdomain to point to the Loadbalancer URL to access at a customized domain.
243+
{% endhint %}
230244
231245
| Host | Type | Points to |
232246
| :--- | :--- | :--- |
233247
| devtron.yourdomain.com | CNAME | aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com |
234248
249+
---
235250
236-
## Devtron Admin credentials
251+
## Devtron Admin Credentials
237252
238253
When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use that credentials to log in as an administrator.
239254
@@ -269,6 +284,7 @@ kubectl -n devtroncd get secret devtron-secret \
269284
* Related to installaltion, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.
270285
271286
272-
273-
**Note**: If you have questions, please let us know on our discord channel. [![Join Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp)
287+
{% hint style="info" %}
288+
If you have any questions, please let us know on our Discord channel. [![Join Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp)
289+
{% endhint %}
274290

docs/user-guide/creating-application/config-approval.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ This stands true for both: base configuration and respective environment-level c
2020

2121
---
2222

23+
## Tutorial
24+
25+
{% embed url="https://www.youtube.com/watch?v=TVLEbY850hI" caption="Protect Configuration and Approval" %}
26+
27+
---
28+
2329
## Changing the Configuration Values
2430

2531
{% hint style="info" %}

docs/user-guide/use-cases/oci-pull.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Introduction
44

5-
Devtron supports the installation of [Helm charts](https://docs.devtron.ai/resources/glossary#helm-charts-packages) from both: Helm [repos](https://docs.devtron.ai/resources/glossary#repo) and [Container/OCI registries](https://docs.devtron.ai/resources/glossary#container-registry). Unlike Helm repos, OCI registries do not have an index file to discover all the charts. However, Devtron makes it easier for you to populate your charts from multiple sources to the [chart store](https://docs.devtron.ai/resources/glossary#chart-store).
5+
Devtron supports the installation of [Helm charts](../../reference/glossary.md#helm-chartspackages) from both: Helm [repos](../../reference/glossary.md#repo) and [Container/OCI registries](../../reference/glossary.md#containeroci-registry). Unlike Helm repos, OCI registries do not have an index file to discover all the charts. However, Devtron makes it easier for you to populate your charts from multiple sources to the [chart store](../../reference/glossary.md#chart-store).
66

77
**Pre-requisites**
88

99
* Helm Chart(s)
10-
* OCI-compliant Registry (e.g. Docker Hub and [many more](https://docs.devtron.ai/global-configurations/container-registries#supported-registry-providers))
10+
* OCI-compliant Registry (e.g. Docker Hub and [many more](../global-configurations/container-registries.md#supported-registry-providers))
1111

12-
You must [add your OCI registry](https://docs.devtron.ai/global-configurations/container-registries) to Devtron with the `Use as chart repository` option enabled.
12+
You must [add your OCI registry](../global-configurations/container-registries.md) to Devtron with the `Use as chart repository` option enabled.
1313

1414
---
1515

0 commit comments

Comments
 (0)