Skip to content

Commit 1fd7efd

Browse files
committed
docs(wik-webservice): improve NOTES.txt with dynamic feature sections
1 parent f5a492e commit 1fd7efd

1 file changed

Lines changed: 49 additions & 9 deletions

File tree

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,56 @@
1-
Your {{ .Chart.Name }} chart has been installed successfully!
1+
πŸš€ {{ .Chart.Name }} v{{ .Chart.Version }} deployed successfully!
22

3-
To get more information about your deployment, run:
3+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
44

5-
kubectl get deployment {{ .Release.Name }}-{{ .Chart.Name }}
5+
πŸ“¦ DEPLOYMENT STATUS
66

7-
To check the status of your pods, run:
7+
kubectl get deployment {{ include "fullname" . }} -n {{ .Release.Namespace }}
8+
kubectl get pods -l app=wik-webservice,release={{ .Release.Name }} -n {{ .Release.Namespace }}
89

9-
kubectl get pods -l app.kubernetes.io/name={{ .Chart.Name }},app.kubernetes.io/instance={{ .Release.Name }}
10+
{{- if .Values.webservice.hosts }}
1011

11-
To access your service, check the ingress details:
12+
🌐 INGRESS
13+
{{- range .Values.webservice.hosts }}
14+
https://{{ . }}
15+
{{- end }}
1216

13-
kubectl get ingress {{ .Release.Name }}-{{ .Chart.Name }}
17+
kubectl get ingress {{ include "fullname" $ }} -n {{ $.Release.Namespace }}
18+
{{- end }}
1419

15-
For more information on using the chart, see the documentation at:
16-
https://github.com/wikodit/charts/tree/main/charts/{{ .Chart.Name }}
20+
{{- if .Values.webservice.service.enabled }}
21+
22+
πŸ”Œ SERVICE
23+
24+
kubectl get svc {{ include "fullname" . }} -n {{ .Release.Namespace }}
25+
{{- end }}
26+
27+
{{- if .Values.webservice.metrics.enabled }}
28+
29+
πŸ“Š METRICS
30+
31+
Metrics endpoint: :{{ .Values.webservice.metrics.port }}{{ .Values.webservice.metrics.path }}
32+
{{- end }}
33+
34+
{{- if .Values.serviceMonitor.enabled }}
35+
36+
ServiceMonitor enabled for Prometheus scraping
37+
{{- end }}
38+
39+
{{- if .Values.webservice.hpa.enabled }}
40+
41+
βš–οΈ AUTOSCALING
42+
43+
HPA enabled (min: {{ .Values.webservice.hpa.minReplicas }}, max: {{ .Values.webservice.hpa.maxReplicas }})
44+
kubectl get hpa {{ include "fullname" . }} -n {{ .Release.Namespace }}
45+
{{- end }}
46+
47+
{{- if .Values.podDisruptionBudget.enabled }}
48+
49+
πŸ›‘οΈ POD DISRUPTION BUDGET
50+
51+
kubectl get pdb {{ include "fullname" . }} -n {{ .Release.Namespace }}
52+
{{- end }}
53+
54+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
55+
56+
πŸ“š Documentation: https://github.com/wikodit/charts/tree/main/charts/{{ .Chart.Name }}

0 commit comments

Comments
Β (0)