Skip to content

Commit 654ba93

Browse files
badal773Badal Kumar Prusty
and
Badal Kumar Prusty
authored
docs: added commands enable ingress during helm installation (#5794)
* added commands emable ingress during helm installation * modified commands * improved statement * removed unrequired lines --------- Co-authored-by: Badal Kumar Prusty <badalkumar@Badals-MacBook-Pro.local>
1 parent a6a2ae2 commit 654ba93

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

docs/setup/install/ingress-setup.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,75 @@
11
# Ingress Setup
22

3+
## Enable Ingress During Installation
4+
5+
To configure Ingress for a Helm chart during installation or upgrade, you can use the `--set` flag to specify the desired Ingress settings. Below is a guide on how to add Ingress, including optional labels, annotations, and TLS settings.
6+
7+
### Basic Ingress Configuration
8+
9+
To enable Ingress and set basic parameters, use the following command:
10+
11+
```bash
12+
helm install devtron devtron/devtron-operator -n devtroncd \
13+
--set components.devtron.ingress.enabled=true \
14+
--set components.devtron.ingress.className=nginx \
15+
--set components.devtron.ingress.host=devtron.example.com
16+
```
17+
18+
### Adding Labels
19+
20+
To add labels to the Ingress resource, use the following command:
21+
22+
```bash
23+
helm install devtron devtron/devtron-operator -n devtroncd \
24+
--set components.devtron.ingress.enabled=true \
25+
--set components.devtron.ingress.className=nginx \
26+
--set components.devtron.ingress.host=devtron.example.com \
27+
--set components.devtron.ingress.labels.env=production
28+
```
29+
30+
### Adding Annotations
31+
32+
To add annotations to the Ingress resource, use the following command:
33+
34+
```bash
35+
helm install devtron devtron/devtron-operator -n devtroncd \
36+
--set components.devtron.ingress.enabled=true \
37+
--set components.devtron.ingress.className=nginx \
38+
--set components.devtron.ingress.host=devtron.example.com \
39+
--set components.devtron.ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
40+
--set components.devtron.ingress.annotations."nginx\.ingress\.kubernetes\.io\/app-root"="/dashboard"
41+
```
42+
43+
### Configuring TLS
44+
45+
To configure TLS settings, including `secretName` and `hosts`, use the following command:
46+
47+
```bash
48+
helm install devtron devtron/devtron-operator -n devtroncd \
49+
--set components.devtron.ingress.enabled=true \
50+
--set components.devtron.ingress.className=nginx \
51+
--set components.devtron.ingress.host=devtron.example.com \
52+
--set components.devtron.ingress.tls[0].secretName=devtron-tls \
53+
--set components.devtron.ingress.tls[0].hosts[0]=devtron.example.com
54+
```
55+
56+
### Comprehensive Configuration
57+
58+
To include all the above settings in a single command, use:
59+
60+
```bash
61+
helm upgrade devtron devtron/devtron-operator -n devtroncd \
62+
--set components.devtron.ingress.enabled=true \
63+
--set components.devtron.ingress.className=nginx \
64+
--set components.devtron.ingress.host=devtron.example.com \
65+
--set components.devtron.ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
66+
--set components.devtron.ingress.annotations."nginx\.ingress\.kubernetes\.io\/app-root"="/dashboard" \
67+
--set components.devtron.ingress.labels.env=production \
68+
--set components.devtron.ingress.pathType=ImplementationSpecific \
69+
--set components.devtron.ingress.tls[0].secretName=devtron-tls \
70+
--set components.devtron.ingress.tls[0].hosts[0]=devtron.example.com
71+
```
72+
373
After Devtron is installed, Devtron is accessible through service `devtron-service`.
474
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:
575

0 commit comments

Comments
 (0)