MongoDB® is a cross-platform document-oriented database. Classified as a NoSQL database, MongoDB® eschews the traditional table-based relational database structure in favor of JSON-like documents with dynamic schemas, making the integration of data in certain types of applications easier and faster.

Disclaimer: The respective trademarks mentioned in the offering are owned by the respective companies. We do not provide a commercial license for any of these products. This listing has an open-source license. MongoDB® is run and maintained by MongoDB, which is a completely separate project from Bitnami.

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/mongodb

Introduction

This chart bootstraps a MongoDB® deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with Fluentd and Prometheus on top of the BKPR.

Prerequisites

Kubernetes 1.12+
Helm 3.1.0
PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install my-release bitnami/mongodb

The command deploys MongoDB® on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Architecture

This chart allows installing MongoDB® using two different architecture setups: standalone or replicaset. Use the architecture parameter to choose the one to use:

architecture="standalone"
architecture="replicaset"

Refer to the chart documentation for more information on each of these architectures.

Parameters

The following tables lists the configurable parameters of the MongoDB® chart and their default values per section/component:

Global parameters

Parameter	Description	Default
`global.imageRegistry`	Global Docker image registry	`nil`
`global.imagePullSecrets`	Global Docker registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`global.storageClass`	Global storage class for dynamic provisioning	`nil`
`global.namespaceOverride`	Global string to override the release namespace	`nil`

Common parameters

Parameter	Description	Default
`nameOverride`	String to partially override mongodb.fullname	`nil`
`fullnameOverride`	String to fully override mongodb.fullname	`nil`
`clusterDomain`	Default Kubernetes cluster domain	`cluster.local`
`extraDeploy`	Array of extra objects to deploy with the release	`[]` (evaluated as a template)
`schedulerName`	Name of the scheduler (other than default) to dispatch pods	`nil`
`image.registry`	MongoDB® image registry	`docker.io`
`image.repository`	MongoDB® image name	`bitnami/mongodb`
`image.tag`	MongoDB® image tag	`{TAG_NAME}`
`image.pullPolicy`	MongoDB® image pull policy	`IfNotPresent`
`image.pullSecrets`	Specify docker-registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`image.debug`	Set to true if you would like to see extra information on logs	`false`

MongoDB® parameters

Parameter	Description	Default
`architecture`	MongoDB® architecture (`standalone` or `replicaset`)	`standalone`
`hostAliases`	Add deployment host aliases	`[]`
`useStatefulSet`	Set to true to use a StatefulSet instead of a Deployment (only when `architecture=standalone`)	`false`
`commonAnnotations`	Annotations to be added to all Mongo resources	`{}`
`auth.enabled`	Enable authentication	`true`
`auth.rootPassword`	MongoDB® admin password	random 10 character long alphanumeric string
`auth.username`	MongoDB® custom user (mandatory if `auth.database` is set)	`nil`
`auth.password`	MongoDB® custom user password	random 10 character long alphanumeric string
`auth.database`	MongoDB® custom database	`nil`
`auth.replicaSetKey`	Key used for authentication in the replicaset (only when `architecture=replicaset`)	random 10 character long alphanumeric string
`auth.existingSecret`	Existing secret with MongoDB® credentials (keys: `mongodb-password`, `mongodb-root-password`, `mongodb-replica-set-key`)	`nil`
`replicaSetName`	Name of the replica set (only when `architecture=replicaset`)	`rs0`
`replicaSetHostnames`	Enable DNS hostnames in the replicaset config (only when `architecture=replicaset`)	`true`
`enableIPv6`	Switch to enable/disable IPv6 on MongoDB®	`false`
`directoryPerDB`	Switch to enable/disable DirectoryPerDB on MongoDB®	`false`
`systemLogVerbosity`	MongoDB® system log verbosity level	`0`
`disableSystemLog`	Switch to enable/disable MongoDB® system log	`false`
`disableJavascript`	Switch to enable/disable MongoDB® server-side JavaScript execution	`false`
`enableJournal`	Switch to enable/disable MongoDB® Journaling	`true`
`configuration`	MongoDB® configuration file to be used	`{}`
`existingConfigmap`	Name of existing ConfigMap with MongoDB® configuration	`nil`
`initdbScripts`	Dictionary of initdb scripts	`nil`
`initdbScriptsConfigMap`	ConfigMap with the initdb scripts	`nil`
`command`	Override default container command (useful when using custom images)	`nil`
`args`	Override default container args (useful when using custom images)	`nil`
`extraFlags`	MongoDB® additional command line flags	`[]`
`extraEnvVars`	Extra environment variables to add to MongoDB® pods	`[]`
`extraEnvVarsCM`	Name of existing ConfigMap containing extra env vars	`nil`
`extraEnvVarsSecret`	Name of existing Secret containing extra env vars (in case of sensitive data)	`nil`
`tls.enabled`	Enable MongoDB® TLS support between nodes in the cluster as well as between mongo clients and nodes	`false`
`tls.existingSecret`	Existing secret with TLS certificates (keys: `mongodb-ca-cert`, `mongodb-ca-key`, `client-pem`)	`nil`
`tls.caCert`	Custom CA certificated (base64 encoded)	`nil`
`tls.caKey`	CA certificate private key (base64 encoded)	`nil`
`tls.image.registry`	Init container TLS certs setup image registry (nginx)	`docker.io`
`tls.image.repository`	Init container TLS certs setup image name (nginx)	`bitnami/nginx`
`tls.image.tag`	Init container TLS certs setup image tag (nginx)	`{TAG_NAME}`
`tls.image.pullPolicy`	Init container TLS certs setup image pull policy (nginx)	`Always`

