kubernetes/common/mongodb/templates/NOTES.txt - onap/oom - Gitiles

 CHART NAME: {{ .Chart.Name }}
 CHART VERSION: {{ .Chart.Version }}
 APP VERSION: {{ .Chart.AppVersion }}

 {{- if .Values.diagnosticMode.enabled }}
 The chart has been deployed in diagnostic mode. All probes have been disabled and the command has been overwritten with:

   command: {{- include "common.tplvalues.render" (dict "value" .Values.diagnosticMode.command "context" $) | nindent 4 }}
   args: {{- include "common.tplvalues.render" (dict "value" .Values.diagnosticMode.args "context" $) | nindent 4 }}

 Get the list of pods by executing:

   kubectl get pods --namespace {{ .Release.Namespace }} -l app.kubernetes.io/instance={{ .Release.Name }}

 Access the pod you want to debug by executing

   kubectl exec --namespace {{ .Release.Namespace }} -ti <NAME OF THE POD> -- bash

 In order to replicate the container startup scripts execute this command:

     /opt/bitnami/scripts/mongodb/entrypoint.sh /opt/bitnami/scripts/mongodb/run.sh

 {{- else }}

 {{- $replicaCount := int .Values.replicaCount }}
 {{- $portNumber := int .Values.service.ports.mongodb }}
 {{- $fullname := include "mongodb.fullname" . }}
 {{- $releaseNamespace := include "mongodb.namespace" . }}
 {{- $clusterDomain := .Values.clusterDomain }}
 {{- $loadBalancerIPListLength := len .Values.externalAccess.service.loadBalancerIPs }}
 {{- $mongoList := list }}
 {{- range $e, $i := until $replicaCount }}
 {{- $mongoList = append $mongoList (printf "%s-%d.%s-headless.%s.svc.%s:%d" $fullname $i $fullname $releaseNamespace $clusterDomain $portNumber) }}
 {{- end }}

 {{- if and (eq .Values.architecture "replicaset") .Values.externalAccess.enabled (not .Values.externalAccess.autoDiscovery.enabled) (not (eq $replicaCount $loadBalancerIPListLength )) (eq .Values.externalAccess.service.type "LoadBalancer") }}

 ####################################################################################
 ### ERROR: You enabled external access to MongoDB&reg; nodes without specifying  ###
 ###   the array of load balancer IPs for MongoDB&reg; nodes.                     ###
 ####################################################################################

 This deployment will be incomplete until you configure the array of load balancer
 IPs for MongoDB&reg; nodes. To complete your deployment follow the steps below:

 1. Wait for the load balancer IPs (it may take a few minutes for them to be available):

     kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb" -w

 2. Obtain the load balancer IPs and upgrade your chart:

     {{- range $e, $i := until $replicaCount }}
     LOAD_BALANCER_IP_{{ add $i 1 }}="$(kubectl get svc --namespace {{ $releaseNamespace }} {{ $fullname }}-{{ $i }}-external -o jsonpath='{.status.loadBalancer.ingress[0].ip}')"
     {{- end }}

 3. Upgrade you chart:

     helm upgrade --namespace {{ .Release.Namespace }} {{ .Release.Name }} oci://registry-1.docker.io/bitnamicharts/{{ .Chart.Name }} \
       --set mongodb.replicaCount={{ $replicaCount }} \
       --set mongodb.externalAccess.enabled=true \
       {{- range $i, $e := until $replicaCount }}
       --set mongodb.externalAccess.service.loadBalancerIPs[{{ $i }}]=$LOAD_BALANCER_IP_{{ add $i 1 }} \
       {{- end }}
       --set mongodb.externalAccess.service.type=LoadBalancer

 {{- else }}

 {{- if and (or (and (eq .Values.architecture "standalone") (or (eq .Values.service.type "LoadBalancer") (eq .Values.service.type "NodePort"))) (and (eq .Values.architecture "replicaset") .Values.externalAccess.enabled)) (not .Values.auth.enabled) }}
 -------------------------------------------------------------------------------
  WARNING

     By not enabling "mongodb.auth.enabled" you have most likely exposed the
     MongoDB&reg; service externally without any authentication mechanism.

     For security reasons, we strongly suggest that you enable authentiation
     setting the "mongodb.auth.enabled" parameter to "true".

 -------------------------------------------------------------------------------
 {{- end }}

 ** Please be patient while the chart is being deployed **

 MongoDB&reg; can be accessed on the following DNS name(s) and ports from within your cluster:

 {{- if eq .Values.architecture "replicaset" }}
 {{ join "\n" $mongoList | nindent 4 }}
 {{- else }}

     {{ $fullname }}.{{ $releaseNamespace }}.svc.{{ .Values.clusterDomain }}

 {{- end }}

 {{- if .Values.auth.enabled }}

 To get the root password run:

     export MONGODB_ROOT_PASSWORD=$(kubectl get secret --namespace {{ template "mongodb.namespace" . }} {{ template "mongodb.secretName" . }} -o jsonpath="{.data.mongodb-root-password}" | base64 -d)

 {{- end }}
 {{- $customUsers := include "mongodb.customUsers" . -}}
 {{- $customDatabases := include "mongodb.customDatabases" . -}}
 {{- if and (not (empty $customUsers)) (not (empty $customDatabases)) }}
 {{- $customUsersList := splitList "," $customUsers }}
 {{- range $index, $user := $customUsersList }}

 To get the password for "{{ $user }}" run:

     export MONGODB_PASSWORD=$(kubectl get secret --namespace {{ include "mongodb.namespace" $ }} {{ include "mongodb.secretName" $ }} -o jsonpath="{.data.mongodb-passwords}" | base64 -d | awk -F',' '{print ${{ add 1 $index }}}')

 {{- end }}
 {{- end }}

 To connect to your database, create a MongoDB&reg; client container:

     kubectl run --namespace {{ template "mongodb.namespace" . }} {{ template "mongodb.fullname" . }}-client --rm --tty -i --restart='Never' --env="MONGODB_ROOT_PASSWORD=$MONGODB_ROOT_PASSWORD" --image {{ template "mongodb.image" . }} --command -- bash

 Then, run the following command:

     {{- if eq .Values.architecture "replicaset" }}
     mongosh admin --host "{{ join "," $mongoList }}" {{- if .Values.auth.enabled }} --authenticationDatabase admin -u $MONGODB_ROOT_USER -p $MONGODB_ROOT_PASSWORD{{- end }}
     {{- else }}
     mongosh admin --host "{{ template "mongodb.service.nameOverride" . }}" {{- if .Values.auth.enabled }} --authenticationDatabase admin -u $MONGODB_ROOT_USER -p $MONGODB_ROOT_PASSWORD{{- end }}
     {{- end }}

 {{- if and (eq .Values.architecture "replicaset") .Values.externalAccess.enabled }}

 To connect to your database nodes from outside, you need to add both primary and secondary nodes hostnames/IPs to your Mongo client. To obtain them, follow the instructions below:

 {{- if eq "NodePort" .Values.externalAccess.service.type }}
 {{- if .Values.externalAccess.service.domain }}

     MongoDB&reg; nodes domain: Use your provided hostname to reach MongoDB&reg; nodes, {{ .Values.externalAccess.service.domain }}

 {{- else }}

     MongoDB&reg; nodes domain: you can reach MongoDB&reg; nodes on any of the K8s nodes external IPs.

         kubectl get nodes -o wide

 {{- end }}

     MongoDB&reg; nodes port: You will have a different node port for each MongoDB&reg; node. You can get the list of configured node ports using the command below:

         echo "$(kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb,pod" -o jsonpath='{.items[*].spec.ports[0].nodePort}' | tr ' ' '\n')"

 {{- else if contains "LoadBalancer" .Values.externalAccess.service.type }}

   NOTE: It may take a few minutes for the LoadBalancer IPs to be available.
         Watch the status with: 'kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb,pod" -w'

     MongoDB&reg; nodes domain: You will have a different external IP for each MongoDB&reg; node. You can get the list of external IPs using the command below:

         echo "$(kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb,pod" -o jsonpath='{.items[*].status.loadBalancer.ingress[0].ip}' | tr ' ' '\n')"

     MongoDB&reg; nodes port: {{ .Values.externalAccess.service.ports.mongodb }}

 {{- end }}

 {{- else if eq .Values.architecture "standalone" }}

 To connect to your database from outside the cluster execute the following commands:

 {{- if contains "NodePort" .Values.service.type }}

     export NODE_IP=$(kubectl get nodes --namespace {{ template "mongodb.namespace" . }} -o jsonpath="{.items[0].status.addresses[0].address}")
     export NODE_PORT=$(kubectl get --namespace {{ template "mongodb.namespace" . }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "mongodb.service.nameOverride" . }})
     mongo --host $NODE_IP --port $NODE_PORT {{- if .Values.auth.enabled }} --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD{{- end }}

 {{- else if contains "LoadBalancer" .Values.service.type }}

   NOTE: It may take a few minutes for the LoadBalancer IP to be available.
         Watch the status with: 'kubectl get svc --namespace {{ template "mongodb.namespace" . }} -w {{ template "mongodb.service.nameOverride" . }}'

     export SERVICE_IP=$(kubectl get svc --namespace {{ template "mongodb.namespace" . }} {{ template "mongodb.service.nameOverride" . }} --template "{{ "{{ range (index .status.loadBalancer.ingress 0) }}{{ . }}{{ end }}" }}")
     mongosh --host $SERVICE_IP --port {{ $portNumber }} {{- if .Values.auth.enabled }} --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD{{- end }}

 {{- else if contains "ClusterIP" .Values.service.type }}

     kubectl port-forward --namespace {{ template "mongodb.namespace" . }} svc/{{ template "mongodb.service.nameOverride" . }} {{ $portNumber }}:{{ $portNumber }} &
     mongosh --host 127.0.0.1 {{- if .Values.auth.enabled }} --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD{{- end }}

 {{- end }}
 {{- end }}
 {{- end }}

 {{- if .Values.metrics.enabled }}

 To access the MongoDB&reg; Prometheus metrics, get the MongoDB&reg; Prometheus URL by running:

     kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ printf "%s-metrics" (include "mongodb.fullname" .) }} {{ .Values.metrics.service.ports.metrics }}:{{ .Values.metrics.service.ports.metrics }} &
     echo "Prometheus Metrics URL: http://127.0.0.1:{{ .Values.metrics.service.ports.metrics }}/metrics"

 Then, open the obtained URL in a browser.

 {{- end }}
 {{- end }}
 {{- include "common.warnings.rollingTag" .Values.image }}
 {{- include "common.warnings.rollingTag" .Values.metrics.image }}
 {{- include "common.warnings.rollingTag" .Values.externalAccess.autoDiscovery.image }}
 {{- include "common.warnings.rollingTag" .Values.volumePermissions.image }}
 {{- include "common.warnings.rollingTag" .Values.tls.image }}
 {{- include "mongodb.validateValues" . }}
 {{- include "common.warnings.resources" (dict "sections" (list "arbiter" "externalAccess.autoDiscovery" "hidden" "metrics" "" "tls" "volumePermissions") "context" $) }}
	CHART NAME: {{ .Chart.Name }}
	CHART VERSION: {{ .Chart.Version }}
	APP VERSION: {{ .Chart.AppVersion }}

	{{- if .Values.diagnosticMode.enabled }}
	The chart has been deployed in diagnostic mode. All probes have been disabled and the command has been overwritten with:

	command: {{- include "common.tplvalues.render" (dict "value" .Values.diagnosticMode.command "context" $) \| nindent 4 }}
	args: {{- include "common.tplvalues.render" (dict "value" .Values.diagnosticMode.args "context" $) \| nindent 4 }}

	Get the list of pods by executing:

	kubectl get pods --namespace {{ .Release.Namespace }} -l app.kubernetes.io/instance={{ .Release.Name }}

	Access the pod you want to debug by executing

	kubectl exec --namespace {{ .Release.Namespace }} -ti <NAME OF THE POD> -- bash

	In order to replicate the container startup scripts execute this command:

	/opt/bitnami/scripts/mongodb/entrypoint.sh /opt/bitnami/scripts/mongodb/run.sh

	{{- else }}

	{{- $replicaCount := int .Values.replicaCount }}
	{{- $portNumber := int .Values.service.ports.mongodb }}
	{{- $fullname := include "mongodb.fullname" . }}
	{{- $releaseNamespace := include "mongodb.namespace" . }}
	{{- $clusterDomain := .Values.clusterDomain }}
	{{- $loadBalancerIPListLength := len .Values.externalAccess.service.loadBalancerIPs }}
	{{- $mongoList := list }}
	{{- range $e, $i := until $replicaCount }}
	{{- $mongoList = append $mongoList (printf "%s-%d.%s-headless.%s.svc.%s:%d" $fullname $i $fullname $releaseNamespace $clusterDomain $portNumber) }}
	{{- end }}

	{{- if and (eq .Values.architecture "replicaset") .Values.externalAccess.enabled (not .Values.externalAccess.autoDiscovery.enabled) (not (eq $replicaCount $loadBalancerIPListLength )) (eq .Values.externalAccess.service.type "LoadBalancer") }}

	####################################################################################
	### ERROR: You enabled external access to MongoDB® nodes without specifying ###
	### the array of load balancer IPs for MongoDB® nodes. ###
	####################################################################################

	This deployment will be incomplete until you configure the array of load balancer
	IPs for MongoDB® nodes. To complete your deployment follow the steps below:

	1. Wait for the load balancer IPs (it may take a few minutes for them to be available):

	kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb" -w

	2. Obtain the load balancer IPs and upgrade your chart:

	{{- range $e, $i := until $replicaCount }}
	LOAD_BALANCER_IP_{{ add $i 1 }}="$(kubectl get svc --namespace {{ $releaseNamespace }} {{ $fullname }}-{{ $i }}-external -o jsonpath='{.status.loadBalancer.ingress[0].ip}')"
	{{- end }}

	3. Upgrade you chart:

	helm upgrade --namespace {{ .Release.Namespace }} {{ .Release.Name }} oci://registry-1.docker.io/bitnamicharts/{{ .Chart.Name }} \
	--set mongodb.replicaCount={{ $replicaCount }} \
	--set mongodb.externalAccess.enabled=true \
	{{- range $i, $e := until $replicaCount }}
	--set mongodb.externalAccess.service.loadBalancerIPs[{{ $i }}]=$LOAD_BALANCER_IP_{{ add $i 1 }} \
	{{- end }}
	--set mongodb.externalAccess.service.type=LoadBalancer

	{{- else }}

	{{- if and (or (and (eq .Values.architecture "standalone") (or (eq .Values.service.type "LoadBalancer") (eq .Values.service.type "NodePort"))) (and (eq .Values.architecture "replicaset") .Values.externalAccess.enabled)) (not .Values.auth.enabled) }}
	-------------------------------------------------------------------------------
	WARNING

	By not enabling "mongodb.auth.enabled" you have most likely exposed the
	MongoDB® service externally without any authentication mechanism.

	For security reasons, we strongly suggest that you enable authentiation
	setting the "mongodb.auth.enabled" parameter to "true".

	-------------------------------------------------------------------------------
	{{- end }}

	Please be patient while the chart is being deployed

	MongoDB® can be accessed on the following DNS name(s) and ports from within your cluster:

	{{- if eq .Values.architecture "replicaset" }}
	{{ join "\n" $mongoList \| nindent 4 }}
	{{- else }}

	{{ $fullname }}.{{ $releaseNamespace }}.svc.{{ .Values.clusterDomain }}

	{{- end }}

	{{- if .Values.auth.enabled }}

	To get the root password run:

	export MONGODB_ROOT_PASSWORD=$(kubectl get secret --namespace {{ template "mongodb.namespace" . }} {{ template "mongodb.secretName" . }} -o jsonpath="{.data.mongodb-root-password}" \| base64 -d)

	{{- end }}
	{{- $customUsers := include "mongodb.customUsers" . -}}
	{{- $customDatabases := include "mongodb.customDatabases" . -}}
	{{- if and (not (empty $customUsers)) (not (empty $customDatabases)) }}
	{{- $customUsersList := splitList "," $customUsers }}
	{{- range $index, $user := $customUsersList }}

	To get the password for "{{ $user }}" run:

	export MONGODB_PASSWORD=$(kubectl get secret --namespace {{ include "mongodb.namespace" $ }} {{ include "mongodb.secretName" $ }} -o jsonpath="{.data.mongodb-passwords}" \| base64 -d \| awk -F',' '{print ${{ add 1 $index }}}')

	{{- end }}
	{{- end }}

	To connect to your database, create a MongoDB® client container:

	kubectl run --namespace {{ template "mongodb.namespace" . }} {{ template "mongodb.fullname" . }}-client --rm --tty -i --restart='Never' --env="MONGODB_ROOT_PASSWORD=$MONGODB_ROOT_PASSWORD" --image {{ template "mongodb.image" . }} --command -- bash

	Then, run the following command:

	{{- if eq .Values.architecture "replicaset" }}
	mongosh admin --host "{{ join "," $mongoList }}" {{- if .Values.auth.enabled }} --authenticationDatabase admin -u $MONGODB_ROOT_USER -p $MONGODB_ROOT_PASSWORD{{- end }}
	{{- else }}
	mongosh admin --host "{{ template "mongodb.service.nameOverride" . }}" {{- if .Values.auth.enabled }} --authenticationDatabase admin -u $MONGODB_ROOT_USER -p $MONGODB_ROOT_PASSWORD{{- end }}
	{{- end }}

	{{- if and (eq .Values.architecture "replicaset") .Values.externalAccess.enabled }}

	To connect to your database nodes from outside, you need to add both primary and secondary nodes hostnames/IPs to your Mongo client. To obtain them, follow the instructions below:

	{{- if eq "NodePort" .Values.externalAccess.service.type }}
	{{- if .Values.externalAccess.service.domain }}

	MongoDB® nodes domain: Use your provided hostname to reach MongoDB® nodes, {{ .Values.externalAccess.service.domain }}

	{{- else }}

	MongoDB® nodes domain: you can reach MongoDB® nodes on any of the K8s nodes external IPs.

	kubectl get nodes -o wide

	{{- end }}

	MongoDB® nodes port: You will have a different node port for each MongoDB® node. You can get the list of configured node ports using the command below:

	echo "$(kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb,pod" -o jsonpath='{.items[*].spec.ports[0].nodePort}' \| tr ' ' '\n')"

	{{- else if contains "LoadBalancer" .Values.externalAccess.service.type }}

	NOTE: It may take a few minutes for the LoadBalancer IPs to be available.
	Watch the status with: 'kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb,pod" -w'

	MongoDB® nodes domain: You will have a different external IP for each MongoDB® node. You can get the list of external IPs using the command below:

	echo "$(kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ template "mongodb.name" . }},app.kubernetes.io/instance={{ .Release.Name }},app.kubernetes.io/component=mongodb,pod" -o jsonpath='{.items[*].status.loadBalancer.ingress[0].ip}' \| tr ' ' '\n')"

	MongoDB® nodes port: {{ .Values.externalAccess.service.ports.mongodb }}

	{{- end }}

	{{- else if eq .Values.architecture "standalone" }}

	To connect to your database from outside the cluster execute the following commands:

	{{- if contains "NodePort" .Values.service.type }}

	export NODE_IP=$(kubectl get nodes --namespace {{ template "mongodb.namespace" . }} -o jsonpath="{.items[0].status.addresses[0].address}")
	export NODE_PORT=$(kubectl get --namespace {{ template "mongodb.namespace" . }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "mongodb.service.nameOverride" . }})
	mongo --host $NODE_IP --port $NODE_PORT {{- if .Values.auth.enabled }} --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD{{- end }}

	{{- else if contains "LoadBalancer" .Values.service.type }}

	NOTE: It may take a few minutes for the LoadBalancer IP to be available.
	Watch the status with: 'kubectl get svc --namespace {{ template "mongodb.namespace" . }} -w {{ template "mongodb.service.nameOverride" . }}'

	export SERVICE_IP=$(kubectl get svc --namespace {{ template "mongodb.namespace" . }} {{ template "mongodb.service.nameOverride" . }} --template "{{ "{{ range (index .status.loadBalancer.ingress 0) }}{{ . }}{{ end }}" }}")
	mongosh --host $SERVICE_IP --port {{ $portNumber }} {{- if .Values.auth.enabled }} --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD{{- end }}

	{{- else if contains "ClusterIP" .Values.service.type }}

	kubectl port-forward --namespace {{ template "mongodb.namespace" . }} svc/{{ template "mongodb.service.nameOverride" . }} {{ $portNumber }}:{{ $portNumber }} &
	mongosh --host 127.0.0.1 {{- if .Values.auth.enabled }} --authenticationDatabase admin -p $MONGODB_ROOT_PASSWORD{{- end }}

	{{- end }}
	{{- end }}
	{{- end }}

	{{- if .Values.metrics.enabled }}

	To access the MongoDB® Prometheus metrics, get the MongoDB® Prometheus URL by running:

	kubectl port-forward --namespace {{ .Release.Namespace }} svc/{{ printf "%s-metrics" (include "mongodb.fullname" .) }} {{ .Values.metrics.service.ports.metrics }}:{{ .Values.metrics.service.ports.metrics }} &
	echo "Prometheus Metrics URL: http://127.0.0.1:{{ .Values.metrics.service.ports.metrics }}/metrics"

	Then, open the obtained URL in a browser.

	{{- end }}
	{{- end }}
	{{- include "common.warnings.rollingTag" .Values.image }}
	{{- include "common.warnings.rollingTag" .Values.metrics.image }}
	{{- include "common.warnings.rollingTag" .Values.externalAccess.autoDiscovery.image }}
	{{- include "common.warnings.rollingTag" .Values.volumePermissions.image }}
	{{- include "common.warnings.rollingTag" .Values.tls.image }}
	{{- include "mongodb.validateValues" . }}
	{{- include "common.warnings.resources" (dict "sections" (list "arbiter" "externalAccess.autoDiscovery" "hidden" "metrics" "" "tls" "volumePermissions") "context" $) }}