Skip to content

Commit 0443f14

Browse files
authored
docs: minor updates ingress (#2931)
* minor updates ingress * minor updates ingress
1 parent 446612b commit 0443f14

File tree

5 files changed

+28
-12
lines changed

5 files changed

+28
-12
lines changed

docs/setup/install/Install-devtron-on-Minikube-Microk8s-K3s-Kind.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,9 @@ kubectl -n devtroncd get secret devtron-secret \
7979
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
8080
```
8181

82-
### For Devtron version less than v0.6.0
82+
83+
<details>
84+
<summary>For Devtron version less than v0.6.0</summary>
8385

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

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

docs/setup/install/ingress-setup.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# Ingress Setup
22

33
After Devtron is installed, Devtron is accessible through service `devtron-service`.
4-
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 :
4+
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:
55

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

10-
After that create ingress by applying the ingress yaml file.
11-
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:
10+
After this, create ingress by applying the ingress yaml file.
11+
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:
1212

1313
```yaml
1414
apiVersion: networking.k8s.io/v1
1515
kind: Ingress
1616
metadata:
17+
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
1718
labels:
1819
app: devtron
1920
release: devtron
@@ -47,12 +48,13 @@ spec:
4748
pathType: ImplementationSpecific
4849
```
4950
50-
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):
51+
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):
5152
5253
```yaml
5354
apiVersion: extensions/v1beta1
5455
kind: Ingress
5556
metadata:
57+
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
5658
labels:
5759
app: devtron
5860
release: devtron
@@ -73,12 +75,13 @@ spec:
7375
pathType: ImplementationSpecific
7476
```
7577
76-
Optionally you also can access devtron through a specific host like :
78+
Optionally, you also can access Devtron through a specific host by running the following YAML file:
7779
7880
```yaml
7981
apiVersion: networking.k8s.io/v1
8082
kind: Ingress
8183
metadata:
84+
annotations: nginx.ingress.kubernetes.io/app-root: /dashboard
8285
labels:
8386
app: devtron
8487
release: devtron
@@ -120,7 +123,7 @@ Once ingress setup for devtron is done and you want to run Devtron over `https`,
120123

121124
### 1. Nginx Ingress Controller
122125

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

125128
(i) Amazon Web Services (AWS)
126129

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,9 @@ kubectl -n devtroncd get secret devtron-secret \
238238
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
239239
```
240240
241-
### For Devtron version less than v0.6.0
241+
242+
<details>
243+
<summary>For Devtron version less than v0.6.0</summary>
242244
243245
**Username**: `admin` <br>
244246
**Password**: Run the following command to get the admin password:
@@ -247,10 +249,12 @@ kubectl -n devtroncd get secret devtron-secret \
247249
kubectl -n devtroncd get secret devtron-secret \
248250
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
249251
```
252+
</details>
253+
250254
251255
* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).
252256
253-
* Related to installaltion, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.
257+
* Related to installation, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.
254258
255259
256260
**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)

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,8 @@ kubectl -n devtroncd get secret devtron-secret \
245245
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
246246
```
247247
248-
### For Devtron version less than v0.6.0
248+
<details>
249+
<summary>For Devtron version less than v0.6.0</summary>
249250
250251
**Username**: `admin` <br>
251252
**Password**: Run the following command to get the admin password:
@@ -254,6 +255,8 @@ kubectl -n devtroncd get secret devtron-secret \
254255
kubectl -n devtroncd get secret devtron-secret \
255256
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
256257
```
258+
</details>
259+
257260
258261
* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).
259262

docs/setup/install/install-devtron.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,9 @@ The hostname `aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws
8181
kubectl -n devtroncd get secret devtron-secret \
8282
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d
8383
```
84-
85-
### For Devtron version less than v0.6.0
84+
85+
<details>
86+
<summary>For Devtron version less than v0.6.0</summary>
8687

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

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

0 commit comments

Comments
 (0)