Skip to content

docs: minor updates ingress #2931

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 6, 2023
Merged

docs: minor updates ingress #2931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa05715
minor updates ingress
SNe789 Feb 6, 2023
4c00f5e
minor updates ingress
SNe789 Feb 6, 2023
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
5 changes: 4 additions & 1 deletion docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
```

### For Devtron version less than v0.6.0

<details>
<summary>For Devtron version less than v0.6.0</summary>

**Username**: `admin` <br>
**Password**: Run the following command to get the admin password:
Expand All @@ -88,6 +90,7 @@ kubectl -n devtroncd get secret devtron-secret \
kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
```
</details>

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

Expand Down
15 changes: 9 additions & 6 deletions docs/setup/install/ingress-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Ingress Setup

After Devtron is installed, Devtron is accessible through service `devtron-service`.
If you want to access devtron through ingress, edit devtron-service and change the loadbalancer to ClusterIP. You can do this using `kubectl patch` command like :
If you want to access Devtron through ingress, edit `devtron-service` and change the loadbalancer to ClusterIP. You can do this using `kubectl patch` command:

```bash
kubectl patch -n devtroncd svc devtron-service -p '{"spec": {"ports": [{"port": 80,"targetPort": "devtron","protocol": "TCP","name": "devtron"}],"type": "ClusterIP","selector": {"app": "devtron"}}}'
```

After that create ingress by applying the ingress yaml file.
You can use [this yaml file](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress.yaml) to create ingress to access devtron:
After this, create ingress by applying the ingress yaml file.
You can use [this yaml file](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress.yaml) to create ingress to access Devtron:

```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
labels:
app: devtron
release: devtron
Expand Down Expand Up @@ -47,12 +48,13 @@ spec:
pathType: ImplementationSpecific
```

You can access devtron from any host after applying this yaml. For k8s versions <1.19, [apply this yaml](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress-legacy.yaml):
You can access Devtron from any host after applying this yaml. For k8s versions <1.19, [apply this yaml](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress-legacy.yaml):

```yaml
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
labels:
app: devtron
release: devtron
Expand All @@ -73,12 +75,13 @@ spec:
pathType: ImplementationSpecific
```

Optionally you also can access devtron through a specific host like :
Optionally, you also can access Devtron through a specific host by running the following YAML file:

```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
labels:
app: devtron
release: devtron
Expand Down Expand Up @@ -120,7 +123,7 @@ Once ingress setup for devtron is done and you want to run Devtron over `https`,

### 1. Nginx Ingress Controller

In case of `nginx ingress controller`, add following annotations under `service.annotations` under nginx ingress controller to run devtron over `https`.
In case of `nginx ingress controller`, add the following annotations under `service.annotations` under nginx ingress controller to run devtron over `https`.

(i) Amazon Web Services (AWS)

Expand Down
8 changes: 6 additions & 2 deletions docs/setup/install/install-devtron-with-cicd-with-gitops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,9 @@ kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
```

### For Devtron version less than v0.6.0

<details>
<summary>For Devtron version less than v0.6.0</summary>

**Username**: `admin` <br>
**Password**: Run the following command to get the admin password:
Expand All @@ -247,10 +249,12 @@ kubectl -n devtroncd get secret devtron-secret \
kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
```
</details>


* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).

* Related to installaltion, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.
* Related to installation, 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)
5 changes: 4 additions & 1 deletion docs/setup/install/install-devtron-with-cicd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,8 @@ kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
```

### For Devtron version less than v0.6.0
<details>
<summary>For Devtron version less than v0.6.0</summary>

**Username**: `admin` <br>
**Password**: Run the following command to get the admin password:
Expand All @@ -254,6 +255,8 @@ kubectl -n devtroncd get secret devtron-secret \
kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
```
</details>


* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).

Expand Down
7 changes: 5 additions & 2 deletions docs/setup/install/install-devtron.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ The hostname `aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws
kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
```

### For Devtron version less than v0.6.0

<details>
<summary>For Devtron version less than v0.6.0</summary>

**Username**: `admin` <br>
**Password**: Run the following command to get the admin password:
Expand All @@ -91,6 +92,8 @@ kubectl -n devtroncd get secret devtron-secret \
kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
```
</details>


**Note**: If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).

Expand Down