Skip to content

Commit 9d405ae

Browse files
author
Divya Bhushan
authored
docs: Editing the template notes (#1726)
* docs: Editing the template notes * Updating notes.txt * Removing the repeated line in notes.txt
1 parent ec6f40d commit 9d405ae

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

charts/devtron/templates/NOTES.txt

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,48 @@
11

2-
1. Run the following command to get the default admin password. Default username is admin
2+
1. Run the following command to get the password for the default `admin` user:
33

4-
kubectl -n devtroncd get secret devtron-secret -o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
5-
{{- if $.Values.components.devtron.ingress.enabled }}
4+
kubectl -n devtroncd get secret devtron-secret \
5+
-o jsonpath='{.data.ACD_PASSWORD}' | base64 -d
66

7-
2. Your devtron dashboard will be available for http on http://{{ .Values.components.devtron.ingress.host }}/dashboard or for https on https://{{ .Values.components.devtron.ingress.host }}/dashboard
7+
{{- if $.Values.components.devtron.ingress.enabled }}
8+
2. The Devtron dashboard URL for
89

9-
{{- else if eq $.Values.components.devtron.service.type "LoadBalancer" }}
10+
- `http` is: `http://{{ .Values.components.devtron.ingress.host }}/dashboard`
11+
- `https` is `https://{{ .Values.components.devtron.ingress.host }}/dashboard`
1012

11-
2. You can get url of devtron dashboard by the following command
13+
3. Run the following command to get the dashboard URL for the service type:
1214

13-
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
15+
{{- else if eq $.Values.components.devtron.service.type "LoadBalancer" }}
16+
3.1 LoadBalancer
17+
18+
kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'
19+
1420
{{- else if eq $.Values.components.devtron.service.type "NodePort" }}
15-
16-
2. You can get the devtron dashboard by following the steps mentioned below
21+
3.2 NodePort
1722

1823
a. export nodeport=$(kubectl get svc -n devtroncd devtron-service -o jsonpath="{.spec.ports[0].nodePort}")
1924

20-
b. Run the following command to get Devtron dashboard URL
21-
22-
echo http://HOST_IP:$nodeport/dashboard
23-
24-
Make sure that your security settings allow incoming connection to your Host machine on the nodeport mentioned.
25-
26-
25+
b. Run the following command to get Devtron dashboard URL: `echo http://HOST_IP:$nodeport/dashboard`
2726
{{- else if eq $.Values.components.devtron.service.type "ClusterIP" }}
27+
3.3 ClusterIP
28+
29+
Make sure that your security settings allow incoming connection to your Host machine on the nodeport mentioned.
2830

29-
2. You can get the devtron dashboard by the following command
31+
{{- else if eq $.Values.components.devtron.service.type "ClusterIP" }}
3032

31-
kubectl get svc -n devtroncd devtron-service
33+
kubectl get svc -n devtroncd devtron-service
3234

3335
You can port-forward devtron-service in namespace devtroncd to access devtron dashboard. You can use the following command to port forward.
34-
36+
3537
kubectl -n devtroncd port-forward svc/devtron-service 8000:80
36-
The dashboard should be accesible on http://localhost:8000/
38+
39+
The dashboard should be accesible on `http://localhost:8000/`
3740
{{- end }}
3841

3942
{{- if $.Values.installer.modules }}
40-
41-
3. You can watch the progress of Devtron microservices installation by the following command
43+
3. To track the progress of Devtron microservices installation, run the following command:
4244

4345
kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync.status}'
46+
4447
{{- end }}
4548

0 commit comments

Comments
 (0)