diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 0e895aeab..598550f62 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -3,9 +3,9 @@ * [Introduction](README.md) * [Getting Started](setup/getting-started/getting-started.md) * [Install Devtron](setup/install/README.md) + * [Install Devtron without Integrations](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, Cloud VMs](setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md) * [Install Devtron on Airgapped Environment](setup/install/install-devtron-in-airgapped-environment.md) * [Demo on Popular Cloud Providers](setup/install/demo-tutorials.md) diff --git a/docs/setup/getting-started/getting-started.md b/docs/setup/getting-started/getting-started.md index ae087b485..ddb4e0e42 100644 --- a/docs/setup/getting-started/getting-started.md +++ b/docs/setup/getting-started/getting-started.md @@ -1,26 +1,27 @@ # Getting Started - -This section includes information about the minimum requirements you need to install and use **Devtron**. -Devtron is installed over a Kubernetes cluster. Once you create a Kubernetes cluster, Devtron can be installed standalone or along with CI/CD integration: +## Introduction -* [Devtron with CI/CD](../install/install-devtron-with-cicd.md): Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. -* [Helm Dashboard by Devtron](../install/install-devtron.md): The Helm Dashboard by Devtron, which is a standalone installation, includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). +Devtron is installed over a Kubernetes cluster. Once you create a Kubernetes cluster, Devtron can be installed standalone or along with integrations. This section includes information about the minimum requirements you need to install and use Devtron. -In this section, we will cover the basic details on how you can quickly get started with **Devtron**. -First, lets see what are the prerequisite requirements before you install Devtron. +--- ## Prerequisites -* Create a [Kubernetes cluster, preferably K8s version 1.16 or higher](#create-a-kubernetes-cluster) + +* Create a [Kubernetes cluster](#create-a-kubernetes-cluster) + * [Helm Installation](https://helm.sh/docs/intro/install/) -* [Recommended Resources](#recommended-resources) +* [Recommended Resources](#recommended-resources) ### Create a Kubernetes Cluster {% hint style="info" %} + ### Setting up a production-grade infrastructure? + Refer [Devtron's Production Infra Recommendations](../install/prod-infra.md). + {% endhint %} You can create any [Kubernetes cluster](https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/) (preferably K8s version 1.16 or higher) for installing Devtron. @@ -32,54 +33,50 @@ You can create a cluster using one of the following cloud providers as per your | **AWS EKS** | Create a cluster using [AWS EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-console.html).
`Note`: You can also refer our customized documentation for installing `Devtron with CI/CD` on AWS EKS [here](https://github.com/devtron-labs/devtron/blob/b33a37bb608d07966c8f8b89e4f59287db873c6c/docs/setup/install/install-devtron-on-aws-eks.md).
| | **Google Kubernetes Engine (GKE)** | Create a cluster using [GKE](https://cloud.google.com/kubernetes-engine/). | | **Azure Kubernetes Service (AKS)** | Create a cluster using [AKS](https://learn.microsoft.com/en-us/azure/aks/). | -| **k3s - Lightweight Kubernetes** | Create a cluster using [k3s - Lightweight Kubernetes](https://devtron.ai/blog/deploy-your-applications-over-k3s-lightweight-kubernetes-in-no-time/).
`Note`: You can also refer our customized documentation for installing `Helm Dashboard by Devtron` on `Minikube, Microk8s, K3s, Kind` [here](../install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md).
| - - +| **k3s - Lightweight Kubernetes** | Create a cluster using [k3s - Lightweight Kubernetes](https://devtron.ai/blog/deploy-your-applications-over-k3s-lightweight-kubernetes-in-no-time/).
`Note`: You can also refer our customized documentation for installing `Modern Kubernetes Dashboard by Devtron` on `Minikube, Microk8s, K3s, Kind` [here](../install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md).
| ### Install Helm -Make sure to install [helm](https://helm.sh/docs/intro/install/). - - +Make sure to install [Helm](https://helm.sh/docs/intro/install/). ### Recommended Resources -The minimum requirements for installing `Helm Dashboard by Devtron` and `Devtron with CI/CD` as per the number of applications you want to manage on `Devtron` are provided below: +The minimum requirements for installing `Modern Kubernetes Dashboard by Devtron` and `Devtron with CI/CD` as per the number of applications you want to manage on `Devtron` are provided below: * For configuring small resources (to manage not more than 5 apps on Devtron): | Integration | CPU | Memory | | --- | :---: | :---: | | **Devtron with CI/CD** | 2 | 6 GB | -| **Helm Dashboard by Devtron** | 1 | 1 GB | +| **Modern Kubernetes Dashboard by Devtron** | 1 | 1 GB | * For configuring medium/larger resources (to manage more than 5 apps on Devtron): | Integration | CPU | Memory | | --- | :---: | :---: | | **Devtron with CI/CD** | 6 | 13 GB | -| **Helm Dashboard by Devtron** | 2 | 3 GB | +| **Modern Kubernetes Dashboard by Devtron** | 2 | 3 GB | > Refer to the [Override Configurations](../install/override-default-devtron-installation-configs.md) section for more information. -**Note:** +{% hint style="warning" %} + * Please make sure that the recommended resources are available on your Kubernetes cluster before you proceed with Devtron installation. + * It is NOT recommended to use brustable CPU VMs (T series in AWS, B Series in Azure and E2/N1 in GCP) for Devtron installation to experience consistency in performance. - -## Installation of Devtron +{% endhint %} -You can install Devtron standalone (Helm Dashboard by Devtron) or along with CI/CD integration. Or, you can upgrade Devtron to the latest version. +--- + +## Installation of Devtron -Choose one of the options as per your requirements: +You can install Devtron standalone (Modern Kubernetes Dashboard by Devtron) or along with integrations. Or, you can upgrade Devtron to the latest version. -| Installation Options | Description | -| --- | --- | -| [Devtron with CI/CD](../install/install-devtron-with-cicd.md) | Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. | -| [Helm Dashboard by Devtron](../install/install-devtron.md) | The Helm Dashboard by Devtron which is a standalone installation includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). | -| [Devtron with CI/CD along with GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md) | With this option, you can install Devtron with CI/CD by enabling GitOps during the installation. You can also install other integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). | -| **Upgrade Devtron to latest version** | You can upgrade Devtron in one of the following ways: | +Refer to [Devtron Installation Options](../install/README.md) to install Devtron as per your requirements. -**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 questions, please let us know on our discord channel. [![Join us on Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp) +{% endhint %} \ No newline at end of file diff --git a/docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md b/docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md index 11152f32d..b488d7f2e 100644 --- a/docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md +++ b/docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md @@ -1,66 +1,141 @@ # Install Devtron on Minikube, Microk8s, K3s, Kind, Cloud VMs +## Introduction + You can install and try Devtron on a high-end machine or a Cloud VM. If you install it on a laptop/PC, it may start to respond slowly. {% hint style="success" %} + Try Devtron Enterprise for free — unlock advanced features built for scale. [Start Free Trial](https://license.devtron.ai/dashboard) + {% endhint %} -## Prerequisites +--- + +## Tutorial + +{% embed url="https://www.youtube.com/watch?v=rKUymNJqcjA" caption="Installing Devtron on Minikube" %} -1. 2 vCPUs -2. 4GB+ of free memory -3. 20GB+ free disk space +--- -Before you get started, finish the following actions: +## Add Helm Repo - * Create a cluster using [Minikube](https://minikube.sigs.k8s.io/docs/start/) or [MicroK8s](https://microk8s.io/docs/tutorials) or [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) or [K3s](https://rancher.com/docs/k3s/latest/en/installation/). - * Install [Helm3](https://helm.sh/docs/intro/install/). - * Install [kubectl](https://kubernetes.io/docs/tasks/tools/). +```bash +helm repo add devtron https://helm.devtron.ai +``` --- -## Tutorial +## Update Helm Repo -{% embed url="https://www.youtube.com/watch?v=rKUymNJqcjA" caption="Installing Devtron on Minikube" %} +```bash +helm repo update devtron +``` --- ## For Minikube, MicroK8s, Kind, K3s +{% hint style="warning" %} + +### Prerequisites + +Ensure you meet [all the requirements](../getting-started/getting-started.md#prerequisites) for installing Devtron. + +{% endhint %} + +### Installation Commands + {% tabs %} -{% tab title=" Minikube/MicroK8s/Kind Cluster" %} +{% tab title="Without Integrations" %} + +**Minikube/MicroK8s/Kind Cluster** - To install Devtron on **Minikube/MicroK8s/Kind** cluster, run the following command: +To install Devtron on **Minikube/MicroK8s/Kind** cluster, run the following command: ```bash -helm repo add devtron https://helm.devtron.ai +helm install devtron devtron/devtron-operator \ +--create-namespace --namespace devtroncd \ +--set components.devtron.service.type=NodePort +``` -helm repo update devtron +**K3s Cluster** + +To install Devtron on **K3s** cluster, run the following commands: +```bash +kubectl apply -f https://raw.githubusercontent.com/rancher/local-path-provisioner/master/deploy/local-path-storage.yaml +``` + +```bash helm install devtron devtron/devtron-operator \ --create-namespace --namespace devtroncd \ --set components.devtron.service.type=NodePort - ``` + {% endtab %} -{% tab title="K3s Cluster" %} -To install Devtron on **K3s** cluster, run the following command: +{% tab title="With CI/CD" %} + +**Minikube/MicroK8s/Kind Cluster** + +To install Devtron on **Minikube/MicroK8s/Kind** cluster, run the following command: + +```bash +helm install devtron devtron/devtron-operator \ +--create-namespace --namespace devtroncd \ +--set components.devtron.service.type=NodePort \ +--set installer.modules={cicd} +``` + +**K3s Cluster** + +To install Devtron on **K3s** cluster, run the following commands: ```bash kubectl apply -f https://raw.githubusercontent.com/rancher/local-path-provisioner/master/deploy/local-path-storage.yaml +``` -helm repo add devtron https://helm.devtron.ai +```bash +helm install devtron devtron/devtron-operator \ +--create-namespace --namespace devtroncd \ +--set components.devtron.service.type=NodePort \ +--set installer.modules={cicd} +``` -helm repo update devtron +{% endtab %} + +{% tab title="With CI/CD and GitOps (Argo CD)" %} + +**Minikube/MicroK8s/Kind Cluster** + +To install Devtron on **Minikube/MicroK8s/Kind** cluster, run the following command: +```bash helm install devtron devtron/devtron-operator \ --create-namespace --namespace devtroncd \ ---set components.devtron.service.type=NodePort +--set components.devtron.service.type=NodePort \ +--set installer.modules={cicd} \ +--set argo-cd.enabled=true +``` +**K3s Cluster** + +To install Devtron on **K3s** cluster, run the following commands: + +```bash +kubectl apply -f https://raw.githubusercontent.com/rancher/local-path-provisioner/master/deploy/local-path-storage.yaml ``` + +```bash +helm install devtron devtron/devtron-operator \ +--create-namespace --namespace devtroncd \ +--set components.devtron.service.type=NodePort \ +--set installer.modules={cicd} \ +--set argo-cd.enabled=true +``` + {% endtab %} {% endtabs %} @@ -96,12 +171,6 @@ After port-forwarding, you can access the dashboard at this URL: `http://127.0.0 When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use those credentials to log in as an administrator. -After the initial login, we recommend you set up any SSO service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (let's say, GitHub) to log in to Devtron's dashboard. - -The section below will help you understand the process of getting the administrator credentials. - -#### For Devtron version v0.6.0 and higher - **Username**: `admin`
**Password**: Run the following command to get the admin password: @@ -110,24 +179,31 @@ kubectl -n devtroncd get secret devtron-secret \ -o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d ``` +You can also install integrations from the [Devtron Stack Manager](../../user-guide/integrations/README.md). -
-For Devtron version less than v0.6.0 +{% hint style="info" %} -**Username**: `admin`
-**Password**: Run the following command to get the admin password: +#### Next Recommended Action -```bash -kubectl -n devtroncd get secret devtron-secret \ --o jsonpath='{.data.ACD_PASSWORD}' | base64 -d -``` -
+When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator. + +After the initial login, we recommend you set up any [Single Sign-On (SSO)](../../user-guide/global-configurations/sso-login.md) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (e.g., GitHub) to log in to the Dashboard. + +{% endhint %} --- ## For Cloud VM (AWS EC2, Azure VM, GCP VM) -It is recommended to use Cloud VM with 2vCPU+, 4GB+ free memory, 20GB+ storage, Compute Optimized VM type & Ubuntu Flavoured OS. +{% hint style="warning" %} + +### Prerequisites + +* Ensure you meet [all the requirements](../getting-started/getting-started.md#prerequisites) for installing Devtron. + +* It is recommended to use Cloud VM with 2vCPU+, 4GB+ free memory, 20GB+ storage, Compute Optimized VM type & Ubuntu Flavoured OS. + +{% endhint %} ### Create MicroK8s Cluster @@ -142,18 +218,45 @@ echo "alias helm='microk8s helm3 '" >> .bashrc source .bashrc ``` -### Install Devtron +### Installation Commands -```bash -helm repo add devtron https://helm.devtron.ai +{% tabs %} -helm repo update devtron +{% tab title="Without Integrations" %} +```bash helm install devtron devtron/devtron-operator \ --create-namespace --namespace devtroncd \ --set components.devtron.service.type=NodePort +``` + +{% endtab %} + +{% tab title="With CI/CD" %} +```bash +helm install devtron devtron/devtron-operator \ +--create-namespace --namespace devtroncd \ +--set components.devtron.service.type=NodePort \ +--set installer.modules={cicd} +``` + +{% endtab %} + +{% tab title="With CI/CD and GitOps (Argo CD)" %} + +```bash +helm install devtron devtron/devtron-operator \ +--create-namespace --namespace devtroncd \ +--set components.devtron.service.type=NodePort \ +--set installer.modules={cicd} \ +--set argo-cd.enabled=true ``` + +{% endtab %} + +{% endtabs %} + ### Get devtron-service Port Number ```bash @@ -162,8 +265,20 @@ kubectl get svc -n devtroncd devtron-service -o jsonpath='{.spec.ports[0].nodePo Make sure that the port used by the devtron-service remain open in the VM's security group or network security group. +You can also install integrations from the [Devtron Stack Manager](../../user-guide/integrations/README.md). + {% hint style="info" %} -If you want to uninstall Devtron or clean up the Devtron Helm installer, refer [uninstall Devtron](./uninstall-devtron.md). + +#### Next Recommended Action + +When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator. + +After the initial login, we recommend you set up any [Single Sign-On (SSO)](../../user-guide/global-configurations/sso-login.md) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (e.g., GitHub) to log in to the Dashboard. + {% endhint %} +{% hint style="info" %} + 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) + +{% endhint %} \ No newline at end of file diff --git a/docs/setup/install/README.md b/docs/setup/install/README.md index 569c55fa3..1b8c70c54 100644 --- a/docs/setup/install/README.md +++ b/docs/setup/install/README.md @@ -1,19 +1,41 @@ # Install Devtron +## Introduction -Devtron is installed over a Kubernetes cluster. Once you create a Kubernetes cluster, Devtron can be installed standalone or along with CI/CD integration. +Devtron is installed over a Kubernetes cluster. Once you [Create a Kubernetes Cluster](../getting-started/getting-started.md#create-a-kubernetes-cluster), Devtron can be installed standalone or along with CI/CD integration. {% hint style="success" %} -Try Devtron Enterprise for free — unlock advanced features built for scale. [Start Free Trial](https://license.devtron.ai/dashboard) + +Try Devtron Enterprise for free — unlock advanced features built for scale. [Start Your Free Trial](https://license.devtron.ai/dashboard). + {% endhint %} -Choose one of the options as per your requirements: +--- + +## Installation Options + +![Devtron Installation Options](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/install-devtron/installation-methods-v2.jpg) + +Choose one of the following installation options as per your requirement: + +* [Modern Kubernetes Dashboard](../install/install-devtron.md) + +* [Devtron with CI/CD](../install/install-devtron-with-cicd.md) + +* [Devtron with CI/CD and GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md) + +{% hint style="info" %} + +### Note + +* If you are planning to install Devtron in production environments, kindly refer to [Production Infra Recommendations](../install/prod-infra.md). + +* If you want to install a light-weight desktop client outside your Kubernetes cluster, kindly refer to [Devtron Kubernetes Client](../install/install-devtron-Kubernetes-client.md). + +{% endhint %} -| Installation Options | Description | When to choose | -| --- | --- | --- | -| [Devtron with CI/CD](../install/install-devtron-with-cicd.md) | Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. | Use this option to install Devtron with `Build and Deploy CI/CD` integration. | -| [Helm Dashboard by Devtron](../install/install-devtron.md) | The Helm Dashboard by Devtron which is a standalone installation includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). | Use this option if you are managing the applications via Helm and you want to use Devtron to deploy, observe, manage, and debug the Helm applications. | -| [Devtron with CI/CD along with GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md) | With this option, you can install Devtron with CI/CD by enabling GitOps during the installation. You can also install other integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). | Use this option to install Devtron with CI/CD by enabling GitOps, which is the most scalable method in terms of version control, collaboration, compliance and infrastructure automation. | +{% hint style="info" %} +If you have questions, please let us know on our Discord channel. [![Join us on Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp) -**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) +{% endhint %} \ No newline at end of file diff --git a/docs/setup/install/demo-tutorials.md b/docs/setup/install/demo-tutorials.md index 62d2624d2..55b5ad1a6 100644 --- a/docs/setup/install/demo-tutorials.md +++ b/docs/setup/install/demo-tutorials.md @@ -23,3 +23,15 @@ Here we have demonstrated the installation of Devtron on popular cloud providers **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" %} + +--- + +{% hint style="info" %} + +### Next Recommended Action + +When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator. + +After the initial login, we recommend you set up any [Single Sign-On (SSO)](../../user-guide/global-configurations/sso-login.md) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (e.g., GitHub) to log in to the Dashboard. + +{% endhint %} \ No newline at end of file diff --git a/docs/setup/install/install-devtron-in-airgapped-environment.md b/docs/setup/install/install-devtron-in-airgapped-environment.md index 310d46910..fd7cfd7b8 100644 --- a/docs/setup/install/install-devtron-in-airgapped-environment.md +++ b/docs/setup/install/install-devtron-in-airgapped-environment.md @@ -5,12 +5,17 @@ In certain scenarios, you may need to deploy Devtron to a Kubernetes cluster that isn’t connected to the internet. Such air-gapped environments are used for various reasons, particularly in industries with strict regulatory requirements like healthcare, banking, and finance. This is because air-gapped environments aren't exposed to the public internet; therefore, they create a controlled and secure space for handling sensitive data and operations. {% hint style="success" %} + Try Devtron Enterprise for free — unlock advanced features built for scale. [Start Free Trial](https://license.devtron.ai/dashboard) + {% endhint %} -### Prerequisites +{% hint style="warning" %} + +### Prerequisites 1. Install `podman` or `docker` on the VM from where you're executing the installation commands. + 2. Get the latest image file ```bash @@ -19,9 +24,8 @@ curl -LO https://raw.githubusercontent.com/devtron-labs/devtron/refs/heads/main/ 3. Set the values of `TARGET_REGISTRY`, `TARGET_REGISTRY_USERNAME`, and `TARGET_REGISTRY_TOKEN`. This registry should be accessible from the VM where you are running the cloning script and the K8s cluster where you’re installing Devtron. -{% hint style="warning" %} -### Note If you are using Docker, the TARGET_REGISTRY should be in the format `docker.io/` + {% endhint %} --- @@ -42,8 +46,6 @@ export PLATFORM="linux/amd64" export PLATFORM="linux/arm64" ``` - - 1. Set the environment variables ```bash @@ -196,16 +198,20 @@ Before starting, ensure you have created an image pull secret for your registry --docker-password=$TARGET_REGISTRY_TOKEN ``` -### Get the latest Devtron Helm Chart +### Get the Latest Devtron Helm Chart ``` bash helm pull devtron-operator --repo http://helm.devtron.ai ``` This would download the tar file of the devtron-operator chart, Make sure to replace the `` in the installation commands with this file name. -### Install Devtron without any Integration +### Installation Commands -Use the below command to install Devtron without any Integrations +{% tabs %} + +{% tab title="Without Integrations" %} + +Use the below command to install Devtron without any integrations: 1. Without `imagePullSecrets`: ```bash @@ -217,7 +223,10 @@ Use the below command to install Devtron without any Integrations helm install devtron -n devtroncd --set global.containerRegistry="$TARGET_REGISTRY" --set global.imagePullSecrets[0].name=devtron-imagepull --set-string components.devtron.customOverrides.IS_AIR_GAP_ENVIRONMENT=true ``` -### Installing Devtron with CI/CD Mode +{% endtab %} + +{% tab title="With CI/CD" %} + Use the below command to install Devtron with only the CI/CD module 1. Without `imagePullSecrets`: @@ -230,7 +239,9 @@ Use the below command to install Devtron with only the CI/CD module helm install devtron -n devtroncd --set installer.modules={cicd} --set global.containerRegistry="$TARGET_REGISTRY" --set global.imagePullSecrets[0].name=devtron-imagepull --set-string components.devtron.customOverrides.IS_AIR_GAP_ENVIRONMENT=true ``` -### Install Devtron with CICD Mode including Argocd +{% endtab %} + +{% tab title="With CI/CD and GitOps (Argo CD)" %} Use the below command to install Devtron with the CI/CD module and Argo CD @@ -244,7 +255,64 @@ Use the below command to install Devtron with the CI/CD module and Argo CD helm install devtron --create-namespace -n devtroncd --set installer.modules={cicd} --set argo-cd.enabled=true --set global.containerRegistry="$TARGET_REGISTRY" --set argo-cd.global.image.repository="${TARGET_REGISTRY}/argocd" --set argo-cd.redis.image.repository="${TARGET_REGISTRY}/redis" --set global.imagePullSecrets[0].name=devtron-imagepull --set-string components.devtron.customOverrides.IS_AIR_GAP_ENVIRONMENT=true ``` +{% endtab %} + +{% endtabs %} + --- -## Next Steps -After installation, refer [Devtron installation documentation](https://docs.devtron.ai/install/install-devtron-with-cicd-with-gitops#devtron-dashboard) for further steps, including obtaining the dashboard URL and the admin password. +### Devtron Dashboard + +Run the following command to get the Devtron dashboard URL: + +```bash +kubectl get svc -n devtroncd devtron-service \ +-o jsonpath='{.status.loadBalancer.ingress}' +``` + +You will get an output similar to the example shown below: + +```bash +[map[hostname:aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com]] +``` + +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. + +**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. + +| Host | Type | Points to | +| :--- | :--- | :--- | +| devtron.yourdomain.com | CNAME | aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com | + +--- + +### 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. + +**Username**: `admin`
+**Password**: Run the following command to get the admin password: + +```bash +kubectl -n devtroncd get secret devtron-secret \ +-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d +``` + +{% hint style="info" %} + +### Next Recommended Action + +When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator. + +After the initial login, we recommend you set up any [Single Sign-On (SSO)](../../user-guide/global-configurations/sso-login.md) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (e.g., GitHub) to log in to the Dashboard. + +{% endhint %} + +{% hint style="info" %} + +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) + +{% endhint %} \ No newline at end of file diff --git a/docs/setup/install/install-devtron-with-cicd-with-gitops.md b/docs/setup/install/install-devtron-with-cicd-with-gitops.md index facb90180..5ccbec4bc 100644 --- a/docs/setup/install/install-devtron-with-cicd-with-gitops.md +++ b/docs/setup/install/install-devtron-with-cicd-with-gitops.md @@ -1,16 +1,24 @@ # Install Devtron with CI/CD along with GitOps (Argo CD) +## Introduction + In this section, we describe the steps in detail on how you can install Devtron with CI/CD by enabling GitOps during the installation. {% hint style="success" %} + Try Devtron Enterprise for free — unlock advanced features built for scale. [Start Free Trial](https://license.devtron.ai/dashboard) + {% endhint %} +{% hint style="warning" %} + +### Prerequisites -## Before you begin +Ensure you meet [all the requirements](../getting-started/getting-started.md#prerequisites) for installing Devtron. -Install [Helm](https://helm.sh/docs/intro/install/) if you have not installed it. +{% endhint %} +--- ## Install Devtron with CI/CD along with GitOps (Argo CD) @@ -27,7 +35,7 @@ helm install devtron devtron/devtron-operator \ --set argo-cd.enabled=true ``` -**Note**: If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-during-installation). +**Note**: If you want to configure Blob Storage during the installation, refer [Configure Blob Storage During Installation](#configure-blob-storage-during-installation). +--- ## Configure Blob Storage during Installation @@ -189,6 +198,7 @@ helm install devtron devtron/devtron-operator \ {% endtab %} {% endtabs %} +--- ## Check Status of Devtron Installation @@ -208,6 +218,7 @@ 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 @@ -217,6 +228,8 @@ Run the following command to check the installer logs: kubectl logs -f -l app=inception -n devtroncd ``` +--- + ## Devtron dashboard Run the following command to get the Devtron dashboard URL: @@ -243,17 +256,12 @@ Please wait until the installation is completed. | :--- | :--- | :--- | | devtron.yourdomain.com | CNAME | aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com | +--- ## 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. -After the initial login, we recommend you set up any SSO service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (let's say, GitHub) to log in to Devtron's dashboard. - -The section below will help you understand the process of getting the administrator credentials. - -### For Devtron version v0.6.0 and higher - **Username**: `admin`
**Password**: Run the following command to get the admin password: @@ -262,23 +270,18 @@ kubectl -n devtroncd get secret devtron-secret \ -o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d ``` +{% hint style="info" %} -
-For Devtron version less than v0.6.0 - -**Username**: `admin`
-**Password**: Run the following command to get the admin password: +### Next Recommended Action -```bash -kubectl -n devtroncd get secret devtron-secret \ --o jsonpath='{.data.ACD_PASSWORD}' | base64 -d -``` -
+When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator. +After the initial login, we recommend you set up any [Single Sign-On (SSO)](../../user-guide/global-configurations/sso-login.md) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (e.g., GitHub) to log in to the Dashboard. -* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](../install/uninstall-devtron.md). +{% endhint %} -* Related to installation, please also refer [FAQ](../install/faq-on-installation.md) section also. +{% hint style="info" %} +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) -**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) +{% endhint %} \ No newline at end of file diff --git a/docs/setup/install/install-devtron-with-cicd.md b/docs/setup/install/install-devtron-with-cicd.md index 87d3fa915..3e12d346d 100644 --- a/docs/setup/install/install-devtron-with-cicd.md +++ b/docs/setup/install/install-devtron-with-cicd.md @@ -3,19 +3,18 @@ In this section, we describe the steps in detail on how you can install Devtron with CI/CD integration. {% hint style="success" %} + Try Devtron Enterprise for free — unlock advanced features built for scale. [Start Free Trial](https://license.devtron.ai/dashboard) -{% endhint %} ---- +{% endhint %} -## Prerequisites +{% hint style="warning" %} -Install [Helm](https://helm.sh/docs/intro/install/), if you have not installed it already. +### Prerequisites -{% 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 [Helm](https://helm.sh/docs/intro/install/), if you have not installed it already. -Run the following command to install AWS EBS CSI driver using Helm: +* 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). Run the following command to install AWS EBS CSI driver using Helm: ```bash helm repo add aws-ebs-csi-driver \ @@ -24,6 +23,7 @@ helm repo update \ helm upgrade --install aws-ebs-csi-driver \ --namespace kube-system aws-ebs-csi-driver/aws-ebs-csi-driver ``` + {% endhint %} --- @@ -43,7 +43,9 @@ helm install devtron devtron/devtron-operator \ ``` {% hint style="info" %} -If you want to configure Blob Storage during the installation, refer [configure blob storage duing installation](#configure-blob-storage-during-installation). + +If you want to configure Blob Storage during the installation, refer [Configure Blob Storage During Installation](#configure-blob-storage-during-installation). + {% endhint %} +--- + ## Devtron Dashboard Run the following command to get the dashboard URL: @@ -76,17 +90,12 @@ The hostname `aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws | :--- | :--- | :--- | | devtron.yourdomain.com | CNAME | aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com | +--- ## 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. -After the initial login, we recommend you set up any SSO service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (let's say, GitHub) to log in to Devtron's dashboard. - -The section below will help you understand the process of getting the administrator credentials. - -### For Devtron version v0.6.0 and higher - **Username**: `admin`
**Password**: Run the following command to get the admin password: @@ -94,23 +103,25 @@ The section below will help you understand the process of getting the administra kubectl -n devtroncd get secret devtron-secret \ -o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d ``` - -
-For Devtron version less than v0.6.0 -**Username**: `admin`
-**Password**: Run the following command to get the admin password: +{% hint style="info" %} -```bash -kubectl -n devtroncd get secret devtron-secret \ --o jsonpath='{.data.ACD_PASSWORD}' | base64 -d -``` -
+### Next Recommended Action +When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator. -**Note**: If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](../install/uninstall-devtron.md). +After the initial login, we recommend you set up any [Single Sign-On (SSO)](../../user-guide/global-configurations/sso-login.md) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (e.g., GitHub) to log in to the Dashboard. +{% endhint %} + +--- ## Upgrade -To use the CI/CD capabilities with Devtron, you can Install the [Devtron with CI/CD](../install/install-devtron-with-cicd.md) or [Devtron with CI/CD along with GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md). +If required, you can install other integrations (e.g., [Build and Deploy (CI/CD)](../../user-guide/integrations/build-and-deploy-ci-cd.md) or [GitOps (Argo CD)](../../user-guide/integrations/argocd.md)) from the Devtron Stack Manager. Refer to [Devtron Stack Manager](../../user-guide/integrations/README.md) for more information. + +{% hint style="info" %} + +If you have any questions, please let us know on our Discord channel. [![Join us on Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp) + +{% endhint %} \ No newline at end of file