MariaDB Server¶
Overview¶
MariaDB Server is a community-developed, open-source relational database management system (RDBMS) that serves as a drop-in replacement for MySQL.
Migration Notes
Saltbox recently swapped Docker images used for MariaDB. The migration path that is run for a default mariadb instance is roughly as follows:
- Dump all data to a dump.sql file
- Move
/opt/mariadbto/opt/mariadb_legacy - Provision a new
mariadbcontainer - Import the dump.sql file
The dump file remains on disk at /opt/mariadb_legacy/dump.sql post-migration in the event manual intervention is required and the appdata for the legacy image remains on disk at /opt/mariadb_legacy.
Deployment¶
sb install mariadb
Usage¶
The default password for this container is password321.
To easily manage the db, consider adminer
Role Defaults¶
Use the Inventory to customize variables. (1)
-
This role supports multiple instances via
mariadb_instances.Example override
mariadb_role_web_subdomain: "custom"Applies to all instances of mariadb
mariadb2_web_subdomain: "custom2"Applies to the instance named mariadb2
Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likemariadb_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
_customvariable (likemariadb_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
mariadb_instances
# Type: list
mariadb_instances: ["mariadb"]
Example Override
# Type: list
mariadb_instances: ["mariadb", "mariadb2"]
mariadb_role_docker_env_passwordmariadb2_docker_env_password
# Type: string
mariadb_role_docker_env_password: "password321"
# Type: string
mariadb2_docker_env_password: "password321"
mariadb_role_docker_env_usermariadb2_docker_env_user
# Type: string
mariadb_role_docker_env_user: "{{ user.name }}"
# Type: string
mariadb2_docker_env_user: "{{ user.name }}"
mariadb_role_docker_env_dbmariadb2_docker_env_db
# Type: string
mariadb_role_docker_env_db: "saltbox"
# Type: string
mariadb2_docker_env_db: "saltbox"
mariadb_role_docker_envs_mysql_root_passwordmariadb2_docker_envs_mysql_root_password
# Type: string
mariadb_role_docker_envs_mysql_root_password: password321
# Type: string
mariadb2_docker_envs_mysql_root_password: password321
mariadb_role_docker_image_migrationmariadb2_docker_image_migration
# Type: string
mariadb_role_docker_image_migration: "lscr.io/linuxserver/mariadb:10.6.13"
# Type: string
mariadb2_docker_image_migration: "lscr.io/linuxserver/mariadb:10.6.13"
mariadb_role_docker_volumes_migrationmariadb2_docker_volumes_migration
# Type: list
mariadb_role_docker_volumes_migration:
- "{{ mariadb_role_paths_location }}:/config"
# Type: list
mariadb2_docker_volumes_migration:
- "{{ mariadb_role_paths_location }}:/config"
Container
mariadb_role_docker_containermariadb2_docker_container
# Type: string
mariadb_role_docker_container: "{{ mariadb_name }}"
# Type: string
mariadb2_docker_container: "{{ mariadb_name }}"
Image
mariadb_role_docker_image_pullmariadb2_docker_image_pull
# Type: bool (true/false)
mariadb_role_docker_image_pull: true
# Type: bool (true/false)
mariadb2_docker_image_pull: true
mariadb_role_docker_image_repomariadb2_docker_image_repo
# Type: string
mariadb_role_docker_image_repo: "mariadb"
# Type: string
mariadb2_docker_image_repo: "mariadb"
mariadb_role_docker_image_tagmariadb2_docker_image_tag
# Type: string
mariadb_role_docker_image_tag: "10"
# Type: string
mariadb2_docker_image_tag: "10"
mariadb_role_docker_imagemariadb2_docker_image
# Type: string
mariadb_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='mariadb') }}:{{ lookup('role_var', '_docker_image_tag', role='mariadb') }}"
# Type: string
mariadb2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='mariadb') }}:{{ lookup('role_var', '_docker_image_tag', role='mariadb') }}"
Envs
mariadb_role_docker_envs_defaultmariadb2_docker_envs_default
# Type: dict
mariadb_role_docker_envs_default:
TZ: "{{ tz }}"
MARIADB_ROOT_PASSWORD: "{{ lookup('role_var', '_docker_env_password', role='mariadb') }}"
MARIADB_USER: "{{ lookup('role_var', '_docker_env_user', role='mariadb') }}"
MARIADB_PASSWORD: "{{ lookup('role_var', '_docker_env_password', role='mariadb') }}"
MARIADB_DATABASE: "{{ lookup('role_var', '_docker_env_db', role='mariadb') }}"
MARIADB_AUTO_UPGRADE: "1"
# Type: dict
mariadb2_docker_envs_default:
TZ: "{{ tz }}"
MARIADB_ROOT_PASSWORD: "{{ lookup('role_var', '_docker_env_password', role='mariadb') }}"
MARIADB_USER: "{{ lookup('role_var', '_docker_env_user', role='mariadb') }}"
MARIADB_PASSWORD: "{{ lookup('role_var', '_docker_env_password', role='mariadb') }}"
MARIADB_DATABASE: "{{ lookup('role_var', '_docker_env_db', role='mariadb') }}"
MARIADB_AUTO_UPGRADE: "1"
mariadb_role_docker_envs_custommariadb2_docker_envs_custom
# Type: dict
mariadb_role_docker_envs_custom: {}
# Type: dict
mariadb2_docker_envs_custom: {}
Volumes
mariadb_role_docker_volumes_defaultmariadb2_docker_volumes_default
# Type: list
mariadb_role_docker_volumes_default:
- "{{ mariadb_role_paths_location }}:/var/lib/mysql"
# Type: list
mariadb2_docker_volumes_default:
- "{{ mariadb_role_paths_location }}:/var/lib/mysql"
mariadb_role_docker_volumes_custommariadb2_docker_volumes_custom
# Type: list
mariadb_role_docker_volumes_custom: []
# Type: list
mariadb2_docker_volumes_custom: []
Hostname
mariadb_role_docker_hostnamemariadb2_docker_hostname
# Type: string
mariadb_role_docker_hostname: "{{ mariadb_name }}"
# Type: string
mariadb2_docker_hostname: "{{ mariadb_name }}"
Networks
mariadb_role_docker_networks_aliasmariadb2_docker_networks_alias
# Type: string
mariadb_role_docker_networks_alias: "{{ mariadb_name }}"
# Type: string
mariadb2_docker_networks_alias: "{{ mariadb_name }}"
mariadb_role_docker_networks_defaultmariadb2_docker_networks_default
# Type: list
mariadb_role_docker_networks_default: []
# Type: list
mariadb2_docker_networks_default: []
mariadb_role_docker_networks_custommariadb2_docker_networks_custom
# Type: list
mariadb_role_docker_networks_custom: []
# Type: list
mariadb2_docker_networks_custom: []
Restart Policy
mariadb_role_docker_restart_policymariadb2_docker_restart_policy
# Type: string
mariadb_role_docker_restart_policy: unless-stopped
# Type: string
mariadb2_docker_restart_policy: unless-stopped
State
mariadb_role_docker_statemariadb2_docker_state
# Type: string
mariadb_role_docker_state: started
# Type: string
mariadb2_docker_state: started
User
mariadb_role_docker_usermariadb2_docker_user
# Type: string
mariadb_role_docker_user: "{{ uid }}:{{ gid }}"
# Type: string
mariadb2_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
mariadb_role_docker_blkio_weightmariadb2_docker_blkio_weight
# Type: int
mariadb_role_docker_blkio_weight:
# Type: int
mariadb2_docker_blkio_weight:
mariadb_role_docker_cpu_periodmariadb2_docker_cpu_period
# Type: int
mariadb_role_docker_cpu_period:
# Type: int
mariadb2_docker_cpu_period:
mariadb_role_docker_cpu_quotamariadb2_docker_cpu_quota
# Type: int
mariadb_role_docker_cpu_quota:
# Type: int
mariadb2_docker_cpu_quota:
mariadb_role_docker_cpu_sharesmariadb2_docker_cpu_shares
# Type: int
mariadb_role_docker_cpu_shares:
# Type: int
mariadb2_docker_cpu_shares:
mariadb_role_docker_cpusmariadb2_docker_cpus
# Type: string
mariadb_role_docker_cpus:
# Type: string
mariadb2_docker_cpus:
mariadb_role_docker_cpuset_cpusmariadb2_docker_cpuset_cpus
# Type: string
mariadb_role_docker_cpuset_cpus:
# Type: string
mariadb2_docker_cpuset_cpus:
mariadb_role_docker_cpuset_memsmariadb2_docker_cpuset_mems
# Type: string
mariadb_role_docker_cpuset_mems:
# Type: string
mariadb2_docker_cpuset_mems:
mariadb_role_docker_kernel_memorymariadb2_docker_kernel_memory
# Type: string
mariadb_role_docker_kernel_memory:
# Type: string
mariadb2_docker_kernel_memory:
mariadb_role_docker_memorymariadb2_docker_memory
# Type: string
mariadb_role_docker_memory:
# Type: string
mariadb2_docker_memory:
mariadb_role_docker_memory_reservationmariadb2_docker_memory_reservation
# Type: string
mariadb_role_docker_memory_reservation:
# Type: string
mariadb2_docker_memory_reservation:
mariadb_role_docker_memory_swapmariadb2_docker_memory_swap
# Type: string
mariadb_role_docker_memory_swap:
# Type: string
mariadb2_docker_memory_swap:
mariadb_role_docker_memory_swappinessmariadb2_docker_memory_swappiness
# Type: int
mariadb_role_docker_memory_swappiness:
# Type: int
mariadb2_docker_memory_swappiness:
mariadb_role_docker_shm_sizemariadb2_docker_shm_size
# Type: string
mariadb_role_docker_shm_size:
# Type: string
mariadb2_docker_shm_size:
Security & Devices
mariadb_role_docker_cap_dropmariadb2_docker_cap_drop
# Type: list
mariadb_role_docker_cap_drop:
# Type: list
mariadb2_docker_cap_drop:
mariadb_role_docker_cgroupns_modemariadb2_docker_cgroupns_mode
# Type: string
mariadb_role_docker_cgroupns_mode:
# Type: string
mariadb2_docker_cgroupns_mode:
mariadb_role_docker_device_cgroup_rulesmariadb2_docker_device_cgroup_rules
# Type: list
mariadb_role_docker_device_cgroup_rules:
# Type: list
mariadb2_docker_device_cgroup_rules:
mariadb_role_docker_device_read_bpsmariadb2_docker_device_read_bps
# Type: list
mariadb_role_docker_device_read_bps:
# Type: list
mariadb2_docker_device_read_bps:
mariadb_role_docker_device_read_iopsmariadb2_docker_device_read_iops
# Type: list
mariadb_role_docker_device_read_iops:
# Type: list
mariadb2_docker_device_read_iops:
mariadb_role_docker_device_requestsmariadb2_docker_device_requests
# Type: list
mariadb_role_docker_device_requests:
# Type: list
mariadb2_docker_device_requests:
mariadb_role_docker_device_write_bpsmariadb2_docker_device_write_bps
# Type: list
mariadb_role_docker_device_write_bps:
# Type: list
mariadb2_docker_device_write_bps:
mariadb_role_docker_device_write_iopsmariadb2_docker_device_write_iops
# Type: list
mariadb_role_docker_device_write_iops:
# Type: list
mariadb2_docker_device_write_iops:
mariadb_role_docker_devicesmariadb2_docker_devices
# Type: list
mariadb_role_docker_devices:
# Type: list
mariadb2_docker_devices:
mariadb_role_docker_devices_defaultmariadb2_docker_devices_default
# Type: string
mariadb_role_docker_devices_default:
# Type: string
mariadb2_docker_devices_default:
mariadb_role_docker_groupsmariadb2_docker_groups
# Type: list
mariadb_role_docker_groups:
# Type: list
mariadb2_docker_groups:
mariadb_role_docker_privilegedmariadb2_docker_privileged
# Type: bool (true/false)
mariadb_role_docker_privileged:
# Type: bool (true/false)
mariadb2_docker_privileged:
mariadb_role_docker_security_optsmariadb2_docker_security_opts
# Type: list
mariadb_role_docker_security_opts:
# Type: list
mariadb2_docker_security_opts:
mariadb_role_docker_userns_modemariadb2_docker_userns_mode
# Type: string
mariadb_role_docker_userns_mode:
# Type: string
mariadb2_docker_userns_mode:
Networking
mariadb_role_docker_dns_optsmariadb2_docker_dns_opts
# Type: list
mariadb_role_docker_dns_opts:
# Type: list
mariadb2_docker_dns_opts:
mariadb_role_docker_dns_search_domainsmariadb2_docker_dns_search_domains
# Type: list
mariadb_role_docker_dns_search_domains:
# Type: list
mariadb2_docker_dns_search_domains:
mariadb_role_docker_dns_serversmariadb2_docker_dns_servers
# Type: list
mariadb_role_docker_dns_servers:
# Type: list
mariadb2_docker_dns_servers:
mariadb_role_docker_domainnamemariadb2_docker_domainname
# Type: string
mariadb_role_docker_domainname:
# Type: string
mariadb2_docker_domainname:
mariadb_role_docker_exposed_portsmariadb2_docker_exposed_ports
# Type: list
mariadb_role_docker_exposed_ports:
# Type: list
mariadb2_docker_exposed_ports:
mariadb_role_docker_hostsmariadb2_docker_hosts
# Type: dict
mariadb_role_docker_hosts:
# Type: dict
mariadb2_docker_hosts:
mariadb_role_docker_hosts_use_commonmariadb2_docker_hosts_use_common
# Type: bool (true/false)
mariadb_role_docker_hosts_use_common:
# Type: bool (true/false)
mariadb2_docker_hosts_use_common:
mariadb_role_docker_ipc_modemariadb2_docker_ipc_mode
# Type: string
mariadb_role_docker_ipc_mode:
# Type: string
mariadb2_docker_ipc_mode:
mariadb_role_docker_linksmariadb2_docker_links
# Type: list
mariadb_role_docker_links:
# Type: list
mariadb2_docker_links:
mariadb_role_docker_network_modemariadb2_docker_network_mode
# Type: string
mariadb_role_docker_network_mode:
# Type: string
mariadb2_docker_network_mode:
mariadb_role_docker_pid_modemariadb2_docker_pid_mode
# Type: string
mariadb_role_docker_pid_mode:
# Type: string
mariadb2_docker_pid_mode:
mariadb_role_docker_portsmariadb2_docker_ports
# Type: list
mariadb_role_docker_ports:
# Type: list
mariadb2_docker_ports:
mariadb_role_docker_utsmariadb2_docker_uts
# Type: string
mariadb_role_docker_uts:
# Type: string
mariadb2_docker_uts:
Storage
mariadb_role_docker_keep_volumesmariadb2_docker_keep_volumes
# Type: bool (true/false)
mariadb_role_docker_keep_volumes:
# Type: bool (true/false)
mariadb2_docker_keep_volumes:
mariadb_role_docker_mountsmariadb2_docker_mounts
# Type: list
mariadb_role_docker_mounts:
# Type: list
mariadb2_docker_mounts:
mariadb_role_docker_storage_optsmariadb2_docker_storage_opts
# Type: dict
mariadb_role_docker_storage_opts:
# Type: dict
mariadb2_docker_storage_opts:
mariadb_role_docker_tmpfsmariadb2_docker_tmpfs
# Type: list
mariadb_role_docker_tmpfs:
# Type: list
mariadb2_docker_tmpfs:
mariadb_role_docker_volume_drivermariadb2_docker_volume_driver
# Type: string
mariadb_role_docker_volume_driver:
# Type: string
mariadb2_docker_volume_driver:
mariadb_role_docker_volumes_frommariadb2_docker_volumes_from
# Type: list
mariadb_role_docker_volumes_from:
# Type: list
mariadb2_docker_volumes_from:
mariadb_role_docker_volumes_globalmariadb2_docker_volumes_global
# Type: bool (true/false)
mariadb_role_docker_volumes_global:
# Type: bool (true/false)
mariadb2_docker_volumes_global:
mariadb_role_docker_working_dirmariadb2_docker_working_dir
# Type: string
mariadb_role_docker_working_dir:
# Type: string
mariadb2_docker_working_dir:
Monitoring & Lifecycle
mariadb_role_docker_auto_removemariadb2_docker_auto_remove
# Type: bool (true/false)
mariadb_role_docker_auto_remove:
# Type: bool (true/false)
mariadb2_docker_auto_remove:
mariadb_role_docker_cleanupmariadb2_docker_cleanup
# Type: bool (true/false)
mariadb_role_docker_cleanup:
# Type: bool (true/false)
mariadb2_docker_cleanup:
mariadb_role_docker_force_killmariadb2_docker_force_kill
# Type: string
mariadb_role_docker_force_kill:
# Type: string
mariadb2_docker_force_kill:
mariadb_role_docker_healthcheckmariadb2_docker_healthcheck
# Type: dict
mariadb_role_docker_healthcheck:
# Type: dict
mariadb2_docker_healthcheck:
mariadb_role_docker_healthy_wait_timeoutmariadb2_docker_healthy_wait_timeout
# Type: int
mariadb_role_docker_healthy_wait_timeout:
# Type: int
mariadb2_docker_healthy_wait_timeout:
mariadb_role_docker_initmariadb2_docker_init
# Type: bool (true/false)
mariadb_role_docker_init:
# Type: bool (true/false)
mariadb2_docker_init:
mariadb_role_docker_kill_signalmariadb2_docker_kill_signal
# Type: string
mariadb_role_docker_kill_signal:
# Type: string
mariadb2_docker_kill_signal:
mariadb_role_docker_log_drivermariadb2_docker_log_driver
# Type: string
mariadb_role_docker_log_driver:
# Type: string
mariadb2_docker_log_driver:
mariadb_role_docker_log_optionsmariadb2_docker_log_options
# Type: dict
mariadb_role_docker_log_options:
# Type: dict
mariadb2_docker_log_options:
mariadb_role_docker_oom_killermariadb2_docker_oom_killer
# Type: bool (true/false)
mariadb_role_docker_oom_killer:
# Type: bool (true/false)
mariadb2_docker_oom_killer:
mariadb_role_docker_oom_score_adjmariadb2_docker_oom_score_adj
# Type: int
mariadb_role_docker_oom_score_adj:
# Type: int
mariadb2_docker_oom_score_adj:
mariadb_role_docker_output_logsmariadb2_docker_output_logs
# Type: bool (true/false)
mariadb_role_docker_output_logs:
# Type: bool (true/false)
mariadb2_docker_output_logs:
mariadb_role_docker_pausedmariadb2_docker_paused
# Type: bool (true/false)
mariadb_role_docker_paused:
# Type: bool (true/false)
mariadb2_docker_paused:
mariadb_role_docker_recreatemariadb2_docker_recreate
# Type: bool (true/false)
mariadb_role_docker_recreate:
# Type: bool (true/false)
mariadb2_docker_recreate:
mariadb_role_docker_restart_retriesmariadb2_docker_restart_retries
# Type: int
mariadb_role_docker_restart_retries:
# Type: int
mariadb2_docker_restart_retries:
mariadb_role_docker_stop_timeoutmariadb2_docker_stop_timeout
# Type: int
mariadb_role_docker_stop_timeout:
# Type: int
mariadb2_docker_stop_timeout:
Other Options
mariadb_role_docker_capabilitiesmariadb2_docker_capabilities
# Type: list
mariadb_role_docker_capabilities:
# Type: list
mariadb2_docker_capabilities:
mariadb_role_docker_cgroup_parentmariadb2_docker_cgroup_parent
# Type: string
mariadb_role_docker_cgroup_parent:
# Type: string
mariadb2_docker_cgroup_parent:
mariadb_role_docker_commandsmariadb2_docker_commands
# Type: list
mariadb_role_docker_commands:
# Type: list
mariadb2_docker_commands:
mariadb_role_docker_create_timeoutmariadb2_docker_create_timeout
# Type: int
mariadb_role_docker_create_timeout:
# Type: int
mariadb2_docker_create_timeout:
mariadb_role_docker_entrypointmariadb2_docker_entrypoint
# Type: string
mariadb_role_docker_entrypoint:
# Type: string
mariadb2_docker_entrypoint:
mariadb_role_docker_env_filemariadb2_docker_env_file
# Type: string
mariadb_role_docker_env_file:
# Type: string
mariadb2_docker_env_file:
mariadb_role_docker_labelsmariadb2_docker_labels
# Type: dict
mariadb_role_docker_labels:
# Type: dict
mariadb2_docker_labels:
mariadb_role_docker_labels_use_commonmariadb2_docker_labels_use_common
# Type: bool (true/false)
mariadb_role_docker_labels_use_common:
# Type: bool (true/false)
mariadb2_docker_labels_use_common:
mariadb_role_docker_read_onlymariadb2_docker_read_only
# Type: bool (true/false)
mariadb_role_docker_read_only:
# Type: bool (true/false)
mariadb2_docker_read_only:
mariadb_role_docker_runtimemariadb2_docker_runtime
# Type: string
mariadb_role_docker_runtime:
# Type: string
mariadb2_docker_runtime:
mariadb_role_docker_sysctlsmariadb2_docker_sysctls
# Type: list
mariadb_role_docker_sysctls:
# Type: list
mariadb2_docker_sysctls:
mariadb_role_docker_ulimitsmariadb2_docker_ulimits
# Type: list
mariadb_role_docker_ulimits:
# Type: list
mariadb2_docker_ulimits:
mariadb_role_autoheal_enabledmariadb2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
mariadb_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
mariadb2_autoheal_enabled: true
mariadb_role_depends_onmariadb2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
mariadb_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
mariadb2_depends_on: ""
mariadb_role_depends_on_delaymariadb2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
mariadb_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
mariadb2_depends_on_delay: "0"
mariadb_role_depends_on_healthchecksmariadb2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
mariadb_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
mariadb2_depends_on_healthchecks:
mariadb_role_diun_enabledmariadb2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
mariadb_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
mariadb2_diun_enabled: true
mariadb_role_docker_controllermariadb2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
mariadb_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
mariadb2_docker_controller: true
mariadb_role_docker_env_dbmariadb2_docker_env_db
# Type: string
mariadb_role_docker_env_db:
# Type: string
mariadb2_docker_env_db:
mariadb_role_docker_env_passwordmariadb2_docker_env_password
# Type: string
mariadb_role_docker_env_password:
# Type: string
mariadb2_docker_env_password:
mariadb_role_docker_env_usermariadb2_docker_env_user
# Type: string
mariadb_role_docker_env_user:
# Type: string
mariadb2_docker_env_user:
mariadb_role_docker_image_repomariadb2_docker_image_repo
# Type: string
mariadb_role_docker_image_repo:
# Type: string
mariadb2_docker_image_repo:
mariadb_role_docker_image_tagmariadb2_docker_image_tag
# Type: string
mariadb_role_docker_image_tag:
# Type: string
mariadb2_docker_image_tag:
mariadb_role_docker_volumes_downloadmariadb2_docker_volumes_download
# Type: bool (true/false)
mariadb_role_docker_volumes_download:
# Type: bool (true/false)
mariadb2_docker_volumes_download: