Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
9 changes: 5 additions & 4 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
* [Introduction](README.md)
* [Getting Started](setup/getting-started/getting-started.md)
* [Install Devtron](setup/install/README.md)
* [Install Devtron with CI/CD Integration](setup/install/install-devtron-with-cicd.md)
* [Install Devtron with CI/CD along with GitOps (Argo CD)](setup/install/install-devtron-with-cicd-with-gitops.md)
* [Install Devtron](setup/install/install-devtron.md)
* [Install Devtron with CI/CD](setup/install/install-devtron-with-cicd.md)
* [Install Devtron with CI/CD and GitOps (Argo CD)](setup/install/install-devtron-with-cicd-with-gitops.md)
* [Install Devtron without Integrations](setup/install/install-devtron.md)
* [Install Devtron on Minikube, Microk8s, K3s, Kind](setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md)
* [Demo on Popular Cloud Providers](setup/install/demo-tutorials.md)
* [Backup for Disaster Recovery](setup/install/devtron-backup.md)
* [FAQ on Installation](setup/install/faq-on-installation.md)
* [Uninstall Devtron](setup/install/uninstall-devtron.md)
* [FAQs](setup/install/faq-on-installation.md)
* [Devtron Kubernetes Client](setup/install/install-devtron-Kubernetes-client.md)
* [Configurations](setup/configurations/configurations-overview.md)
* [Installation Configurations](setup/install/installation-configuration.md)
Expand Down
25 changes: 25 additions & 0 deletions docs/setup/install/demo-tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Demo Tutorials

Here we have demonstrated the installation of Devtron on popular cloud providers. The videos are easy to follow and provide step-by-step instructions.

## Installing on EKS Cluster

**Cloud Provider**: [Amazon Web Services (AWS)](https://aws.amazon.com/)

{% embed url="https://www.youtube.com/watch?v=eY2vudE5jFM" caption="Installing Devtron on AWS" %}

---

## Installing on AKS Cluster

**Cloud Provider**: [Microsoft Azure](https://azure.microsoft.com/)

{% embed url="https://www.youtube.com/watch?v=8ZdhwJQ-IU4" caption="Installing Devtron on Azure" %}

---

## Installing on GKE Cluster

**Cloud Provider**: [Google Cloud Platform (GCP)](https://console.cloud.google.com/)

{% embed url="https://www.youtube.com/watch?v=7UN_Fbo3VMM" caption="Installing Devtron on Google Cloud" %}
84 changes: 50 additions & 34 deletions docs/setup/install/install-devtron-with-cicd.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# Install Devtron with CICD
# Install Devtron with CI/CD

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

---

## Before you begin
## Pre-requisites

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

{% hint style="info" %}
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).

## Install Devtron with CI/CD
Run the following command to install AWS EBS CSI driver using Helm:

```bash
helm repo add aws-ebs-csi-driver \
https://kubernetes-sigs.github.io/aws-ebs-csi-driver \
helm repo update \
helm upgrade --install aws-ebs-csi-driver \
--namespace kube-system aws-ebs-csi-driver/aws-ebs-csi-driver
```
{% endhint %}

---

## Command

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

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

**Note**: If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-duing-installation).


## Install AWS EBS CSI Driver, if require

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).
{% hint style="info" %}
If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-duing-installation).
{% endhint %}


Run the following command to install aws ebs csi driver using Helm:

```bash
helm repo add aws-ebs-csi-driver \
https://kubernetes-sigs.github.io/aws-ebs-csi-driver \
helm repo update \
helm upgrade --install aws-ebs-csi-driver \
--namespace kube-system aws-ebs-csi-driver/aws-ebs-csi-driver
```
---

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

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

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

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


## Configure Blob Storage duing Installation
## Configure Blob Storage during Installation

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

---

## Check Status of Devtron Installation

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

Run the following command to check the status of the installation:
Run the following command to check the status of the installation:

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

---

## Check the installer logs
## Check the Installer Logs

Run the following command to check the installer logs:

```bash
kubectl logs -f -l app=inception -n devtroncd
```

## Devtron dashboard
---

## Devtron Dashboard

Run the following command to get the Devtron dashboard URL:

Expand All @@ -223,17 +234,21 @@ You will get an output similar to the example shown below:

Use the hostname `aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com` (Loadbalancer URL) to access the Devtron dashboard.

**Note**: 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.
{% hint style="info" %}
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.
{% endhint %}

**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.
{% hint style="info" %}
You can also use a `CNAME` entry corresponding to your domain/subdomain to point to the Loadbalancer URL to access at a customized domain.
{% endhint %}

| Host | Type | Points to |
| :--- | :--- | :--- |
| devtron.yourdomain.com | CNAME | aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com |

---

## Devtron Admin credentials
## Devtron Admin Credentials

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.

Expand Down Expand Up @@ -269,6 +284,7 @@ kubectl -n devtroncd get secret devtron-secret \
* Related to installaltion, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.



**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)
{% hint style="info" %}
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)
{% endhint %}

6 changes: 6 additions & 0 deletions docs/user-guide/creating-application/config-approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ This stands true for both: base configuration and respective environment-level c

---

## Tutorial

{% embed url="https://www.youtube.com/watch?v=TVLEbY850hI" caption="Protect Configuration and Approval" %}

---

## Changing the Configuration Values

{% hint style="info" %}
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/use-cases/oci-pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

## Introduction

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).
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).

**Pre-requisites**

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

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

---

Expand Down