MongoDB® statefulset parameters

Parameter	Description	Default
`replicaCount`	Number of MongoDB® nodes (only when `architecture=replicaset`)	`2`
`labels`	Annotations to be added to the MongoDB® statefulset	`{}` (evaluated as a template)
`annotations`	Additional labels to be added to the MongoDB® statefulset	`{}` (evaluated as a template)
`podManagementPolicy`	Pod management policy for MongoDB®	`OrderedReady`
`strategyType`	StrategyType for MongoDB® statefulset	`RollingUpdate`
`podLabels`	MongoDB® pod labels	`{}` (evaluated as a template)
`podAnnotations`	MongoDB® Pod annotations	`{}` (evaluated as a template)
`priorityClassName`	Name of the existing priority class to be used by MongoDB® pod(s)	`""`
`podAffinityPreset`	MongoDB® Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`podAntiAffinityPreset`	MongoDB® Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`soft`
`nodeAffinityPreset.type`	MongoDB® Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`nodeAffinityPreset.key`	MongoDB® Node label key to match Ignored if `affinity` is set.	`""`
`nodeAffinityPreset.values`	MongoDB® Node label values to match. Ignored if `affinity` is set.	`[]`
`affinity`	MongoDB® Affinity for pod assignment	`{}` (evaluated as a template)
`nodeSelector`	MongoDB® Node labels for pod assignment	`{}` (evaluated as a template)
`tolerations`	MongoDB® Tolerations for pod assignment	`[]` (evaluated as a template)
`podSecurityContext`	MongoDB® pod(s)' Security Context	Check `values.yaml` file
`containerSecurityContext`	MongoDB® containers' Security Context	Check `values.yaml` file
`resources.limits`	The resources limits for MongoDB® containers	`{}`
`resources.requests`	The requested resources for MongoDB® containers	`{}`
`livenessProbe`	Liveness probe configuration for MongoDB®	Check `values.yaml` file
`readinessProbe`	Readiness probe configuration for MongoDB®	Check `values.yaml` file
`startupProbe`	Startup probe configuration for MongoDB®	Check `values.yaml` file
`customLivenessProbe`	Override default liveness probe for MongoDB® containers	`nil`
`customReadinessProbe`	Override default readiness probe for MongoDB® containers	`nil`
`customStartupProbe`	Override default startup probe for MongoDB® containers	`nil`
`pdb.create`	Enable/disable a Pod Disruption Budget creation for MongoDB® pod(s)	`false`
`pdb.minAvailable`	Minimum number/percentage of MongoDB® pods that should remain scheduled	`1`
`pdb.maxUnavailable`	Maximum number/percentage of MongoDB® pods that may be made unavailable	`nil`
`initContainers`	Add additional init containers for the MongoDB® pod(s)	`{}` (evaluated as a template)
`sidecars`	Add additional sidecar containers for the MongoDB® pod(s)	`{}` (evaluated as a template)
`extraVolumeMounts`	Optionally specify extra list of additional volumeMounts for the MongoDB® container(s)	`{}`
`extraVolumes`	Optionally specify extra list of additional volumes to the MongoDB® statefulset	`{}`

