summaryrefslogtreecommitdiffstats
path: root/kubernetes/dmaap/charts/postgresql/templates/Notes.txt
diff options
context:
space:
mode:
Diffstat (limited to 'kubernetes/dmaap/charts/postgresql/templates/Notes.txt')
-rw-r--r--kubernetes/dmaap/charts/postgresql/templates/Notes.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/kubernetes/dmaap/charts/postgresql/templates/Notes.txt b/kubernetes/dmaap/charts/postgresql/templates/Notes.txt
new file mode 100644
index 0000000000..9b49bb2982
--- /dev/null
+++ b/kubernetes/dmaap/charts/postgresql/templates/Notes.txt
@@ -0,0 +1,35 @@
+# PostgreSQL can be accessed via port 5432 on the following DNS name from within your cluster:
+# {{ template "postgresql.fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local
+#
+# To get your user password run:
+#
+# PGPASSWORD=$(kubectl get secret --namespace {{ .Values.global.nsPrefix }} {{ template "postgresql.fullname" . }} -o jsonpath="{.data.postgres-password}" | base64 --decode; echo)
+#
+# To connect to your database run the following command (using the env variable from above):
+#
+# kubectl run --namespace {{ .Values.global.nsPrefix }} {{ template "postgresql.fullname" . }}-client --restart=Never --rm --tty -i --image postgres \
+# --env "PGPASSWORD=$PGPASSWORD" \{{- if and (.Values.networkPolicy.enabled) (not .Values.networkPolicy.allowExternal) }}
+# --labels="{{ template "postgresql.fullname" . }}-client=true" \{{- end }}
+# --command -- psql -U {{ default "postgres" .Values.postgresUser }} \
+# -h {{ template "postgresql.fullname" . }} {{ default "postgres" .Values.postgresDatabase }}
+#
+# {{ if and (.Values.networkPolicy.enabled) (not .Values.networkPolicy.allowExternal) }}
+# Note: Since NetworkPolicy is enabled, only pods with label
+# {{ template "postgresql.fullname" . }}-client=true"
+# will be able to connect to this PostgreSQL cluster.
+# {{- end }}
+#
+# To connect to your database directly from outside the K8s cluster:
+# {{- if contains "NodePort" .Values.service.type }}
+# PGHOST=$(kubectl get nodes --namespace {{ .Values.global.nsPrefix }} -o jsonpath='{.items[0].status.addresses[0].address}')
+# PGPORT=$(kubectl get svc --namespace {{ .Values.global.nsPrefix }} {{ template "postgresql.fullname" . }} -o jsonpath='{.spec.ports[0].nodePort}')
+#
+# {{- else if contains "ClusterIP" .Values.service.type }}
+# PGHOST=127.0.0.1
+# PGPORT={{ default "5432" .Values.service.port }}
+#
+# # Execute the following commands to route the connection:
+# export POD_NAME=$(kubectl get pods --namespace {{ .Values.global.nsPrefix }} -l "app={{ template "postgresql.fullname" . }}" -o jsonpath="{.items[0].metadata.name}")
+# kubectl port-forward --namespace {{ .Values.global.nsPrefix }} $POD_NAME {{ default "5432" .Values.service.port }}:{{ default "5432" .Values.service.port }}
+#
+# {{- end }}