MongoDB

Overview

MongoDB is a free and open-source cross-platform document-oriented database program.

Manual

Releases

Community

---

Deployment

sb install mongodb

Usage

MongoDB 6 is deployed in a Docker container with data persisting to /opt/mongo/. Connect from other containers using mongodb://mongo:27017/. Multiple instances are supported via the mongodb_instances variable in your Saltbox inventory.

Note: No authentication is configured by default.

Role Defaults

Use the Inventory to customize variables. (1)

1. This role supports multiple instances via mongodb_instances.

   Example override

   Role-levelInstance-level

   mongodb_role_web_subdomain: "custom"
   

   Applies to all instances of mongodb

   mongodb2_web_subdomain: "custom2"
   

   Applies to the instance named mongodb2

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like mongodb_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like mongodb_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDockerDocker+Global Override Options

mongodb_instances

# Type: list
mongodb_instances: ["mongo"]

Example Override

# Type: list
mongodb_instances: ["mongodb", "mongodb2"]

Container

mongodb_role_docker_containermongodb2_docker_container

# Type: string
mongodb_role_docker_container: "{{ mongodb_name }}"

# Type: string
mongodb2_docker_container: "{{ mongodb_name }}"

Image

mongodb_role_docker_image_pullmongodb2_docker_image_pull

# Type: bool (true/false)
mongodb_role_docker_image_pull: true

# Type: bool (true/false)
mongodb2_docker_image_pull: true

mongodb_role_docker_image_repomongodb2_docker_image_repo

# Type: string
mongodb_role_docker_image_repo: "mongo"

# Type: string
mongodb2_docker_image_repo: "mongo"

mongodb_role_docker_image_tagmongodb2_docker_image_tag

# Type: string
mongodb_role_docker_image_tag: "6"

# Type: string
mongodb2_docker_image_tag: "6"

mongodb_role_docker_imagemongodb2_docker_image

# Type: string
mongodb_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='mongodb') }}:{{ lookup('role_var', '_docker_image_tag', role='mongodb') }}"

# Type: string
mongodb2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='mongodb') }}:{{ lookup('role_var', '_docker_image_tag', role='mongodb') }}"

Envs

mongodb_role_docker_envs_defaultmongodb2_docker_envs_default

# Type: dict
mongodb_role_docker_envs_default:
  MONGO_DATA_DIR: "/data/db"
  MONGO_LOG_DIR: "/dev/null"
  MONGO_URL: "mongodb://{{ mongodb_name }}:27017/"

# Type: dict
mongodb2_docker_envs_default:
  MONGO_DATA_DIR: "/data/db"
  MONGO_LOG_DIR: "/dev/null"
  MONGO_URL: "mongodb://{{ mongodb_name }}:27017/"

mongodb_role_docker_envs_custommongodb2_docker_envs_custom

# Type: dict
mongodb_role_docker_envs_custom: {}

# Type: dict
mongodb2_docker_envs_custom: {}

Volumes

mongodb_role_docker_volumes_defaultmongodb2_docker_volumes_default

# Type: list
mongodb_role_docker_volumes_default:
  - "{{ mongodb_role_paths_location }}:/data/db:rw"
  - "{{ mongodb_role_paths_location }}/config:/data/configdb"

# Type: list
mongodb2_docker_volumes_default:
  - "{{ mongodb_role_paths_location }}:/data/db:rw"
  - "{{ mongodb_role_paths_location }}/config:/data/configdb"

mongodb_role_docker_volumes_custommongodb2_docker_volumes_custom

# Type: list
mongodb_role_docker_volumes_custom: []

# Type: list
mongodb2_docker_volumes_custom: []

Hostname

mongodb_role_docker_hostnamemongodb2_docker_hostname

# Type: string
mongodb_role_docker_hostname: "{{ mongodb_name }}"

# Type: string
mongodb2_docker_hostname: "{{ mongodb_name }}"

Networks

mongodb_role_docker_networks_aliasmongodb2_docker_networks_alias

# Type: string
mongodb_role_docker_networks_alias: "{{ mongodb_name }}"

# Type: string
mongodb2_docker_networks_alias: "{{ mongodb_name }}"

mongodb_role_docker_networks_defaultmongodb2_docker_networks_default

# Type: list
mongodb_role_docker_networks_default: []