Exposure parameters

Parameter	Description	Default
`service.type`	Kubernetes Service type	`ClusterIP`
`service.nameOverride`	MongoDB® service name	`{mongodb.fullname}-headless`
`service.port`	MongoDB® service port	`27017`
`service.portName`	MongoDB® service port name	`mongodb`
`service.nodePort`	Port to bind to for NodePort and LoadBalancer service types	`""`
`service.clusterIP`	MongoDB® service cluster IP	`nil`
`service.loadBalancerIP`	loadBalancerIP for MongoDB® Service	`nil`
`service.loadBalancerSourceRanges`	Address(es) that are allowed when service is LoadBalancer	`[]`
`service.annotations`	Service annotations	`{}` (evaluated as a template)
`externalAccess.enabled`	Enable Kubernetes external cluster access to MongoDB® nodes	`false`
`externalAccess.autoDiscovery.enabled`	Enable using an init container to auto-detect external IPs by querying the K8s API	`false`
`externalAccess.autoDiscovery.image.registry`	Init container auto-discovery image registry (kubectl)	`docker.io`
`externalAccess.autoDiscovery.image.repository`	Init container auto-discovery image name (kubectl)	`bitnami/kubectl`
`externalAccess.autoDiscovery.image.tag`	Init container auto-discovery image tag (kubectl)	`{TAG_NAME}`
`externalAccess.autoDiscovery.image.pullPolicy`	Init container auto-discovery image pull policy (kubectl)	`Always`
`externalAccess.autoDiscovery.resources.limits`	Init container auto-discovery resource limits	`{}`
`externalAccess.autoDiscovery.resources.requests`	Init container auto-discovery resource requests	`{}`
`externalAccess.service.type`	Kubernetes Service type for external access. It can be NodePort, LoadBalancer or ClusterIP	`LoadBalancer`
`externalAccess.service.port`	MongoDB® port used for external access when service type is LoadBalancer	`27017`
`externalAccess.service.loadBalancerIPs`	Array of load balancer IPs for MongoDB® nodes	`[]`
`externalAccess.service.loadBalancerSourceRanges`	Address(es) that are allowed when service is LoadBalancer	`[]`
`externalAccess.service.domain`	Domain or external IP used to configure MongoDB® advertised hostname when service type is NodePort	`nil`
`externalAccess.service.nodePorts`	Array of node ports used to configure MongoDB® advertised hostname when service type is NodePort	`[]`
`externalAccess.service.annotations`	Service annotations for external access	`{}`(evaluated as a template)
`externalAccess.hidden.enabled`	Enable Kubernetes external cluster access to MongoDB® hidden nodes	`false`
`externalAccess.hidden.service.type`	Kubernetes Service type for external access. It can be NodePort or LoadBalancer	`LoadBalancer`
`externalAccess.hidden.service.port`	MongoDB® port used for external access when service type is LoadBalancer	`27017`
`externalAccess.hidden.service.loadBalancerIPs`	Array of load balancer IPs for MongoDB® nodes	`[]`
`externalAccess.hidden.service.loadBalancerSourceRanges`	Address(es) that are allowed when service is LoadBalancer	`[]`
`externalAccess.hidden.service.domain`	Domain or external IP used to configure MongoDB® advertised hostname when service type is NodePort	`nil`
`externalAccess.hidden.service.nodePorts`	Array of node ports used to configure MongoDB® advertised hostname when service type is NodePort	`[]`
`externalAccess.hidden.service.annotations`	Service annotations for external access	`{}`(evaluated as a template)

Persistence parameters

Parameter	Description	Default
`persistence.enabled`	Enable MongoDB® data persistence using PVC	`true`
`persistence.existingClaim`	Provide an existing `PersistentVolumeClaim` (only when `architecture=standalone`)	`nil` (evaluated as a template)
`persistence.storageClass`	PVC Storage Class for MongoDB® data volume	`nil`
`persistence.accessMode`	PVC Access Mode for MongoDB® data volume	`ReadWriteOnce`
`persistence.size`	PVC Storage Request for MongoDB® data volume	`8Gi`
`persistence.mountPath`	Path to mount the volume at	`/bitnami/mongodb`
`persistence.subPath`	Subdirectory of the volume to mount at	`""`
`persistence.volumeClaimTemplates.selector`	A label query over volumes to consider for binding (e.g. when using local volumes)	``
`persistence.volumeClaimTemplates.dataSource`	Add dataSource to the VolumeClaimTemplate	``
`persistence.volumeClaimTemplates.requests`	Custom PVC requests attributes	`{}` (evaluated as a template)

RBAC parameters

Parameter	Description	Default
`serviceAccount.create`	Enable creation of ServiceAccount for MongoDB® pods	`true`
`serviceAccount.name`	Name of the created serviceAccount	Generated using the `mongodb.fullname` template
`serviceAccount.annotations`	Additional Service Account annotations	`{}`
`rbac.create`	Whether to create & use RBAC resources or not	`false`
`rbac.role.rules`	Custom rules to create following the role specification	`[]`
`podSecurityPolicy.create`	Whether to create & use PSP resource or not (Note: `rbac.create` needs to be `true`)	`false`
`podSecurityPolicy.allowPrivilegeEscalation`	Enable privilege escalation	`false`
`podSecurityPolicy.privileged`	Allow privileged	`false`
`podSecurityPolicy.spec`	The PSP Spec (See https://kubernetes.io/docs/concepts/policy/pod-security-policy/), takes precedence	`{}`

Volume Permissions parameters

Parameter	Description	Default
`volumePermissions.enabled`	Enable init container that changes the owner and group of the persistent volume(s) mountpoint to `runAsUser:fsGroup`	`false`
`volumePermissions.image.registry`	Init container volume-permissions image registry	`docker.io`
`volumePermissions.image.repository`	Init container volume-permissions image name	`bitnami/bitnami-shell`
`volumePermissions.image.tag`	Init container volume-permissions image tag	`"10"`
`volumePermissions.image.pullPolicy`	Init container volume-permissions image pull policy	`Always`
`volumePermissions.image.pullSecrets`	Specify docker-registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`volumePermissions.resources.limits`	Init container volume-permissions resource limits	`{}`
`volumePermissions.resources.requests`	Init container volume-permissions resource requests	`{}`
`volumePermissions.securityContext`	Security context of the init container	Check `values.yaml` file

Arbiter parameters

Parameter	Description	Default
`arbiter.enabled`	Enable deploying the arbiter	`true`
`arbiter.hostAliases`	Add deployment host aliases	`[]`
`arbiter.configuration`	Arbiter configuration file to be used	`{}`
`arbiter.existingConfigmap`	Name of existing ConfigMap with Arbiter configuration	`nil`
`arbiter.command`	Override default container command (useful when using custom images)	`nil`
`arbiter.args`	Override default container args (useful when using custom images)	`nil`
`arbiter.extraFlags`	Arbiter additional command line flags	`[]`
`arbiter.extraEnvVars`	Extra environment variables to add to Arbiter pods	`[]`
`arbiter.extraEnvVarsCM`	Name of existing ConfigMap containing extra env vars	`nil`
`arbiter.extraEnvVarsSecret`	Name of existing Secret containing extra env vars (in case of sensitive data)	`nil`
`arbiter.labels`	Annotations to be added to the Arbiter statefulset	`{}` (evaluated as a template)
`arbiter.annotations`	Additional labels to be added to the Arbiter statefulset	`{}` (evaluated as a template)
`arbiter.podLabels`	Arbiter pod labels	`{}` (evaluated as a template)
`arbiter.podAnnotations`	Arbiter Pod annotations	`{}` (evaluated as a template)
`arbiter.priorityClassName`	Name of the existing priority class to be used by Arbiter pod(s)	`""`
`arbiter.podAffinityPreset`	Arbiter Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`arbiter.podAntiAffinityPreset`	Arbiter Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`soft`
`arbiter.nodeAffinityPreset.type`	Arbiter Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`arbiter.nodeAffinityPreset.key`	Arbiter Node label key to match Ignored if `affinity` is set.	`""`
`arbiter.nodeAffinityPreset.values`	Arbiter Node label values to match. Ignored if `affinity` is set.	`[]`
`arbiter.affinity`	Arbiter Affinity for pod assignment	`{}` (evaluated as a template)
`arbiter.nodeSelector`	Arbiter Node labels for pod assignment	`{}` (evaluated as a template)
`arbiter.tolerations`	Arbiter Tolerations for pod assignment	`[]` (evaluated as a template)
`arbiter.podSecurityContext`	Arbiter pod(s)' Security Context	Check `values.yaml` file
`arbiter.containerSecurityContext`	Arbiter containers' Security Context	Check `values.yaml` file
`arbiter.resources.limits`	The resources limits for Arbiter containers	`{}`
`arbiter.resources.requests`	The requested resources for Arbiter containers	`{}`
`arbiter.livenessProbe`	Liveness probe configuration for Arbiter	Check `values.yaml` file
`arbiter.readinessProbe`	Readiness probe configuration for Arbiter	Check `values.yaml` file
`arbiter.customLivenessProbe`	Override default liveness probe for Arbiter containers	`nil`
`arbiter.customReadinessProbe`	Override default readiness probe for Arbiter containers	`nil`
`arbiter.pdb.create`	Enable/disable a Pod Disruption Budget creation for Arbiter pod(s)	`false`
`arbiter.pdb.minAvailable`	Minimum number/percentage of Arbiter pods that should remain scheduled	`1`
`arbiter.pdb.maxUnavailable`	Maximum number/percentage of Arbiter pods that may be made unavailable	`nil`
`arbiter.initContainers`	Add additional init containers for the Arbiter pod(s)	`{}` (evaluated as a template)
`arbiter.sidecars`	Add additional sidecar containers for the Arbiter pod(s)	`{}` (evaluated as a template)
`arbiter.extraVolumeMounts`	Optionally specify extra list of additional volumeMounts for the Arbiter container(s)	`{}`
`arbiter.extraVolumes`	Optionally specify extra list of additional volumes to the Arbiter statefulset	`{}`
`arbiter.service.nameOverride`	The arbiter service name	`{mongodb.fullname}-arbiter-headless`

Hidden Node parameters

Parameter	Description	Default
`hidden.enabled`	Enable deploying the hidden nodes	`false`
`hidden.hostAliases`	Add deployment host aliases	`[]`
`hidden.configuration`	Hidden node configuration file to be used	`{}`
`hidden.existingConfigmap`	Name of existing ConfigMap with Hidden node configuration	`nil`
`hidden.command`	Override default container command (useful when using custom images)	`nil`
`hidden.args`	Override default container args (useful when using custom images)	`nil`
`hidden.extraFlags`	Hidden node additional command line flags	`[]`
`hidden.extraEnvVars`	Extra environment variables to add to Hidden node pods	`[]`
`hidden.extraEnvVarsCM`	Name of existing ConfigMap containing extra env vars	`nil`
`hidden.extraEnvVarsSecret`	Name of existing Secret containing extra env vars (in case of sensitive data)	`nil`
`hidden.replicaCount`	Number of hidden nodes (only when `architecture=replicaset`)	`2`
`hidden.labels`	Annotations to be added to the hidden node statefulset	`{}` (evaluated as a template)
`hidden.annotations`	Additional labels to be added to thehidden node statefulset	`{}` (evaluated as a template)
`hidden.podManagementPolicy`	Pod management policy for hidden node	`OrderedReady`
`hidden.strategyType`	StrategyType for hidden node statefulset	`RollingUpdate`
`hidden.podLabels`	Hidden node pod labels	`{}` (evaluated as a template)
`hidden.podAnnotations`	Hidden node Pod annotations	`{}` (evaluated as a template)
`hidden.priorityClassName`	Name of the existing priority class to be used by hidden node pod(s)	`""`
`hidden.podAffinityPreset`	Hidden node Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`hidden.podAntiAffinityPreset`	Hidden node Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`soft`
`hidden.nodeAffinityPreset.type`	Hidden Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`hidden.nodeAffinityPreset.key`	Hidden Node label key to match Ignored if `affinity` is set.	`""`
`hidden.nodeAffinityPreset.values`	Hidden Node label values to match. Ignored if `affinity` is set.	`[]`
`hidden.affinity`	Hidden node Affinity for pod assignment	`{}` (evaluated as a template)
`hidden.nodeSelector`	Hidden node Node labels for pod assignment	`{}` (evaluated as a template)
`hidden.tolerations`	Hidden node Tolerations for pod assignment	`[]` (evaluated as a template)
`hidden.resources.limits`	The resources limits for hidden node containers	`{}`
`hidden.resources.requests`	The requested resources for hidden node containers	`{}`
`hidden.livenessProbe`	Liveness probe configuration for hidden node	Check `values.yaml` file
`hidden.readinessProbe`	Readiness probe configuration for hidden node	Check `values.yaml` file
`hidden.customLivenessProbe`	Override default liveness probe for hidden node containers	`nil`
`hidden.customReadinessProbe`	Override default readiness probe for hidden node containers	`nil`
`hidden.pdb.create`	Enable/disable a Pod Disruption Budget creation for hidden node pod(s)	`false`
`hidden.pdb.minAvailable`	Minimum number/percentage of hidden node pods that should remain scheduled	`1`
`hidden.pdb.maxUnavailable`	Maximum number/percentage of hidden node pods that may be made unavailable	`nil`
`initContainers`	Add additional init containers for the hidden node pod(s)	`{}` (evaluated as a template)
`hidden.sidecars`	Add additional sidecar containers for the hidden node pod(s)	`{}` (evaluated as a template)
`hidden.extraVolumeMounts`	Optionally specify extra list of additional volumeMounts for the hidden node container(s)	`{}`
`hidden.extraVolumes`	Optionally specify extra list of additional volumes to the hidden node statefulset	`{}`
`hidden.persistence.enabled`	Enable hidden node data persistence using PVC	`true`
`hidden.persistence.storageClass`	PVC Storage Class for hidden node data volume	`nil`
`hidden.persistence.accessMode`	PVC Access Mode for hidden node data volume	`ReadWriteOnce`
`hidden.persistence.size`	PVC Storage Request for hidden node data volume	`8Gi`
`hidden.persistence.mountPath`	Path to mount the volume at	`/bitnami/mongodb`
`hidden.persistence.subPath`	Subdirectory of the volume to mount at	`""`
`persistence.volumeClaimTemplates.selector`	A label query over volumes to consider for binding (e.g. when using local volumes)	``
`persistence.volumeClaimTemplates.dataSource`	Add dataSource to the VolumeClaimTemplate	``
`persistence.volumeClaimTemplates.requests`	Custom PVC requests attributes	`{}` (evaluated as a template)

Metrics parameters

Parameter	Description	Default
`metrics.enabled`	Enable using a sidecar Prometheus exporter	`false`
`metrics.image.registry`	MongoDB® Prometheus exporter image registry	`docker.io`
`metrics.image.repository`	MongoDB® Prometheus exporter image name	`bitnami/mongodb-exporter`
`metrics.image.tag`	MongoDB® Prometheus exporter image tag	`{TAG_NAME}`
`metrics.image.pullPolicy`	MongoDB® Prometheus exporter image pull policy	`Always`
`metrics.image.pullSecrets`	Specify docker-registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`metrics.extraFlags`	Additional command line flags	`""`
`metrics.extraUri`	Additional URI options of the metrics service	`""`
`metrics.service.type`	Type of the Prometheus metrics service	`ClusterIP file`
`metrics.containerPort`	Port of the Prometheus metrics container	`9216`
`metrics.service.port`	Port of the Prometheus metrics service	`9216`
`metrics.service.annotations`	Annotations for Prometheus metrics service	Check `values.yaml` file
`metrics.resources.limits`	The resources limits for Prometheus exporter containers	`{}`
`metrics.resources.requests`	The requested resources for Prometheus exporter containers	`{}`
`metrics.livenessProbe`	Liveness probe configuration for Prometheus exporter	Check `values.yaml` file
`metrics.readinessProbe`	Readiness probe configuration for Prometheus exporter	Check `values.yaml` file
`metrics.serviceMonitor.enabled`	Create ServiceMonitor Resource for scraping metrics using Prometheus Operator	`false`
`metrics.serviceMonitor.namespace`	Namespace which Prometheus is running in	`monitoring`
`metrics.serviceMonitor.interval`	Interval at which metrics should be scraped	`30s`
`metrics.serviceMonitor.scrapeTimeout`	Specify the timeout after which the scrape is ended	`nil`
`metrics.serviceMonitor.additionalLabels`	Used to pass Labels that are required by the Installed Prometheus Operator	`{}`
`metrics.prometheusRule.enabled`	Set this to true to create prometheusRules for Prometheus operator	`false`
`metrics.prometheusRule.namespace`	namespace where prometheusRules resource should be created	`monitoring`
`metrics.prometheusRule.rules`	Rules to be created, check values for an example.	`[]`
`metrics.prometheusRule.additionalLabels`	Additional labels that can be used so prometheusRules will be discovered by Prometheus	`{}`

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
    --set auth.rootPassword=secretpassword,auth.username=my-user,auth.password=my-password,auth.database=my-database \
    bitnami/mongodb

The above command sets the MongoDB® root account password to secretpassword. Additionally, it creates a standard database user named my-user, with the password my-password, who has access to a database named my-database.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/mongodb

Tip

: You can use the default values.yaml

Configuration and installation details

Rolling vs Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Customize a new MongoDB instance

The Bitnami MongoDB® image supports the use of custom scripts to initialize a fresh instance. In order to execute the scripts, two options are available:

Specify them using the initdbScripts parameter as dict.
Define an external Kubernetes ConfigMap with all the initialization scripts by setting the initdbScriptsConfigMap parameter. Note that this will override the previous option.

The allowed script extensions are .sh and .js.

Replicaset: Access MongoDB® nodes from outside the cluster

In order to access MongoDB® nodes from outside the cluster when using a replicaset architecture, a specific service per MongoDB® pod will be created. There are two ways of configuring external access:

Using LoadBalancer services
Using NodePort services.

Refer to the chart documentation for more details and configuration examples.

Add extra environment variables

To add extra environment variables (useful for advanced operations like custom init scripts), use the extraEnvVars property.

extraEnvVars:
  - name: LOG_LEVEL
    value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret properties.

Use Sidecars and Init Containers

If additional containers are needed in the same pod (such as additional metrics or logging exporters), they can be defined using the sidecars config parameter. Similarly, extra init containers can be added using the initContainers parameter.

Refer to the chart documentation for more information on, and examples of, configuring and using sidecars and init containers.

Persistence

The Bitnami MongoDB® image stores the MongoDB® data and configurations at the /bitnami/mongodb path of the container.

The chart mounts a Persistent Volume at this location. The volume is created using dynamic volume provisioning.

If you encounter errors when working with persistent volumes, refer to our troubleshooting guide for persistent volumes.

Use custom Prometheus rules

Custom Prometheus rules can be defined for the Prometheus Operator by using the prometheusRule parameter.

Refer to the chart documentation for an example of a custom rule.

Enable SSL/TLS

This chart supports enabling SSL/TLS between nodes in the cluster, as well as between MongoDB® clients and nodes, by setting the MONGODB_EXTRA_FLAGS and MONGODB_CLIENT_EXTRA_FLAGS container environment variables, together with the correct MONGODB_ADVERTISED_HOSTNAME. To enable full TLS encryption, set the tls.enabled parameter to true.

Refer to the chart documentation for more information on enabling TLS.

Set Pod affinity

This chart allows you to set your custom affinity using the XXX.affinity parameter(s). Find more information about Pod affinity in the Kubernetes documentation.

As an alternative, you can use the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the XXX.podAffinityPreset, XXX.podAntiAffinityPreset, or XXX.nodeAffinityPreset parameters.

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

If authentication is enabled, it's necessary to set the auth.rootPassword (also auth.replicaSetKey when using a replicaset architecture) when upgrading for readiness/liveness probes to work properly. When you install this chart for the first time, some notes will be displayed providing the credentials you must use under the 'Credentials' section. Please note down the password, and run the command below to upgrade your chart:

$ helm upgrade my-release bitnami/mongodb --set auth.rootPassword=[PASSWORD] (--set auth.replicaSetKey=[REPLICASETKEY])

Note: you need to substitute the placeholders [PASSWORD] and [REPLICASETKEY] with the values obtained in the installation notes.

To 10.0.0

On November 13, 2020, Helm v2 support formally ended. This major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

Learn more about this change and related upgrade considerations.

To 9.0.0

MongoDB® container images were updated to 4.4.x and it can affect compatibility with older versions of MongoDB®. Refer to the following guides to upgrade your applications:

To 8.0.0

Architecture used to configure MongoDB® as a replicaset was completely refactored. Now, both primary and secondary nodes are part of the same statefulset.
Chart labels were adapted to follow the Helm charts best practices.
This version introduces bitnami/common, a library chart as a dependency. More documentation about this new utility could be found here. Please, make sure that you have updated the chart dependencies before executing any upgrade.
Several parameters were renamed or disappeared in favor of new ones on this major version. These are the most important ones:
- replicas is renamed to replicaCount.
- Authentication parameters are reorganized under the auth.* parameter:
  - usePassword is renamed to auth.enabled.
  - mongodbRootPassword, mongodbUsername, mongodbPassword, mongodbDatabase, and replicaSet.key are now auth.rootPassword, auth.username, auth.password, auth.database, and auth.replicaSetKey respectively.
- securityContext.* is deprecated in favor of podSecurityContext and containerSecurityContext.
- Parameters prefixed with mongodb are renamed removing the prefix. E.g. mongodbEnableIPv6 is renamed to enableIPv6.
- Parameters affecting Arbiter nodes are reorganized under the arbiter.* parameter.

Consequences:

Backwards compatibility is not guaranteed. To upgrade to 8.0.0, install a new release of the MongoDB® chart, and migrate your data by creating a backup of the database, and restoring it on the new release.

To 7.0.0

From this version, the way of setting the ingress rules has changed. Instead of using ingress.paths and ingress.hosts as separate objects, you should now define the rules as objects inside the ingress.hosts value, for example:

ingress:
  hosts:
  - name: mongodb.local
    path: /

To 6.0.0

From this version, mongodbEnableIPv6 is set to false by default in order to work properly in most k8s clusters, if you want to use IPv6 support, you need to set this variable to true by adding --set mongodbEnableIPv6=true to your helm command. You can find more information in the bitnami/mongodb image README.

To 5.0.0

When enabling replicaset configuration, backwards compatibility is not guaranteed unless you modify the labels used on the chart's statefulsets. Use the workaround below to upgrade from versions previous to 5.0.0. The following example assumes that the release name is my-release:

$ kubectl delete statefulset my-release-mongodb-arbiter my-release-mongodb-primary my-release-mongodb-secondary --cascade=false

Add extra deployment options

To add extra deployments (useful for advanced features like sidecars), use the extraDeploy property.

In the example below, you can find how to use a example here for a MongoDB replica set pod labeler sidecar to identify the primary pod and dynamically label it as the primary node:

extraDeploy:
  - apiVersion: v1
    kind: Service
    metadata:
      name: mongodb-primary
      namespace: default
      labels:
        app.kubernetes.io/component: mongodb
        app.kubernetes.io/instance: mongodb
        app.kubernetes.io/managed-by: Helm
        app.kubernetes.io/name: mongodb
    spec:
      type: NodePort
      externalTrafficPolicy: Cluster
      ports:
        - name: mongodb-primary
          port: 30001
          nodePort: 30001
          protocol: TCP
          targetPort: mongodb
      selector:
        app.kubernetes.io/component: mongodb
        app.kubernetes.io/instance: mongodb
        app.kubernetes.io/name: mongodb
        primary: "true"

README.md Unescape Escape

MongoDB® packaged by Bitnami