Skip to content

Commit

Permalink
Added Minikube Tutorial + Restructured Doc (#4477)
Browse files Browse the repository at this point in the history
  • Loading branch information
ashokdevtron committed Dec 29, 2023
1 parent ac5c769 commit ac3c00e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* [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)
* [Install Devtron on Minikube, Microk8s, K3s, Kind, Cloud VMs](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)
* [Uninstall Devtron](setup/install/uninstall-devtron.md)
Expand Down
49 changes: 29 additions & 20 deletions docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
# Install Devtron on Minikube, Microk8s, K3s, Kind
# Install Devtron on Minikube, Microk8s, K3s, Kind, Cloud VMs

You can install and try Devtron on a high-end machine or on a Cloud VM. If you install it on a laptop/PC, it may start to respond slow, so it is recommended to uninstall Devtron from your system before shutting it down.
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, so it is recommended to uninstall Devtron from your system before shutting it down.

## Prerequisites

## System Configurations for Devtron Installation
1. 2 vCPUs
2. 4GB+ of free memory
3. 20GB+ free disk space

## Before you begin

Before we get started and install Devtron, you must set up the cluster in you server and install the pre-requisite requirements:
Before you get started, you must set up a cluster in your server and finish the following actions:

* Create cluster using [Minikube](https://minikube.sigs.k8s.io/docs/start/) or [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) or [K3s](https://rancher.com/docs/k3s/latest/en/installation/).
* Create a cluster using [Minikube](https://minikube.sigs.k8s.io/docs/start/) 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/).

---

## Tutorial

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

## Install Devtron
---

## For Minikube, Microk8s, K3s, Kind

{% tabs %}

{% tab title=" Minikube/Kind cluster" %}
{% tab title=" Minikube/Kind Cluster" %}

To install devtron on ``Minikube/kind`` cluster, run the following command:

Expand Down Expand Up @@ -56,30 +61,31 @@ helm install devtron devtron/devtron-operator \

{% endtabs %}

## Devtron dashboard
### Access Devtron Dashboard

To access Devtron dashboard when using ``Minikube`` as cluster, run the following command:

```bash
minikube service devtron-service --namespace devtroncd
```

To access Devtron dashboard when using ``Kind/k3s`` as cluster, run the following command to port forward the devtron service to port 8000:

```bash
kubectl -ndevtroncd port-forward service/devtron-service 8000:80
kubectl -n devtroncd port-forward service/devtron-service 8000:80
```

**Dashboard**: [http://127.0.0.1:8000](http://127.0.0.1:8000).

## Devtron Admin credentials
### Get 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
#### For Devtron version v0.6.0 and higher

**Username**: `admin` <br>
**Password**: Run the following command to get the admin password:
Expand All @@ -102,9 +108,11 @@ kubectl -n devtroncd get secret devtron-secret \
```
</details>

## Install Devtron on Cloud VM (AWS ec2, Azure VM, GCP VM)
---

## 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.
It is recommended to use Cloud VM with 2vCPU+, 4GB+ free memory, 20GB+ storage, Compute Optimized VM type & Ubuntu Flavoured OS.

### Create Microk8s Cluster

Expand All @@ -119,7 +127,7 @@ echo "alias helm='microk8s helm3 '" >> .bashrc
source .bashrc
```

### Install devtron
### Install Devtron

```bash
helm repo add devtron https://helm.devtron.ai
Expand All @@ -131,15 +139,16 @@ helm install devtron devtron/devtron-operator \
--set components.devtron.service.type=NodePort

```
### Run the following command to get the devtron-service port number:
### Get devtron-service Port Number

```bash
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.spec.ports[0].nodePort}'
```

Make sure that the port on which the devtron-service runs remain open in the VM's security group or network Security group.

**Note**: If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).
Make sure that the port on which the devtron-service runs remain open in the VM's security group or network security group.

{% hint style="info" %}
If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](./uninstall-devtron.md).
{% endhint %}

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)

0 comments on commit ac3c00e

Please sign in to comment.