Skip to content

Commit fcf961c

Browse files
Merge pull request #57 from marklogic/feature/CLD-551
CLD-551: Create NOTES.txt for Helm Chart
2 parents 40edd34 + 2727321 commit fcf961c

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

charts/templates/NOTES.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{{- define "marklogic.fqdn" -}}
2+
{{- printf "%s-0.%s.%s.svc.cluster.local" (include "marklogic.fullname" .) (include "marklogic.headlessServiceName" .) .Release.Namespace }}
3+
{{- end}}
4+
5+
Thank you for installing {{ .Chart.Name }}.
6+
7+
Your release is named {{ .Release.Name }}.
8+
9+
FQDN is {{ include "marklogic.fqdn" . }}
10+
11+
Group {{ .Values.group.name }} is created on the MarkLogic cluster.
12+
13+
{{- if .Values.group.enableXdqpSsl }}
14+
xdqp-ssl-enabled is turned on for {{ .Values.group.name }} group.
15+
{{- else }}
16+
xdqp-ssl-enabled is turned off for {{ .Values.group.name }} group.
17+
{{- end }}
18+
19+
To get pods in the {{ .Release.Namespace }} namespace, try:
20+
21+
$ kubectl get pods --namespace={{ .Release.Namespace }}
22+
23+
To get all services in the {{ .Release.Namespace }} namespace, try:
24+
25+
$ kubectl get services --namespace={{ .Release.Namespace }}
26+
27+
To get admin credentials of the MarkLogic cluster, run:
28+
29+
$ kubectl get secret {{ include "marklogic.fullname" . }}-admin -o jsonpath='{.data.password}' | base64 --decode
30+
31+
To connect to the {{ .Chart.Name }} cluster, use port forwarding:
32+
33+
To access the whole cluster, forward the port to the service:
34+
35+
$ kubectl port-forward svc/{{ include "marklogic.fullname" . }} 8001:8001
36+
37+
To access first pod, forward the port to the pod using:
38+
39+
$ kubectl port-forward {{ include "marklogic.fullname" . }}-0 8001:8001
40+
41+
MarkLogic admin UI can be accessed at http://localhost:8001

0 commit comments

Comments
 (0)