# Type: list
mongodb2_docker_networks_default: []

mongodb_role_docker_networks_custommongodb2_docker_networks_custom

# Type: list
mongodb_role_docker_networks_custom: []

# Type: list
mongodb2_docker_networks_custom: []

Restart Policy

mongodb_role_docker_restart_policymongodb2_docker_restart_policy

# Type: string
mongodb_role_docker_restart_policy: unless-stopped

# Type: string
mongodb2_docker_restart_policy: unless-stopped

State

mongodb_role_docker_statemongodb2_docker_state

# Type: string
mongodb_role_docker_state: started

# Type: string
mongodb2_docker_state: started

User

mongodb_role_docker_usermongodb2_docker_user

# Type: string
mongodb_role_docker_user: "{{ uid }}:{{ gid }}"

# Type: string
mongodb2_docker_user: "{{ uid }}:{{ gid }}"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

mongodb_role_docker_blkio_weightmongodb2_docker_blkio_weight

# Type: int
mongodb_role_docker_blkio_weight:

# Type: int
mongodb2_docker_blkio_weight:

mongodb_role_docker_cpu_periodmongodb2_docker_cpu_period

# Type: int
mongodb_role_docker_cpu_period:

# Type: int
mongodb2_docker_cpu_period:

mongodb_role_docker_cpu_quotamongodb2_docker_cpu_quota

# Type: int
mongodb_role_docker_cpu_quota:

# Type: int
mongodb2_docker_cpu_quota:

mongodb_role_docker_cpu_sharesmongodb2_docker_cpu_shares

# Type: int
mongodb_role_docker_cpu_shares:

# Type: int
mongodb2_docker_cpu_shares:

mongodb_role_docker_cpusmongodb2_docker_cpus

# Type: string
mongodb_role_docker_cpus:

# Type: string
mongodb2_docker_cpus:

mongodb_role_docker_cpuset_cpusmongodb2_docker_cpuset_cpus

# Type: string
mongodb_role_docker_cpuset_cpus:

# Type: string
mongodb2_docker_cpuset_cpus:

mongodb_role_docker_cpuset_memsmongodb2_docker_cpuset_mems

# Type: string
mongodb_role_docker_cpuset_mems:

# Type: string
mongodb2_docker_cpuset_mems:

mongodb_role_docker_kernel_memorymongodb2_docker_kernel_memory

# Type: string
mongodb_role_docker_kernel_memory:

# Type: string
mongodb2_docker_kernel_memory:

mongodb_role_docker_memorymongodb2_docker_memory

# Type: string
mongodb_role_docker_memory:

# Type: string
mongodb2_docker_memory:

mongodb_role_docker_memory_reservationmongodb2_docker_memory_reservation

# Type: string
mongodb_role_docker_memory_reservation:

# Type: string
mongodb2_docker_memory_reservation:

mongodb_role_docker_memory_swapmongodb2_docker_memory_swap

# Type: string
mongodb_role_docker_memory_swap:

# Type: string
mongodb2_docker_memory_swap:

mongodb_role_docker_memory_swappinessmongodb2_docker_memory_swappiness

# Type: int
mongodb_role_docker_memory_swappiness:

# Type: int
mongodb2_docker_memory_swappiness:

mongodb_role_docker_shm_sizemongodb2_docker_shm_size

# Type: string
mongodb_role_docker_shm_size:

# Type: string
mongodb2_docker_shm_size:

Security & Devices

mongodb_role_docker_cap_dropmongodb2_docker_cap_drop

# Type: list
mongodb_role_docker_cap_drop:

# Type: list
mongodb2_docker_cap_drop:

mongodb_role_docker_cgroupns_modemongodb2_docker_cgroupns_mode

# Type: string
mongodb_role_docker_cgroupns_mode:

# Type: string
mongodb2_docker_cgroupns_mode:

mongodb_role_docker_device_cgroup_rulesmongodb2_docker_device_cgroup_rules

# Type: list
mongodb_role_docker_device_cgroup_rules:

# Type: list
mongodb2_docker_device_cgroup_rules:

mongodb_role_docker_device_read_bpsmongodb2_docker_device_read_bps

# Type: list
mongodb_role_docker_device_read_bps:

# Type: list
mongodb2_docker_device_read_bps:

mongodb_role_docker_device_read_iopsmongodb2_docker_device_read_iops

# Type: list
mongodb_role_docker_device_read_iops:

# Type: list
mongodb2_docker_device_read_iops:

mongodb_role_docker_device_requestsmongodb2_docker_device_requests

# Type: list
mongodb_role_docker_device_requests:

# Type: list
mongodb2_docker_device_requests:

mongodb_role_docker_device_write_bpsmongodb2_docker_device_write_bps

# Type: list
mongodb_role_docker_device_write_bps:

# Type: list
mongodb2_docker_device_write_bps:

mongodb_role_docker_device_write_iopsmongodb2_docker_device_write_iops

# Type: list
mongodb_role_docker_device_write_iops:

# Type: list
mongodb2_docker_device_write_iops:

mongodb_role_docker_devicesmongodb2_docker_devices

# Type: list
mongodb_role_docker_devices:

# Type: list
mongodb2_docker_devices:

mongodb_role_docker_devices_defaultmongodb2_docker_devices_default

# Type: string
mongodb_role_docker_devices_default:

# Type: string
mongodb2_docker_devices_default:

mongodb_role_docker_groupsmongodb2_docker_groups

# Type: list
mongodb_role_docker_groups:

# Type: list
mongodb2_docker_groups:

mongodb_role_docker_privilegedmongodb2_docker_privileged

# Type: bool (true/false)
mongodb_role_docker_privileged:

# Type: bool (true/false)
mongodb2_docker_privileged:

mongodb_role_docker_security_optsmongodb2_docker_security_opts

# Type: list
mongodb_role_docker_security_opts:

# Type: list
mongodb2_docker_security_opts:

mongodb_role_docker_userns_modemongodb2_docker_userns_mode

# Type: string
mongodb_role_docker_userns_mode:

# Type: string
mongodb2_docker_userns_mode:

Networking

mongodb_role_docker_dns_optsmongodb2_docker_dns_opts

# Type: list
mongodb_role_docker_dns_opts:

# Type: list
mongodb2_docker_dns_opts:

mongodb_role_docker_dns_search_domainsmongodb2_docker_dns_search_domains

# Type: list
mongodb_role_docker_dns_search_domains:

# Type: list
mongodb2_docker_dns_search_domains:

mongodb_role_docker_dns_serversmongodb2_docker_dns_servers

# Type: list
mongodb_role_docker_dns_servers:

# Type: list
mongodb2_docker_dns_servers:

mongodb_role_docker_domainnamemongodb2_docker_domainname

# Type: string
mongodb_role_docker_domainname:

# Type: string
mongodb2_docker_domainname:

mongodb_role_docker_exposed_portsmongodb2_docker_exposed_ports

# Type: list
mongodb_role_docker_exposed_ports:

# Type: list
mongodb2_docker_exposed_ports:

mongodb_role_docker_hostsmongodb2_docker_hosts

# Type: dict
mongodb_role_docker_hosts:

# Type: dict
mongodb2_docker_hosts:

mongodb_role_docker_hosts_use_commonmongodb2_docker_hosts_use_common

# Type: bool (true/false)
mongodb_role_docker_hosts_use_common:

# Type: bool (true/false)
mongodb2_docker_hosts_use_common:

mongodb_role_docker_ipc_modemongodb2_docker_ipc_mode

# Type: string
mongodb_role_docker_ipc_mode:

# Type: string
mongodb2_docker_ipc_mode:

mongodb_role_docker_linksmongodb2_docker_links

# Type: list
mongodb_role_docker_links:

# Type: list
mongodb2_docker_links:

mongodb_role_docker_network_modemongodb2_docker_network_mode

# Type: string
mongodb_role_docker_network_mode:

# Type: string
mongodb2_docker_network_mode:

mongodb_role_docker_pid_modemongodb2_docker_pid_mode

# Type: string
mongodb_role_docker_pid_mode:

# Type: string
mongodb2_docker_pid_mode:

mongodb_role_docker_portsmongodb2_docker_ports

# Type: list
mongodb_role_docker_ports:

# Type: list
mongodb2_docker_ports:

mongodb_role_docker_utsmongodb2_docker_uts

# Type: string
mongodb_role_docker_uts:

# Type: string
mongodb2_docker_uts:

Storage

mongodb_role_docker_keep_volumesmongodb2_docker_keep_volumes

# Type: bool (true/false)
mongodb_role_docker_keep_volumes:

# Type: bool (true/false)
mongodb2_docker_keep_volumes:

mongodb_role_docker_mountsmongodb2_docker_mounts

# Type: list
mongodb_role_docker_mounts:

# Type: list
mongodb2_docker_mounts:

mongodb_role_docker_storage_optsmongodb2_docker_storage_opts

# Type: dict
mongodb_role_docker_storage_opts:

# Type: dict
mongodb2_docker_storage_opts:

mongodb_role_docker_tmpfsmongodb2_docker_tmpfs

# Type: list
mongodb_role_docker_tmpfs:

# Type: list
mongodb2_docker_tmpfs:

mongodb_role_docker_volume_drivermongodb2_docker_volume_driver

# Type: string
mongodb_role_docker_volume_driver:

# Type: string
mongodb2_docker_volume_driver:

mongodb_role_docker_volumes_frommongodb2_docker_volumes_from

# Type: list
mongodb_role_docker_volumes_from:

# Type: list
mongodb2_docker_volumes_from:

mongodb_role_docker_volumes_globalmongodb2_docker_volumes_global

# Type: bool (true/false)
mongodb_role_docker_volumes_global:

# Type: bool (true/false)
mongodb2_docker_volumes_global:

mongodb_role_docker_working_dirmongodb2_docker_working_dir

# Type: string
mongodb_role_docker_working_dir:

# Type: string
mongodb2_docker_working_dir:

Monitoring & Lifecycle

mongodb_role_docker_auto_removemongodb2_docker_auto_remove

# Type: bool (true/false)
mongodb_role_docker_auto_remove:

# Type: bool (true/false)
mongodb2_docker_auto_remove:

mongodb_role_docker_cleanupmongodb2_docker_cleanup

# Type: bool (true/false)
mongodb_role_docker_cleanup:

# Type: bool (true/false)
mongodb2_docker_cleanup:

mongodb_role_docker_force_killmongodb2_docker_force_kill

# Type: string
mongodb_role_docker_force_kill:

# Type: string
mongodb2_docker_force_kill:

mongodb_role_docker_healthcheckmongodb2_docker_healthcheck

# Type: dict
mongodb_role_docker_healthcheck:

# Type: dict
mongodb2_docker_healthcheck:

mongodb_role_docker_healthy_wait_timeoutmongodb2_docker_healthy_wait_timeout

# Type: int
mongodb_role_docker_healthy_wait_timeout:

# Type: int
mongodb2_docker_healthy_wait_timeout:

mongodb_role_docker_initmongodb2_docker_init

# Type: bool (true/false)
mongodb_role_docker_init:

# Type: bool (true/false)
mongodb2_docker_init:

mongodb_role_docker_kill_signalmongodb2_docker_kill_signal

# Type: string
mongodb_role_docker_kill_signal:

# Type: string
mongodb2_docker_kill_signal:

mongodb_role_docker_log_drivermongodb2_docker_log_driver

# Type: string
mongodb_role_docker_log_driver:

# Type: string
mongodb2_docker_log_driver:

mongodb_role_docker_log_optionsmongodb2_docker_log_options

# Type: dict
mongodb_role_docker_log_options:

# Type: dict
mongodb2_docker_log_options:

mongodb_role_docker_oom_killermongodb2_docker_oom_killer

# Type: bool (true/false)
mongodb_role_docker_oom_killer:

# Type: bool (true/false)
mongodb2_docker_oom_killer:

mongodb_role_docker_oom_score_adjmongodb2_docker_oom_score_adj

# Type: int
mongodb_role_docker_oom_score_adj:

# Type: int
mongodb2_docker_oom_score_adj:

mongodb_role_docker_output_logsmongodb2_docker_output_logs

# Type: bool (true/false)
mongodb_role_docker_output_logs:

# Type: bool (true/false)
mongodb2_docker_output_logs:

mongodb_role_docker_pausedmongodb2_docker_paused

# Type: bool (true/false)
mongodb_role_docker_paused:

# Type: bool (true/false)
mongodb2_docker_paused:

mongodb_role_docker_recreatemongodb2_docker_recreate

# Type: bool (true/false)
mongodb_role_docker_recreate:

# Type: bool (true/false)
mongodb2_docker_recreate:

mongodb_role_docker_restart_retriesmongodb2_docker_restart_retries

# Type: int
mongodb_role_docker_restart_retries:

# Type: int
mongodb2_docker_restart_retries:

mongodb_role_docker_stop_timeoutmongodb2_docker_stop_timeout

# Type: int
mongodb_role_docker_stop_timeout:

# Type: int
mongodb2_docker_stop_timeout:

Other Options

mongodb_role_docker_capabilitiesmongodb2_docker_capabilities

# Type: list
mongodb_role_docker_capabilities:

# Type: list
mongodb2_docker_capabilities:

mongodb_role_docker_cgroup_parentmongodb2_docker_cgroup_parent

# Type: string
mongodb_role_docker_cgroup_parent:

# Type: string
mongodb2_docker_cgroup_parent:

mongodb_role_docker_commandsmongodb2_docker_commands

# Type: list
mongodb_role_docker_commands:

# Type: list
mongodb2_docker_commands:

mongodb_role_docker_create_timeoutmongodb2_docker_create_timeout

# Type: int
mongodb_role_docker_create_timeout:

# Type: int
mongodb2_docker_create_timeout:

mongodb_role_docker_entrypointmongodb2_docker_entrypoint

# Type: string
mongodb_role_docker_entrypoint:

# Type: string
mongodb2_docker_entrypoint:

mongodb_role_docker_env_filemongodb2_docker_env_file

# Type: string
mongodb_role_docker_env_file:

# Type: string
mongodb2_docker_env_file:

mongodb_role_docker_labelsmongodb2_docker_labels

# Type: dict
mongodb_role_docker_labels:

# Type: dict
mongodb2_docker_labels:

mongodb_role_docker_labels_use_commonmongodb2_docker_labels_use_common

# Type: bool (true/false)
mongodb_role_docker_labels_use_common:

# Type: bool (true/false)
mongodb2_docker_labels_use_common:

mongodb_role_docker_read_onlymongodb2_docker_read_only

# Type: bool (true/false)
mongodb_role_docker_read_only:

# Type: bool (true/false)
mongodb2_docker_read_only:

mongodb_role_docker_runtimemongodb2_docker_runtime

# Type: string
mongodb_role_docker_runtime:

# Type: string
mongodb2_docker_runtime:

mongodb_role_docker_sysctlsmongodb2_docker_sysctls

# Type: list
mongodb_role_docker_sysctls:

# Type: list
mongodb2_docker_sysctls:

mongodb_role_docker_ulimitsmongodb2_docker_ulimits

# Type: list
mongodb_role_docker_ulimits:

# Type: list
mongodb2_docker_ulimits:

mongodb_role_autoheal_enabledmongodb2_autoheal_enabled

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
mongodb_role_autoheal_enabled: true

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
mongodb2_autoheal_enabled: true

mongodb_role_depends_onmongodb2_depends_on

# List of container dependencies that must be running before containers start
# Type: string
mongodb_role_depends_on: ""

# List of container dependencies that must be running before containers start
# Type: string
mongodb2_depends_on: ""

mongodb_role_depends_on_delaymongodb2_depends_on_delay

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
mongodb_role_depends_on_delay: "0"

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
mongodb2_depends_on_delay: "0"

mongodb_role_depends_on_healthchecksmongodb2_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
mongodb_role_depends_on_healthchecks:

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
mongodb2_depends_on_healthchecks:

mongodb_role_diun_enabledmongodb2_diun_enabled

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
mongodb_role_diun_enabled: true

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
mongodb2_diun_enabled: true

mongodb_role_docker_controllermongodb2_docker_controller

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
mongodb_role_docker_controller: true

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
mongodb2_docker_controller: true

mongodb_role_docker_image_repomongodb2_docker_image_repo

# Type: string
mongodb_role_docker_image_repo:

# Type: string
mongodb2_docker_image_repo:

mongodb_role_docker_image_tagmongodb2_docker_image_tag

# Type: string
mongodb_role_docker_image_tag:

# Type: string
mongodb2_docker_image_tag:

mongodb_role_docker_volumes_downloadmongodb2_docker_volumes_download

# Type: bool (true/false)
mongodb_role_docker_volumes_download:

# Type: bool (true/false)
mongodb2_docker_volumes_download: