Docker CE¶

Overview¶

Docker CE is an open-source containerization technology for building and containerizing your applications.

Deployment¶

Saltbox dependency.

sb install docker

Usage¶

docker

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
docker_dns: ["item1", "item2"]
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like docker_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 docker_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

SettingsDocker+

docker_dns

# Format is ["8.8.8.8", "8.8.4.4"]
# Type: list
docker_dns: []

docker_config_custom

# YAML Dictionary that gets combined with the defaults and later converted to json
# Example of how to remove an option:
# docker_config_custom:
# log-opts: "{{ omit }}"
# Example of how to add options:
# docker_config_custom:
# debug: "true"
# Type: dict
docker_config_custom: {}

docker_cpus_default

# CPU and Memory defaults
# Type: string
docker_cpus_default: ""

docker_memory_default

# Type: string
docker_memory_default: ""

docker_skip_start_during_meta_tag

# Skip Container startup during core, saltbox, mediabox or feederbox
# If the kernel has been updated and a reboot will happen
# Type: string
docker_skip_start_during_meta_tag: "{{ saltbox_auto_reboot }}"

docker_create_image_prune

# Toggles pruning of dangling images after container creation.
# Type: bool (true/false)
docker_create_image_prune: true

docker_create_image_prune_delay

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

docker_create_image_prune_delay_timeout

# Type: int
docker_create_image_prune_delay_timeout: 10

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

Resource Limits

docker_role_docker_blkio_weight

# Type: int
docker_role_docker_blkio_weight:

docker_role_docker_cpu_period

# Type: int
docker_role_docker_cpu_period:

docker_role_docker_cpu_quota

# Type: int
docker_role_docker_cpu_quota:

docker_role_docker_cpu_shares

# Type: int
docker_role_docker_cpu_shares:

docker_role_docker_cpus

# Type: string
docker_role_docker_cpus:

docker_role_docker_cpuset_cpus

# Type: string
docker_role_docker_cpuset_cpus:

docker_role_docker_cpuset_mems

# Type: string
docker_role_docker_cpuset_mems:

docker_role_docker_kernel_memory

# Type: string
docker_role_docker_kernel_memory:

docker_role_docker_memory

# Type: string
docker_role_docker_memory:

docker_role_docker_memory_reservation

# Type: string
docker_role_docker_memory_reservation:

docker_role_docker_memory_swap

# Type: string
docker_role_docker_memory_swap:

docker_role_docker_memory_swappiness

# Type: int
docker_role_docker_memory_swappiness:

docker_role_docker_shm_size

# Type: string
docker_role_docker_shm_size:

Security & Devices

docker_role_docker_cap_drop

# Type: list
docker_role_docker_cap_drop:

docker_role_docker_cgroupns_mode

# Type: string
docker_role_docker_cgroupns_mode:

docker_role_docker_device_cgroup_rules

# Type: list
docker_role_docker_device_cgroup_rules:

docker_role_docker_device_read_bps

# Type: list
docker_role_docker_device_read_bps:

docker_role_docker_device_read_iops

# Type: list
docker_role_docker_device_read_iops:

docker_role_docker_device_requests

# Type: list
docker_role_docker_device_requests:

docker_role_docker_device_write_bps

# Type: list
docker_role_docker_device_write_bps:

docker_role_docker_device_write_iops

# Type: list
docker_role_docker_device_write_iops:

docker_role_docker_devices

# Type: list
docker_role_docker_devices:

docker_role_docker_devices_default

# Type: string
docker_role_docker_devices_default:

docker_role_docker_groups

# Type: list
docker_role_docker_groups:

docker_role_docker_privileged

# Type: bool (true/false)
docker_role_docker_privileged:

docker_role_docker_security_opts

# Type: list
docker_role_docker_security_opts:

docker_role_docker_user

# Type: string
docker_role_docker_user:

docker_role_docker_userns_mode

# Type: string
docker_role_docker_userns_mode:

Networking

docker_role_docker_dns_opts

# Type: list
docker_role_docker_dns_opts:

docker_role_docker_dns_search_domains

# Type: list
docker_role_docker_dns_search_domains:

docker_role_docker_dns_servers

# Type: list
docker_role_docker_dns_servers:

docker_role_docker_domainname

# Type: string
docker_role_docker_domainname:

docker_role_docker_exposed_ports

# Type: list
docker_role_docker_exposed_ports:

docker_role_docker_hostname

# Type: string
docker_role_docker_hostname:

docker_role_docker_hosts

# Type: dict
docker_role_docker_hosts:

docker_role_docker_hosts_use_common

# Type: bool (true/false)
docker_role_docker_hosts_use_common:

docker_role_docker_ipc_mode

# Type: string
docker_role_docker_ipc_mode:

docker_role_docker_links

# Type: list
docker_role_docker_links:

docker_role_docker_network_mode

# Type: string
docker_role_docker_network_mode:

docker_role_docker_networks

# Type: list
docker_role_docker_networks:

docker_role_docker_pid_mode

# Type: string
docker_role_docker_pid_mode:

docker_role_docker_ports

# Type: list
docker_role_docker_ports:

docker_role_docker_uts

# Type: string
docker_role_docker_uts:

Storage

docker_role_docker_keep_volumes

# Type: bool (true/false)
docker_role_docker_keep_volumes:

docker_role_docker_mounts

# Type: list
docker_role_docker_mounts:

docker_role_docker_storage_opts

# Type: dict
docker_role_docker_storage_opts:

docker_role_docker_tmpfs

# Type: list
docker_role_docker_tmpfs:

docker_role_docker_volume_driver

# Type: string
docker_role_docker_volume_driver:

docker_role_docker_volumes

# Type: list
docker_role_docker_volumes:

docker_role_docker_volumes_from

# Type: list
docker_role_docker_volumes_from:

docker_role_docker_volumes_global

# Type: bool (true/false)
docker_role_docker_volumes_global:

docker_role_docker_working_dir

# Type: string
docker_role_docker_working_dir:

Monitoring & Lifecycle

docker_role_docker_auto_remove

# Type: bool (true/false)
docker_role_docker_auto_remove:

docker_role_docker_cleanup

# Type: bool (true/false)
docker_role_docker_cleanup:

docker_role_docker_force_kill

# Type: string
docker_role_docker_force_kill:

docker_role_docker_healthcheck

# Type: dict
docker_role_docker_healthcheck:

docker_role_docker_healthy_wait_timeout

# Type: int
docker_role_docker_healthy_wait_timeout:

docker_role_docker_init

# Type: bool (true/false)
docker_role_docker_init:

docker_role_docker_kill_signal

# Type: string
docker_role_docker_kill_signal:

docker_role_docker_log_driver

# Type: string
docker_role_docker_log_driver:

docker_role_docker_log_options

# Type: dict
docker_role_docker_log_options:

docker_role_docker_oom_killer

# Type: bool (true/false)
docker_role_docker_oom_killer:

docker_role_docker_oom_score_adj

# Type: int
docker_role_docker_oom_score_adj:

docker_role_docker_output_logs

# Type: bool (true/false)
docker_role_docker_output_logs:

docker_role_docker_paused

# Type: bool (true/false)
docker_role_docker_paused:

docker_role_docker_recreate

# Type: bool (true/false)
docker_role_docker_recreate:

docker_role_docker_restart_policy

# Type: string
docker_role_docker_restart_policy:

docker_role_docker_restart_retries

# Type: int
docker_role_docker_restart_retries:

docker_role_docker_stop_timeout

# Type: int
docker_role_docker_stop_timeout:

Other Options

docker_role_docker_capabilities

# Type: list
docker_role_docker_capabilities:

docker_role_docker_cgroup_parent

# Type: string
docker_role_docker_cgroup_parent:

docker_role_docker_commands

# Type: list
docker_role_docker_commands:

docker_role_docker_container

# Type: string
docker_role_docker_container:

docker_role_docker_create_timeout

# Type: int
docker_role_docker_create_timeout:

docker_role_docker_entrypoint

# Type: string
docker_role_docker_entrypoint:

docker_role_docker_env_file

# Type: string
docker_role_docker_env_file:

docker_role_docker_envs

# Type: dict
docker_role_docker_envs:

docker_role_docker_image

# Type: string
docker_role_docker_image:

docker_role_docker_image_pull

# Type: bool (true/false)
docker_role_docker_image_pull:

docker_role_docker_labels

# Type: dict
docker_role_docker_labels:

docker_role_docker_labels_use_common

# Type: bool (true/false)
docker_role_docker_labels_use_common:

docker_role_docker_read_only

# Type: bool (true/false)
docker_role_docker_read_only:

docker_role_docker_runtime

# Type: string
docker_role_docker_runtime:

docker_role_docker_sysctls

# Type: list
docker_role_docker_sysctls:

docker_role_docker_ulimits

# Type: list
docker_role_docker_ulimits: