MongoDB® packaged by VMware - View the list of available chart parameters
The chart supports the parameters shown below.
NOTE: These parameters apply to chart version 14.0.1.
Global parameters
| Name | Description | Value |
|---|---|---|
global.imageRegistry |
Global Docker image registry | "" |
global.imagePullSecrets |
Global Docker registry secret names as an array | [] |
global.storageClass |
Global StorageClass for Persistent Volume(s) | "" |
global.namespaceOverride |
Override the namespace for resource deployed by the chart, but can itself be overridden by the local namespaceOverride | "" |
Common parameters
| Name | Description | Value |
|---|---|---|
nameOverride |
String to partially override mongodb.fullname template (will maintain the release name) | "" |
fullnameOverride |
String to fully override mongodb.fullname template | "" |
namespaceOverride |
String to fully override common.names.namespace | "" |
kubeVersion |
Force target Kubernetes version (using Helm capabilities if not set) | "" |
clusterDomain |
Default Kubernetes cluster domain | cluster.local |
extraDeploy |
Array of extra objects to deploy with the release | [] |
commonLabels |
Add labels to all the deployed resources (sub-charts are not considered). Evaluated as a template | {} |
commonAnnotations |
Common annotations to add to all Mongo resources (sub-charts are not considered). Evaluated as a template | {} |
topologyKey |
Override common lib default topology key. If empty - "kubernetes.io/hostname" is used | "" |
serviceBindings.enabled |
Create secret for service binding (Experimental) | false |
diagnosticMode.enabled |
Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command |
Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args |
Args to override all containers in the deployment | ["infinity"] |
MongoDB(®) parameters
| Name | Description | Value |
|---|---|---|
image.registry |
MongoDB(®) image registry | docker.io |
image.repository |
MongoDB(®) image registry | bitnami/mongodb |
image.tag |
MongoDB(®) image tag (immutable tags are recommended) |
|
image.digest |
MongoDB(®) image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy |
MongoDB(®) image pull policy | IfNotPresent |
image.pullSecrets |
Specify docker-registry secret names as an array | [] |
image.debug |
Set to true if you would like to see extra information on logs | false |
schedulerName |
Name of the scheduler (other than default) to dispatch pods | "" |
architecture |
MongoDB(®) architecture (standalone or replicaset) |
standalone |
useStatefulSet |
Set to true to use a StatefulSet instead of a Deployment (only when architecture=standalone) |
false |
auth.enabled |
Enable authentication | true |
auth.rootUser |
MongoDB(®) root user | root |
auth.rootPassword |
MongoDB(®) root password | "" |
auth.usernames |
List of custom users to be created during the initialization | [] |
auth.passwords |
List of passwords for the custom users set at auth.usernames |
[] |
auth.databases |
List of custom databases to be created during the initialization | [] |
auth.username |
DEPRECATED: use auth.usernames instead |
"" |
auth.password |
DEPRECATED: use auth.passwords instead |
"" |
auth.database |
DEPRECATED: use auth.databases instead |
"" |
auth.replicaSetKey |
Key used for authentication in the replicaset (only when architecture=replicaset) |
"" |
auth.existingSecret |
Existing secret with MongoDB(®) credentials (keys: mongodb-passwords, mongodb-root-password, mongodb-metrics-password, mongodb-replica-set-key) |
"" |
tls.enabled |
Enable MongoDB(®) TLS support between nodes in the cluster as well as between mongo clients and nodes | false |
tls.autoGenerated |
Generate a custom CA and self-signed certificates | true |
tls.existingSecret |
Existing secret with TLS certificates (keys: mongodb-ca-cert, mongodb-ca-key) |
"" |
tls.caCert |
Custom CA certificated (base64 encoded) | "" |
tls.caKey |
CA certificate private key (base64 encoded) | "" |
tls.pemChainIncluded |
Flag to denote that the Certificate Authority (CA) certificates are bundled with the endpoint cert. | false |
tls.standalone.existingSecret |
Existing secret with TLS certificates (tls.key, tls.crt, ca.crt) or (tls.key, tls.crt) with tls.pemChainIncluded set as enabled. |
"" |
tls.replicaset.existingSecrets |
Array of existing secrets with TLS certificates (tls.key, tls.crt, ca.crt) or (tls.key, tls.crt) with tls.pemChainIncluded set as enabled. |
[] |
tls.hidden.existingSecrets |
Array of existing secrets with TLS certificates (tls.key, tls.crt, ca.crt) or (tls.key, tls.crt) with tls.pemChainIncluded set as enabled. |
[] |
tls.arbiter.existingSecret |
Existing secret with TLS certificates (tls.key, tls.crt, ca.crt) or (tls.key, tls.crt) with tls.pemChainIncluded set as enabled. |
"" |
tls.image.registry |
Init container TLS certs setup image registry | docker.io |
tls.image.repository |
Init container TLS certs setup image repository | bitnami/nginx |
tls.image.tag |
Init container TLS certs setup image tag (immutable tags are recommended) |
|
tls.image.digest |
Init container TLS certs setup image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
tls.image.pullPolicy |
Init container TLS certs setup image pull policy | IfNotPresent |
tls.image.pullSecrets |
Init container TLS certs specify docker-registry secret names as an array | [] |
tls.extraDnsNames |
Add extra dns names to the CA, can solve x509 auth issue for pod clients | [] |
tls.mode |
Allows to set the tls mode which should be used when tls is enabled (options: allowTLS, preferTLS, requireTLS) |
requireTLS |
tls.resources.limits |
Init container generate-tls-certs resource limits | {} |
tls.resources.requests |
Init container generate-tls-certs resource requests | {} |
hostAliases |
Add deployment host aliases | [] |
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 for Primary and Secondary nodes | "" |
replicaSetConfigurationSettings settings applied during runtime (not via configuration file)
| Name | Description | Value |
|---|---|---|
replicaSetConfigurationSettings.enabled |
Enable MongoDB(®) Switch to enable/disable configuring MongoDB(®) run time rs.conf settings | false |
replicaSetConfigurationSettings.configuration |
run-time rs.conf settings | {} |
existingConfigmap |
Name of existing ConfigMap with MongoDB(®) configuration for Primary and Secondary nodes | "" |
initdbScripts |
Dictionary of initdb scripts | {} |
initdbScriptsConfigMap |
Existing ConfigMap with custom initdb scripts | "" |
command |
Override default container command (useful when using custom images) | [] |
args |
Override default container args (useful when using custom images) | [] |
extraFlags |
MongoDB(®) additional command line flags | [] |
extraEnvVars |
Extra environment variables to add to MongoDB(®) pods | [] |
extraEnvVarsCM |
Name of existing ConfigMap containing extra env vars | "" |
extraEnvVarsSecret |
Name of existing Secret containing extra env vars (in case of sensitive data) | "" |
MongoDB(®) statefulset parameters
| Name | Description | Value |
|---|---|---|
annotations |
Additional labels to be added to the MongoDB(®) statefulset. Evaluated as a template | {} |
labels |
Annotations to be added to the MongoDB(®) statefulset. Evaluated as a template | {} |
replicaCount |
Number of MongoDB(®) nodes (only when architecture=replicaset) |
2 |
updateStrategy.type |
Strategy to use to replace existing MongoDB(®) pods. When architecture=standalone and useStatefulSet=false, | RollingUpdate |
podManagementPolicy |
Pod management policy for MongoDB(®) | OrderedReady |
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 | {} |
nodeSelector |
MongoDB(®) Node labels for pod assignment | {} |
tolerations |
MongoDB(®) Tolerations for pod assignment | [] |
topologySpreadConstraints |
MongoDB(®) Spread Constraints for Pods | [] |
lifecycleHooks |
LifecycleHook for the MongoDB(®) container(s) to automate configuration before or after startup | {} |
terminationGracePeriodSeconds |
MongoDB(®) Termination Grace Period | "" |
podLabels |
MongoDB(®) pod labels | {} |
podAnnotations |
MongoDB(®) Pod annotations | {} |
priorityClassName |
Name of the existing priority class to be used by MongoDB(®) pod(s) | "" |
runtimeClassName |
Name of the runtime class to be used by MongoDB(®) pod(s) | "" |
podSecurityContext.enabled |
Enable MongoDB(®) pod(s)' Security Context | true |
podSecurityContext.fsGroup |
Group ID for the volumes of the MongoDB(®) pod(s) | 1001 |
podSecurityContext.sysctls |
sysctl settings of the MongoDB(®) pod(s)' | [] |
containerSecurityContext.enabled |
Enable MongoDB(®) container(s)' Security Context | true |
containerSecurityContext.runAsUser |
User ID for the MongoDB(®) container | 1001 |
containerSecurityContext.runAsGroup |
Group ID for the MongoDB(®) container | 0 |
containerSecurityContext.runAsNonRoot |
Set MongoDB(®) container's Security Context runAsNonRoot | true |
containerSecurityContext.allowPrivilegeEscalation |
Is it possible to escalate MongoDB(®) pod(s) privileges | false |
containerSecurityContext.seccompProfile.type |
Set MongoDB(®) container's Security Context seccompProfile type | RuntimeDefault |
containerSecurityContext.capabilities.drop |
Set MongoDB(®) container's Security Context capabilities to drop | ["ALL"] |
resources.limits |
The resources limits for MongoDB(®) containers | {} |
resources.requests |
The requested resources for MongoDB(®) containers | {} |
containerPorts.mongodb |
MongoDB(®) container port | 27017 |
livenessProbe.enabled |
Enable livenessProbe | true |
livenessProbe.initialDelaySeconds |
Initial delay seconds for livenessProbe | 30 |
livenessProbe.periodSeconds |
Period seconds for livenessProbe | 20 |
livenessProbe.timeoutSeconds |
Timeout seconds for livenessProbe | 10 |
livenessProbe.failureThreshold |
Failure threshold for livenessProbe | 6 |
livenessProbe.successThreshold |
Success threshold for livenessProbe | 1 |
readinessProbe.enabled |
Enable readinessProbe | true |
readinessProbe.initialDelaySeconds |
Initial delay seconds for readinessProbe | 5 |
readinessProbe.periodSeconds |
Period seconds for readinessProbe | 10 |
readinessProbe.timeoutSeconds |
Timeout seconds for readinessProbe | 5 |
readinessProbe.failureThreshold |
Failure threshold for readinessProbe | 6 |
readinessProbe.successThreshold |
Success threshold for readinessProbe | 1 |
startupProbe.enabled |
Enable startupProbe | false |
startupProbe.initialDelaySeconds |
Initial delay seconds for startupProbe | 5 |
startupProbe.periodSeconds |
Period seconds for startupProbe | 20 |
startupProbe.timeoutSeconds |
Timeout seconds for startupProbe | 10 |
startupProbe.failureThreshold |
Failure threshold for startupProbe | 30 |
startupProbe.successThreshold |
Success threshold for startupProbe | 1 |
customLivenessProbe |
Override default liveness probe for MongoDB(®) containers | {} |
customReadinessProbe |
Override default readiness probe for MongoDB(®) containers | {} |
customStartupProbe |
Override default startup probe for MongoDB(®) containers | {} |
initContainers |
Add additional init containers for the hidden node pod(s) | [] |
sidecars |
Add additional sidecar containers for the MongoDB(®) pod(s) | [] |
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 | [] |
pdb.create |
Enable/disable a Pod Disruption Budget creation for MongoDB(®) pod(s) | false |
pdb.minAvailable |
Minimum number/percentage of MongoDB(®) pods that must still be available after the eviction | 1 |
pdb.maxUnavailable |
Maximum number/percentage of MongoDB(®) pods that may be made unavailable after the eviction | "" |
Traffic exposure parameters
| Name | Description | Value |
|---|---|---|
service.nameOverride |
MongoDB(®) service name | "" |
service.type |
Kubernetes Service type (only for standalone architecture) | ClusterIP |
service.portName |
MongoDB(®) service port name (only for standalone architecture) | mongodb |
service.ports.mongodb |
MongoDB(®) service port. | 27017 |
service.nodePorts.mongodb |
Port to bind to for NodePort and LoadBalancer service types (only for standalone architecture) | "" |
service.clusterIP |
MongoDB(®) service cluster IP (only for standalone architecture) | "" |
service.externalIPs |
Specify the externalIP value ClusterIP service type (only for standalone architecture) | [] |
service.loadBalancerIP |
loadBalancerIP for MongoDB(®) Service (only for standalone architecture) | "" |
service.loadBalancerClass |
loadBalancerClass for MongoDB(®) Service (only for standalone architecture) | "" |
service.loadBalancerSourceRanges |
Address(es) that are allowed when service is LoadBalancer (only for standalone architecture) | [] |
service.allocateLoadBalancerNodePorts |
Wheter to allocate node ports when service type is LoadBalancer | true |
service.extraPorts |
Extra ports to expose (normally used with the sidecar value) |
[] |
service.annotations |
Provide any additional annotations that may be required | {} |
service.externalTrafficPolicy |
service external traffic policy (only for standalone architecture) | Local |
service.sessionAffinity |
Control where client requests go, to the same pod or round-robin | None |
service.sessionAffinityConfig |
Additional settings for the sessionAffinity | {} |
service.headless.annotations |
Annotations for the headless service. | {} |
externalAccess.enabled |
Enable Kubernetes external cluster access to MongoDB(®) nodes (only for replicaset architecture) | 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 | docker.io |
externalAccess.autoDiscovery.image.repository |
Init container auto-discovery image repository | bitnami/kubectl |
externalAccess.autoDiscovery.image.tag |
Init container auto-discovery image tag (immutable tags are recommended) |
|
externalAccess.autoDiscovery.image.digest |
Init container auto-discovery image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
externalAccess.autoDiscovery.image.pullPolicy |
Init container auto-discovery image pull policy | IfNotPresent |
externalAccess.autoDiscovery.image.pullSecrets |
Init container auto-discovery image pull secrets | [] |
externalAccess.autoDiscovery.resources.limits |
Init container auto-discovery resource limits | {} |
externalAccess.autoDiscovery.resources.requests |
Init container auto-discovery resource requests | {} |
externalAccess.externalMaster.enabled |
Use external master for bootstrapping | false |
externalAccess.externalMaster.host |
External master host to bootstrap from | "" |
externalAccess.externalMaster.port |
Port for MongoDB(®) service external master host | 27017 |
externalAccess.service.type |
Kubernetes Service type for external access. Allowed values: NodePort, LoadBalancer or ClusterIP | LoadBalancer |
externalAccess.service.portName |
MongoDB(®) port name used for external access when service type is LoadBalancer | mongodb |
externalAccess.service.ports.mongodb |
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.loadBalancerClass |
loadBalancerClass when service type is LoadBalancer | "" |
externalAccess.service.loadBalancerSourceRanges |
Address(es) that are allowed when service is LoadBalancer | [] |
externalAccess.service.allocateLoadBalancerNodePorts |
Wheter to allocate node ports when service type is LoadBalancer | true |
externalAccess.service.externalTrafficPolicy |
MongoDB(®) service external traffic policy | Local |
externalAccess.service.nodePorts |
Array of node ports used to configure MongoDB(®) advertised hostname when service type is NodePort | [] |
externalAccess.service.domain |
Domain or external IP used to configure MongoDB(®) advertised hostname when service type is NodePort | "" |
externalAccess.service.extraPorts |
Extra ports to expose (normally used with the sidecar value) |
[] |
externalAccess.service.annotations |
Service annotations for external access | {} |
externalAccess.service.sessionAffinity |
Control where client requests go, to the same pod or round-robin | None |
externalAccess.service.sessionAffinityConfig |
Additional settings for the sessionAffinity | {} |
externalAccess.hidden.enabled |
Enable Kubernetes external cluster access to MongoDB(®) hidden nodes | false |
externalAccess.hidden.service.type |
Kubernetes Service type for external access. Allowed values: NodePort or LoadBalancer | LoadBalancer |
externalAccess.hidden.service.portName |
MongoDB(®) port name used for external access when service type is LoadBalancer | mongodb |
externalAccess.hidden.service.ports.mongodb |
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.loadBalancerClass |
loadBalancerClass when service type is LoadBalancer | "" |
externalAccess.hidden.service.loadBalancerSourceRanges |
Address(es) that are allowed when service is LoadBalancer | [] |
externalAccess.hidden.service.allocateLoadBalancerNodePorts |
Wheter to allocate node ports when service type is LoadBalancer | true |
externalAccess.hidden.service.externalTrafficPolicy |
MongoDB(®) service external traffic policy | Local |
externalAccess.hidden.service.nodePorts |
Array of node ports used to configure MongoDB(®) advertised hostname when service type is NodePort. Length must be the same as replicaCount | [] |
externalAccess.hidden.service.domain |
Domain or external IP used to configure MongoDB(®) advertised hostname when service type is NodePort | "" |
externalAccess.hidden.service.extraPorts |
Extra ports to expose (normally used with the sidecar value) |
[] |
externalAccess.hidden.service.annotations |
Service annotations for external access | {} |
externalAccess.hidden.service.sessionAffinity |
Control where client requests go, to the same pod or round-robin | None |
externalAccess.hidden.service.sessionAffinityConfig |
Additional settings for the sessionAffinity | {} |
Persistence parameters
| Name | Description | Value |
|---|---|---|
persistence.enabled |
Enable MongoDB(®) data persistence using PVC | true |
persistence.medium |
Provide a medium for emptyDir volumes. |
"" |
persistence.existingClaim |
Provide an existing PersistentVolumeClaim (only when architecture=standalone) |
"" |
persistence.resourcePolicy |
Setting it to "keep" to avoid removing PVCs during a helm delete operation. Leaving it empty will delete PVCs after the chart deleted | "" |
persistence.storageClass |
PVC Storage Class for MongoDB(®) data volume | "" |
persistence.accessModes |
PV Access Mode | ["ReadWriteOnce"] |
persistence.size |
PVC Storage Request for MongoDB(®) data volume | 8Gi |
persistence.annotations |
PVC annotations | {} |
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.requests |
Custom PVC requests attributes | {} |
persistence.volumeClaimTemplates.dataSource |
Add dataSource to the VolumeClaimTemplate | {} |
Backup parameters
| Name | Description | Value |
|---|---|---|
backup.enabled |
Enable the logical dump of the database "regularly" | false |
backup.cronjob.schedule |
Set the cronjob parameter schedule | @daily |
backup.cronjob.concurrencyPolicy |
Set the cronjob parameter concurrencyPolicy | Allow |
backup.cronjob.failedJobsHistoryLimit |
Set the cronjob parameter failedJobsHistoryLimit | 1 |
backup.cronjob.successfulJobsHistoryLimit |
Set the cronjob parameter successfulJobsHistoryLimit | 3 |
backup.cronjob.startingDeadlineSeconds |
Set the cronjob parameter startingDeadlineSeconds | "" |
backup.cronjob.ttlSecondsAfterFinished |
Set the cronjob parameter ttlSecondsAfterFinished | "" |
backup.cronjob.restartPolicy |
Set the cronjob parameter restartPolicy | OnFailure |
backup.cronjob.containerSecurityContext.runAsUser |
User ID for the backup container | 1001 |
backup.cronjob.containerSecurityContext.runAsGroup |
Group ID for the backup container | 0 |
backup.cronjob.containerSecurityContext.runAsNonRoot |
Set backup container's Security Context runAsNonRoot | true |
backup.cronjob.containerSecurityContext.readOnlyRootFilesystem |
Is the container itself readonly | true |
backup.cronjob.containerSecurityContext.allowPrivilegeEscalation |
Is it possible to escalate backup pod(s) privileges | false |
backup.cronjob.containerSecurityContext.seccompProfile.type |
Set backup container's Security Context seccompProfile type | RuntimeDefault |
backup.cronjob.containerSecurityContext.capabilities.drop |
Set backup container's Security Context capabilities to drop | ["ALL"] |
backup.cronjob.command |
Set backup container's command to run | [] |
backup.cronjob.labels |
Set the cronjob labels | {} |
backup.cronjob.annotations |
Set the cronjob annotations | {} |
backup.cronjob.storage.existingClaim |
Provide an existing PersistentVolumeClaim (only when architecture=standalone) |
"" |
backup.cronjob.storage.resourcePolicy |
Setting it to "keep" to avoid removing PVCs during a helm delete operation. Leaving it empty will delete PVCs after the chart deleted | "" |
backup.cronjob.storage.storageClass |
PVC Storage Class for the backup data volume | "" |
backup.cronjob.storage.accessModes |
PV Access Mode | ["ReadWriteOnce"] |
backup.cronjob.storage.size |
PVC Storage Request for the backup data volume | 8Gi |
backup.cronjob.storage.annotations |
PVC annotations | {} |
backup.cronjob.storage.mountPath |
Path to mount the volume at | /backup/mongodb |
backup.cronjob.storage.subPath |
Subdirectory of the volume to mount at | "" |
backup.cronjob.storage.volumeClaimTemplates.selector |
A label query over volumes to consider for binding (e.g. when using local volumes) | {} |
RBAC parameters
| Name | Description | Value |
|---|---|---|
serviceAccount.create |
Enable creation of ServiceAccount for MongoDB(®) pods | true |
serviceAccount.name |
Name of the created serviceAccount | "" |
serviceAccount.annotations |
Additional Service Account annotations | {} |
serviceAccount.automountServiceAccountToken |
Allows auto mount of ServiceAccountToken on the serviceAccount created | true |
rbac.create |
Whether to create & use RBAC resources or not | false |
rbac.rules |
Custom rules to create following the role specification | [] |
podSecurityPolicy.create |
Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later | false |
podSecurityPolicy.allowPrivilegeEscalation |
Enable privilege escalation | false |
podSecurityPolicy.privileged |
Allow privileged | false |
podSecurityPolicy.spec |
Specify the full spec to use for Pod Security Policy | {} |
Volume Permissions parameters
| Name | Description | Value |
|---|---|---|
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 repository | bitnami/os-shell |
volumePermissions.image.tag |
Init container volume-permissions image tag (immutable tags are recommended) |
|
volumePermissions.image.digest |
Init container volume-permissions image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
volumePermissions.image.pullPolicy |
Init container volume-permissions image pull policy | IfNotPresent |
volumePermissions.image.pullSecrets |
Specify docker-registry secret names as an array | [] |
volumePermissions.resources.limits |
Init container volume-permissions resource limits | {} |
volumePermissions.resources.requests |
Init container volume-permissions resource requests | {} |
volumePermissions.securityContext.runAsUser |
User ID for the volumePermissions container | 0 |
Arbiter parameters
| Name | Description | Value |
|---|---|---|
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 | "" |
arbiter.command |
Override default container command (useful when using custom images) | [] |
arbiter.args |
Override default container args (useful when using custom images) | [] |
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 | "" |
arbiter.extraEnvVarsSecret |
Name of existing Secret containing extra env vars (in case of sensitive data) | "" |
arbiter.annotations |
Additional labels to be added to the Arbiter statefulset | {} |
arbiter.labels |
Annotations to be added to the Arbiter statefulset | {} |
arbiter.topologySpreadConstraints |
MongoDB(®) Spread Constraints for arbiter Pods | [] |
arbiter.lifecycleHooks |
LifecycleHook for the Arbiter container to automate configuration before or after startup | {} |
arbiter.terminationGracePeriodSeconds |
Arbiter Termination Grace Period | "" |
arbiter.updateStrategy.type |
Strategy that will be employed to update Pods in the StatefulSet | RollingUpdate |
arbiter.podManagementPolicy |
Pod management policy for MongoDB(®) | OrderedReady |
arbiter.schedulerName |
Name of the scheduler (other than default) to dispatch pods | "" |
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 | {} |
arbiter.nodeSelector |
Arbiter Node labels for pod assignment | {} |
arbiter.tolerations |
Arbiter Tolerations for pod assignment | [] |
arbiter.podLabels |
Arbiter pod labels | {} |
arbiter.podAnnotations |
Arbiter Pod annotations | {} |
arbiter.priorityClassName |
Name of the existing priority class to be used by Arbiter pod(s) | "" |
arbiter.runtimeClassName |
Name of the runtime class to be used by Arbiter pod(s) | "" |
arbiter.podSecurityContext.enabled |
Enable Arbiter pod(s)' Security Context | true |
arbiter.podSecurityContext.fsGroup |
Group ID for the volumes of the Arbiter pod(s) | 1001 |
arbiter.podSecurityContext.sysctls |
sysctl settings of the Arbiter pod(s)' | [] |
arbiter.containerSecurityContext.enabled |
Enable Arbiter container(s)' Security Context | true |
arbiter.containerSecurityContext.runAsUser |
User ID for the Arbiter container | 1001 |
arbiter.containerSecurityContext.runAsGroup |
Group ID for the Arbiter container | 0 |
arbiter.containerSecurityContext.runAsNonRoot |
Set Arbiter containers' Security Context runAsNonRoot | true |
arbiter.containerSecurityContext.allowPrivilegeEscalation |
Is it possible to escalate Arbiter pod(s) privileges | false |
arbiter.containerSecurityContext.seccompProfile.type |
Set Arbiter container's Security Context seccompProfile type | RuntimeDefault |
arbiter.containerSecurityContext.capabilities.drop |
Set Arbiter container's Security Context capabilities to drop | ["ALL"] |
arbiter.resources.limits |
The resources limits for Arbiter containers | {} |
arbiter.resources.requests |
The requested resources for Arbiter containers | {} |
arbiter.containerPorts.mongodb |
MongoDB(®) arbiter container port | 27017 |
arbiter.livenessProbe.enabled |
Enable livenessProbe | true |
arbiter.livenessProbe.initialDelaySeconds |
Initial delay seconds for livenessProbe | 30 |
arbiter.livenessProbe.periodSeconds |
Period seconds for livenessProbe | 20 |
arbiter.livenessProbe.timeoutSeconds |
Timeout seconds for livenessProbe | 10 |
arbiter.livenessProbe.failureThreshold |
Failure threshold for livenessProbe | 6 |
arbiter.livenessProbe.successThreshold |
Success threshold for livenessProbe | 1 |
arbiter.readinessProbe.enabled |
Enable readinessProbe | true |
arbiter.readinessProbe.initialDelaySeconds |
Initial delay seconds for readinessProbe | 5 |
arbiter.readinessProbe.periodSeconds |
Period seconds for readinessProbe | 20 |
arbiter.readinessProbe.timeoutSeconds |
Timeout seconds for readinessProbe | 10 |
arbiter.readinessProbe.failureThreshold |
Failure threshold for readinessProbe | 6 |
arbiter.readinessProbe.successThreshold |
Success threshold for readinessProbe | 1 |
arbiter.startupProbe.enabled |
Enable startupProbe | false |
arbiter.startupProbe.initialDelaySeconds |
Initial delay seconds for startupProbe | 5 |
arbiter.startupProbe.periodSeconds |
Period seconds for startupProbe | 10 |
arbiter.startupProbe.timeoutSeconds |
Timeout seconds for startupProbe | 5 |
arbiter.startupProbe.failureThreshold |
Failure threshold for startupProbe | 30 |
arbiter.startupProbe.successThreshold |
Success threshold for startupProbe | 1 |
arbiter.customLivenessProbe |
Override default liveness probe for Arbiter containers | {} |
arbiter.customReadinessProbe |
Override default readiness probe for Arbiter containers | {} |
arbiter.customStartupProbe |
Override default startup probe for Arbiter containers | {} |
arbiter.initContainers |
Add additional init containers for the Arbiter pod(s) | [] |
arbiter.sidecars |
Add additional sidecar containers for the Arbiter pod(s) | [] |
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.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 | "" |
arbiter.service.nameOverride |
The arbiter service name | "" |
arbiter.service.ports.mongodb |
MongoDB(®) service port | 27017 |
arbiter.service.extraPorts |
Extra ports to expose (normally used with the sidecar value) |
[] |
arbiter.service.annotations |
Provide any additional annotations that may be required | {} |
arbiter.service.headless.annotations |
Annotations for the headless service. | {} |
Hidden Node parameters
| Name | Description | Value |
|---|---|---|
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 | "" |
hidden.command |
Override default container command (useful when using custom images) | [] |
hidden.args |
Override default container args (useful when using custom images) | [] |
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 | "" |
hidden.extraEnvVarsSecret |
Name of existing Secret containing extra env vars (in case of sensitive data) | "" |
hidden.annotations |
Additional labels to be added to thehidden node statefulset | {} |
hidden.labels |
Annotations to be added to the hidden node statefulset | {} |
hidden.topologySpreadConstraints |
MongoDB(®) Spread Constraints for hidden Pods | [] |
hidden.lifecycleHooks |
LifecycleHook for the Hidden container to automate configuration before or after startup | {} |
hidden.replicaCount |
Number of hidden nodes (only when architecture=replicaset) |
1 |
hidden.terminationGracePeriodSeconds |
Hidden Termination Grace Period | "" |
hidden.updateStrategy.type |
Strategy that will be employed to update Pods in the StatefulSet | RollingUpdate |
hidden.podManagementPolicy |
Pod management policy for hidden node | OrderedReady |
hidden.schedulerName |
Name of the scheduler (other than default) to dispatch pods | "" |
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 | {} |
hidden.nodeSelector |
Hidden node Node labels for pod assignment | {} |
hidden.tolerations |
Hidden node Tolerations for pod assignment | [] |
hidden.podLabels |
Hidden node pod labels | {} |
hidden.podAnnotations |
Hidden node Pod annotations | {} |
hidden.priorityClassName |
Name of the existing priority class to be used by hidden node pod(s) | "" |
hidden.runtimeClassName |
Name of the runtime class to be used by hidden node pod(s) | "" |
hidden.podSecurityContext.enabled |
Enable Hidden pod(s)' Security Context | true |
hidden.podSecurityContext.fsGroup |
Group ID for the volumes of the Hidden pod(s) | 1001 |
hidden.podSecurityContext.sysctls |
sysctl settings of the Hidden pod(s)' | [] |
hidden.containerSecurityContext.enabled |
Enable Hidden container(s)' Security Context | true |
hidden.containerSecurityContext.runAsUser |
User ID for the Hidden container | 1001 |
hidden.containerSecurityContext.runAsGroup |
Group ID for the Hidden container | 0 |
hidden.containerSecurityContext.runAsNonRoot |
Set Hidden containers' Security Context runAsNonRoot | true |
hidden.containerSecurityContext.allowPrivilegeEscalation |
Set Hidden containers' Security Context allowPrivilegeEscalation | false |
hidden.containerSecurityContext.seccompProfile.type |
Set Hidden container's Security Context seccompProfile type | RuntimeDefault |
hidden.containerSecurityContext.capabilities.drop |
Set Hidden container's Security Context capabilities to drop | ["ALL"] |
hidden.resources.limits |
The resources limits for hidden node containers | {} |
hidden.resources.requests |
The requested resources for hidden node containers | {} |
hidden.containerPorts.mongodb |
MongoDB(®) hidden container port | 27017 |
hidden.livenessProbe.enabled |
Enable livenessProbe | true |
hidden.livenessProbe.initialDelaySeconds |
Initial delay seconds for livenessProbe | 30 |
hidden.livenessProbe.periodSeconds |
Period seconds for livenessProbe | 20 |
hidden.livenessProbe.timeoutSeconds |
Timeout seconds for livenessProbe | 10 |
hidden.livenessProbe.failureThreshold |
Failure threshold for livenessProbe | 6 |
hidden.livenessProbe.successThreshold |
Success threshold for livenessProbe | 1 |
hidden.readinessProbe.enabled |
Enable readinessProbe | true |
hidden.readinessProbe.initialDelaySeconds |
Initial delay seconds for readinessProbe | 5 |
hidden.readinessProbe.periodSeconds |
Period seconds for readinessProbe | 20 |
hidden.readinessProbe.timeoutSeconds |
Timeout seconds for readinessProbe | 10 |
hidden.readinessProbe.failureThreshold |
Failure threshold for readinessProbe | 6 |
hidden.readinessProbe.successThreshold |
Success threshold for readinessProbe | 1 |
hidden.startupProbe.enabled |
Enable startupProbe | false |
hidden.startupProbe.initialDelaySeconds |
Initial delay seconds for startupProbe | 5 |
hidden.startupProbe.periodSeconds |
Period seconds for startupProbe | 10 |
hidden.startupProbe.timeoutSeconds |
Timeout seconds for startupProbe | 5 |
hidden.startupProbe.failureThreshold |
Failure threshold for startupProbe | 30 |
hidden.startupProbe.successThreshold |
Success threshold for startupProbe | 1 |
hidden.customLivenessProbe |
Override default liveness probe for hidden node containers | {} |
hidden.customReadinessProbe |
Override default readiness probe for hidden node containers | {} |
hidden.customStartupProbe |
Override default startup probe for MongoDB(®) containers | {} |
hidden.initContainers |
Add init containers to the MongoDB(®) Hidden pods. | [] |
hidden.sidecars |
Add additional sidecar containers for the hidden node pod(s) | [] |
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.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 | "" |
hidden.persistence.enabled |
Enable hidden node data persistence using PVC | true |
hidden.persistence.medium |
Provide a medium for emptyDir volumes. |
"" |
hidden.persistence.storageClass |
PVC Storage Class for hidden node data volume | "" |
hidden.persistence.accessModes |
PV Access Mode | ["ReadWriteOnce"] |
hidden.persistence.size |
PVC Storage Request for hidden node data volume | 8Gi |
hidden.persistence.annotations |
PVC annotations | {} |
hidden.persistence.mountPath |
The path the volume will be mounted at, useful when using different MongoDB(®) images. | /bitnami/mongodb |
hidden.persistence.subPath |
The subdirectory of the volume to mount to, useful in dev environments | "" |
hidden.persistence.volumeClaimTemplates.selector |
A label query over volumes to consider for binding (e.g. when using local volumes) | {} |
hidden.persistence.volumeClaimTemplates.requests |
Custom PVC requests attributes | {} |
hidden.persistence.volumeClaimTemplates.dataSource |
Set volumeClaimTemplate dataSource | {} |
hidden.service.portName |
MongoDB(®) service port name | mongodb |
hidden.service.ports.mongodb |
MongoDB(®) service port | 27017 |
hidden.service.extraPorts |
Extra ports to expose (normally used with the sidecar value) |
[] |
hidden.service.annotations |
Provide any additional annotations that may be required | {} |
hidden.service.headless.annotations |
Annotations for the headless service. | {} |
Metrics parameters
| Name | Description | Value |
|---|---|---|
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 repository | bitnami/mongodb-exporter |
metrics.image.tag |
MongoDB(®) Prometheus exporter image tag (immutable tags are recommended) |
|
metrics.image.digest |
MongoDB(®) image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
metrics.image.pullPolicy |
MongoDB(®) Prometheus exporter image pull policy | IfNotPresent |
metrics.image.pullSecrets |
Specify docker-registry secret names as an array | [] |
metrics.username |
String with username for the metrics exporter | "" |
metrics.password |
String with password for the metrics exporter | "" |
metrics.compatibleMode |
Enables old style mongodb-exporter metrics | true |
metrics.collector.all |
Enable all collectors. Same as enabling all individual metrics | false |
metrics.collector.diagnosticdata |
Boolean Enable collecting metrics from getDiagnosticData | true |
metrics.collector.replicasetstatus |
Boolean Enable collecting metrics from replSetGetStatus | true |
metrics.collector.dbstats |
Boolean Enable collecting metrics from dbStats | false |
metrics.collector.topmetrics |
Boolean Enable collecting metrics from top admin command | false |
metrics.collector.indexstats |
Boolean Enable collecting metrics from $indexStats | false |
metrics.collector.collstats |
Boolean Enable collecting metrics from $collStats | false |
metrics.collector.collstatsColls |
List of <databases>.<collections> to get $collStats | [] |
metrics.collector.indexstatsColls |
List - List of <databases>.<collections> to get $indexStats | [] |
metrics.collector.collstatsLimit |
Number - Disable collstats, dbstats, topmetrics and indexstats collector if there are more than <n> collections. 0=No limit | 0 |
metrics.extraFlags |
String with extra flags to the metrics exporter | "" |
metrics.command |
Override default container command (useful when using custom images) | [] |
metrics.args |
Override default container args (useful when using custom images) | [] |
metrics.resources.limits |
The resources limits for Prometheus exporter containers | {} |
metrics.resources.requests |
The requested resources for Prometheus exporter containers | {} |
metrics.containerPort |
Port of the Prometheus metrics container | 9216 |
metrics.service.annotations |
Annotations for Prometheus Exporter pods. Evaluated as a template. | {} |
metrics.service.type |
Type of the Prometheus metrics service | ClusterIP |
metrics.service.ports.metrics |
Port of the Prometheus metrics service | 9216 |
metrics.service.extraPorts |
Extra ports to expose (normally used with the sidecar value) |
[] |
metrics.livenessProbe.enabled |
Enable livenessProbe | true |
metrics.livenessProbe.initialDelaySeconds |
Initial delay seconds for livenessProbe | 15 |
metrics.livenessProbe.periodSeconds |
Period seconds for livenessProbe | 5 |
metrics.livenessProbe.timeoutSeconds |
Timeout seconds for livenessProbe | 10 |
metrics.livenessProbe.failureThreshold |
Failure threshold for livenessProbe | 3 |
metrics.livenessProbe.successThreshold |
Success threshold for livenessProbe | 1 |
metrics.readinessProbe.enabled |
Enable readinessProbe | true |
metrics.readinessProbe.initialDelaySeconds |
Initial delay seconds for readinessProbe | 5 |
metrics.readinessProbe.periodSeconds |
Period seconds for readinessProbe | 5 |
metrics.readinessProbe.timeoutSeconds |
Timeout seconds for readinessProbe | 10 |
metrics.readinessProbe.failureThreshold |
Failure threshold for readinessProbe | 3 |
metrics.readinessProbe.successThreshold |
Success threshold for readinessProbe | 1 |
metrics.startupProbe.enabled |
Enable startupProbe | false |
metrics.startupProbe.initialDelaySeconds |
Initial delay seconds for startupProbe | 5 |
metrics.startupProbe.periodSeconds |
Period seconds for startupProbe | 10 |
metrics.startupProbe.timeoutSeconds |
Timeout seconds for startupProbe | 5 |
metrics.startupProbe.failureThreshold |
Failure threshold for startupProbe | 30 |
metrics.startupProbe.successThreshold |
Success threshold for startupProbe | 1 |
metrics.customLivenessProbe |
Override default liveness probe for MongoDB(®) containers | {} |
metrics.customReadinessProbe |
Override default readiness probe for MongoDB(®) containers | {} |
metrics.customStartupProbe |
Override default startup probe for MongoDB(®) containers | {} |
metrics.extraVolumeMounts |
Optionally specify extra list of additional volumeMounts for the metrics container(s) | [] |
metrics.serviceMonitor.enabled |
Create ServiceMonitor Resource for scraping metrics using Prometheus Operator | false |
metrics.serviceMonitor.namespace |
Namespace which Prometheus is running in | "" |
metrics.serviceMonitor.interval |
Interval at which metrics should be scraped | 30s |
metrics.serviceMonitor.scrapeTimeout |
Specify the timeout after which the scrape is ended | "" |
metrics.serviceMonitor.relabelings |
RelabelConfigs to apply to samples before scraping. | [] |
metrics.serviceMonitor.metricRelabelings |
MetricsRelabelConfigs to apply to samples before ingestion. | [] |
metrics.serviceMonitor.labels |
Used to pass Labels that are used by the Prometheus installed in your cluster to select Service Monitors to work with | {} |
metrics.serviceMonitor.selector |
Prometheus instance selector labels | {} |
metrics.serviceMonitor.honorLabels |
Specify honorLabels parameter to add the scrape endpoint | false |
metrics.serviceMonitor.jobLabel |
The name of the label on the target service to use as the job name in prometheus. | "" |
metrics.prometheusRule.enabled |
Set this to true to create prometheusRules for Prometheus operator | false |
metrics.prometheusRule.additionalLabels |
Additional labels that can be used so prometheusRules will be discovered by Prometheus | {} |
metrics.prometheusRule.namespace |
Namespace where prometheusRules resource should be created | "" |
metrics.prometheusRule.rules |
Rules to be created, check values for an example | [] |
