Overview

is

Manual

Releases

Community

---

Deployment

sb install timescaledb

Role Defaults

Variables can be customized using the Inventory. (1)

1. This role supports multiple instances via timescaledb_instances.

   Example override

   Role-scopedInstance-scoped

   timescaledb_role_web_subdomain: "custom"
   

   Applies to all instances of timescaledb

   timescaledb2_web_subdomain: "custom2"
   

   Applies to the instance named timescaledb2

   Avoid overriding variables ending in _default

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

BasicsSettingsDockerDocker+Global Override Options

timescaledb_instances

# Type: list
timescaledb_instances: ["timescaledb"]

Example Override

# Type: list
timescaledb_instances: ["timescaledb", "timescaledb2"]

timescaledb_role_docker_env_passwordtimescaledb2_docker_env_password

# Type: string
timescaledb_role_docker_env_password: "password4321"

# Type: string
timescaledb2_docker_env_password: "password4321"

timescaledb_role_docker_env_usertimescaledb2_docker_env_user

# Type: string
timescaledb_role_docker_env_user: "{{ user.name }}"

# Type: string
timescaledb2_docker_env_user: "{{ user.name }}"

timescaledb_role_docker_env_dbtimescaledb2_docker_env_db

# Type: string
timescaledb_role_docker_env_db: "saltbox"

# Type: string
timescaledb2_docker_env_db: "saltbox"

Container

timescaledb_role_docker_containertimescaledb2_docker_container

# Type: string
timescaledb_role_docker_container: "{{ timescaledb_name }}"

# Type: string
timescaledb2_docker_container: "{{ timescaledb_name }}"

Image

timescaledb_role_docker_image_pulltimescaledb2_docker_image_pull

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

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

timescaledb_role_docker_image_tagtimescaledb2_docker_image_tag

# Type: string
timescaledb_role_docker_image_tag: "pg18-all-amd64"

# Type: string
timescaledb2_docker_image_tag: "pg18-all-amd64"

timescaledb_role_docker_image_repotimescaledb2_docker_image_repo

# Type: string
timescaledb_role_docker_image_repo: "timescale/timescaledb-ha"

# Type: string
timescaledb2_docker_image_repo: "timescale/timescaledb-ha"

timescaledb_role_docker_imagetimescaledb2_docker_image

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

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

Envs

timescaledb_role_docker_envs_defaulttimescaledb2_docker_envs_default

# Type: dict
timescaledb_role_docker_envs_default:
  TZ: "{{ tz }}"
  PGDATA: "/pgdata"
  POSTGRES_PASSWORD: "{{ timescaledb_role_docker_env_password_effective }}"
  POSTGRES_USER: "{{ timescaledb_role_docker_env_user_effective }}"
  POSTGRES_DB: "{{ lookup('role_var', '_docker_env_db', role='timescaledb', default=timescaledb_role_docker_env_db) }}"

# Type: dict
timescaledb2_docker_envs_default:
  TZ: "{{ tz }}"
  PGDATA: "/pgdata"
  POSTGRES_PASSWORD: "{{ timescaledb_role_docker_env_password_effective }}"
  POSTGRES_USER: "{{ timescaledb_role_docker_env_user_effective }}"
  POSTGRES_DB: "{{ lookup('role_var', '_docker_env_db', role='timescaledb', default=timescaledb_role_docker_env_db) }}"

timescaledb_role_docker_envs_customtimescaledb2_docker_envs_custom

# Type: dict
timescaledb_role_docker_envs_custom: {}

# Type: dict
timescaledb2_docker_envs_custom: {}

Volumes

timescaledb_role_docker_volumes_defaulttimescaledb2_docker_volumes_default

# Type: list
timescaledb_role_docker_volumes_default:
  - "{{ timescaledb_role_paths_location }}:/pgdata"
  - "/etc/passwd:/etc/passwd:ro"

# Type: list
timescaledb2_docker_volumes_default:
  - "{{ timescaledb_role_paths_location }}:/pgdata"
  - "/etc/passwd:/etc/passwd:ro"

timescaledb_role_docker_volumes_customtimescaledb2_docker_volumes_custom

# Type: list
timescaledb_role_docker_volumes_custom: []

# Type: list
timescaledb2_docker_volumes_custom: []

Hostname

timescaledb_role_docker_hostnametimescaledb2_docker_hostname

# Type: string
timescaledb_role_docker_hostname: "{{ timescaledb_name }}"

# Type: string
timescaledb2_docker_hostname: "{{ timescaledb_name }}"

Networks

timescaledb_role_docker_networks_aliastimescaledb2_docker_networks_alias

# Type: string
timescaledb_role_docker_networks_alias: "{{ timescaledb_name }}"

# Type: string
timescaledb2_docker_networks_alias: "{{ timescaledb_name }}"

timescaledb_role_docker_networks_defaulttimescaledb2_docker_networks_default

# Type: list
timescaledb_role_docker_networks_default: []

# Type: list
timescaledb2_docker_networks_default: []

timescaledb_role_docker_networks_customtimescaledb2_docker_networks_custom

# Type: list
timescaledb_role_docker_networks_custom: []

# Type: list
timescaledb2_docker_networks_custom: []

Restart Policy

timescaledb_role_docker_restart_policytimescaledb2_docker_restart_policy

# Type: string
timescaledb_role_docker_restart_policy: unless-stopped

# Type: string
timescaledb2_docker_restart_policy: unless-stopped

State

timescaledb_role_docker_statetimescaledb2_docker_state

# Type: string
timescaledb_role_docker_state: started

# Type: string
timescaledb2_docker_state: started

User

timescaledb_role_docker_usertimescaledb2_docker_user

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

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

SHM size

timescaledb_role_docker_shm_sizetimescaledb2_docker_shm_size

# Type: string
timescaledb_role_docker_shm_size: "128M"

# Type: string
timescaledb2_docker_shm_size: "128M"

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

Resource Limits

timescaledb_role_docker_blkio_weighttimescaledb2_docker_blkio_weight

# Type: int
timescaledb_role_docker_blkio_weight:

# Type: int
timescaledb2_docker_blkio_weight:

timescaledb_role_docker_cpu_periodtimescaledb2_docker_cpu_period

# Type: int
timescaledb_role_docker_cpu_period:

# Type: int
timescaledb2_docker_cpu_period:

timescaledb_role_docker_cpu_quotatimescaledb2_docker_cpu_quota

# Type: int
timescaledb_role_docker_cpu_quota:

# Type: int
timescaledb2_docker_cpu_quota:

timescaledb_role_docker_cpu_sharestimescaledb2_docker_cpu_shares

# Type: int
timescaledb_role_docker_cpu_shares:

# Type: int
timescaledb2_docker_cpu_shares:

timescaledb_role_docker_cpustimescaledb2_docker_cpus

# Type: string
timescaledb_role_docker_cpus:

# Type: string
timescaledb2_docker_cpus:

timescaledb_role_docker_cpuset_cpustimescaledb2_docker_cpuset_cpus

# Type: string
timescaledb_role_docker_cpuset_cpus:

# Type: string
timescaledb2_docker_cpuset_cpus:

timescaledb_role_docker_cpuset_memstimescaledb2_docker_cpuset_mems

# Type: string
timescaledb_role_docker_cpuset_mems:

# Type: string
timescaledb2_docker_cpuset_mems:

timescaledb_role_docker_kernel_memorytimescaledb2_docker_kernel_memory

# Type: string
timescaledb_role_docker_kernel_memory:

# Type: string
timescaledb2_docker_kernel_memory:

timescaledb_role_docker_memorytimescaledb2_docker_memory

# Type: string
timescaledb_role_docker_memory:

# Type: string
timescaledb2_docker_memory:

timescaledb_role_docker_memory_reservationtimescaledb2_docker_memory_reservation

# Type: string
timescaledb_role_docker_memory_reservation:

# Type: string
timescaledb2_docker_memory_reservation:

timescaledb_role_docker_memory_swaptimescaledb2_docker_memory_swap

# Type: string
timescaledb_role_docker_memory_swap:

# Type: string
timescaledb2_docker_memory_swap:

timescaledb_role_docker_memory_swappinesstimescaledb2_docker_memory_swappiness

# Type: int
timescaledb_role_docker_memory_swappiness:

# Type: int
timescaledb2_docker_memory_swappiness:

Security & Devices

timescaledb_role_docker_cap_droptimescaledb2_docker_cap_drop

# Type: list
timescaledb_role_docker_cap_drop:

# Type: list
timescaledb2_docker_cap_drop:

timescaledb_role_docker_cgroupns_modetimescaledb2_docker_cgroupns_mode

# Type: string
timescaledb_role_docker_cgroupns_mode:

# Type: string
timescaledb2_docker_cgroupns_mode:

timescaledb_role_docker_device_cgroup_rulestimescaledb2_docker_device_cgroup_rules

# Type: list
timescaledb_role_docker_device_cgroup_rules:

# Type: list
timescaledb2_docker_device_cgroup_rules:

timescaledb_role_docker_device_read_bpstimescaledb2_docker_device_read_bps

# Type: list
timescaledb_role_docker_device_read_bps:

# Type: list
timescaledb2_docker_device_read_bps:

timescaledb_role_docker_device_read_iopstimescaledb2_docker_device_read_iops

# Type: list
timescaledb_role_docker_device_read_iops:

# Type: list
timescaledb2_docker_device_read_iops:

timescaledb_role_docker_device_requeststimescaledb2_docker_device_requests

# Type: list
timescaledb_role_docker_device_requests:

# Type: list
timescaledb2_docker_device_requests:

timescaledb_role_docker_device_write_bpstimescaledb2_docker_device_write_bps

# Type: list
timescaledb_role_docker_device_write_bps:

# Type: list
timescaledb2_docker_device_write_bps:

timescaledb_role_docker_device_write_iopstimescaledb2_docker_device_write_iops

# Type: list
timescaledb_role_docker_device_write_iops:

# Type: list
timescaledb2_docker_device_write_iops:

timescaledb_role_docker_devicestimescaledb2_docker_devices

# Type: list
timescaledb_role_docker_devices:

# Type: list
timescaledb2_docker_devices:

timescaledb_role_docker_groupstimescaledb2_docker_groups

# Type: list
timescaledb_role_docker_groups:

# Type: list
timescaledb2_docker_groups:

timescaledb_role_docker_privilegedtimescaledb2_docker_privileged

# Type: bool (true/false)
timescaledb_role_docker_privileged:

# Type: bool (true/false)
timescaledb2_docker_privileged:

timescaledb_role_docker_security_optstimescaledb2_docker_security_opts

# Type: list
timescaledb_role_docker_security_opts:

# Type: list
timescaledb2_docker_security_opts:

timescaledb_role_docker_userns_modetimescaledb2_docker_userns_mode

# Type: string
timescaledb_role_docker_userns_mode:

# Type: string
timescaledb2_docker_userns_mode:

Networking

timescaledb_role_docker_dns_optstimescaledb2_docker_dns_opts

# Type: list
timescaledb_role_docker_dns_opts:

# Type: list
timescaledb2_docker_dns_opts:

timescaledb_role_docker_dns_search_domainstimescaledb2_docker_dns_search_domains

# Type: list
timescaledb_role_docker_dns_search_domains:

# Type: list
timescaledb2_docker_dns_search_domains:

timescaledb_role_docker_dns_serverstimescaledb2_docker_dns_servers

# Type: list
timescaledb_role_docker_dns_servers:

# Type: list
timescaledb2_docker_dns_servers:

timescaledb_role_docker_domainnametimescaledb2_docker_domainname

# Type: string
timescaledb_role_docker_domainname:

# Type: string
timescaledb2_docker_domainname:

timescaledb_role_docker_exposed_portstimescaledb2_docker_exposed_ports

# Type: list
timescaledb_role_docker_exposed_ports:

# Type: list
timescaledb2_docker_exposed_ports:

timescaledb_role_docker_hoststimescaledb2_docker_hosts

# Type: dict
timescaledb_role_docker_hosts:

# Type: dict
timescaledb2_docker_hosts:

timescaledb_role_docker_hosts_use_commontimescaledb2_docker_hosts_use_common

# Type: bool (true/false)
timescaledb_role_docker_hosts_use_common:

# Type: bool (true/false)
timescaledb2_docker_hosts_use_common:

timescaledb_role_docker_ipc_modetimescaledb2_docker_ipc_mode

# Type: string
timescaledb_role_docker_ipc_mode:

# Type: string
timescaledb2_docker_ipc_mode:

timescaledb_role_docker_linkstimescaledb2_docker_links

# Type: list
timescaledb_role_docker_links:

# Type: list
timescaledb2_docker_links:

timescaledb_role_docker_network_modetimescaledb2_docker_network_mode

# Type: string
timescaledb_role_docker_network_mode:

# Type: string
timescaledb2_docker_network_mode:

timescaledb_role_docker_pid_modetimescaledb2_docker_pid_mode

# Type: string
timescaledb_role_docker_pid_mode:

# Type: string
timescaledb2_docker_pid_mode:

timescaledb_role_docker_portstimescaledb2_docker_ports

# Type: list
timescaledb_role_docker_ports:

# Type: list
timescaledb2_docker_ports:

timescaledb_role_docker_utstimescaledb2_docker_uts

# Type: string
timescaledb_role_docker_uts:

# Type: string
timescaledb2_docker_uts:

Storage

timescaledb_role_docker_keep_volumestimescaledb2_docker_keep_volumes

# Type: bool (true/false)
timescaledb_role_docker_keep_volumes:

# Type: bool (true/false)
timescaledb2_docker_keep_volumes:

timescaledb_role_docker_mountstimescaledb2_docker_mounts

# Type: list
timescaledb_role_docker_mounts:

# Type: list
timescaledb2_docker_mounts:

timescaledb_role_docker_storage_optstimescaledb2_docker_storage_opts

# Type: dict
timescaledb_role_docker_storage_opts:

# Type: dict
timescaledb2_docker_storage_opts:

timescaledb_role_docker_tmpfstimescaledb2_docker_tmpfs

# Type: list
timescaledb_role_docker_tmpfs:

# Type: list
timescaledb2_docker_tmpfs:

timescaledb_role_docker_volume_drivertimescaledb2_docker_volume_driver

# Type: string
timescaledb_role_docker_volume_driver:

# Type: string
timescaledb2_docker_volume_driver:

timescaledb_role_docker_volumes_fromtimescaledb2_docker_volumes_from

# Type: list
timescaledb_role_docker_volumes_from:

# Type: list
timescaledb2_docker_volumes_from:

timescaledb_role_docker_volumes_globaltimescaledb2_docker_volumes_global

# Type: bool (true/false)
timescaledb_role_docker_volumes_global:

# Type: bool (true/false)
timescaledb2_docker_volumes_global:

timescaledb_role_docker_working_dirtimescaledb2_docker_working_dir

# Type: string
timescaledb_role_docker_working_dir:

# Type: string
timescaledb2_docker_working_dir:

Monitoring & Lifecycle

timescaledb_role_docker_auto_removetimescaledb2_docker_auto_remove

# Type: bool (true/false)
timescaledb_role_docker_auto_remove:

# Type: bool (true/false)
timescaledb2_docker_auto_remove:

timescaledb_role_docker_cleanuptimescaledb2_docker_cleanup

# Type: bool (true/false)
timescaledb_role_docker_cleanup:

# Type: bool (true/false)
timescaledb2_docker_cleanup:

timescaledb_role_docker_force_killtimescaledb2_docker_force_kill

# Type: string
timescaledb_role_docker_force_kill:

# Type: string
timescaledb2_docker_force_kill:

timescaledb_role_docker_healthchecktimescaledb2_docker_healthcheck

# Type: dict
timescaledb_role_docker_healthcheck:

# Type: dict
timescaledb2_docker_healthcheck:

timescaledb_role_docker_healthy_wait_timeouttimescaledb2_docker_healthy_wait_timeout

# Type: int
timescaledb_role_docker_healthy_wait_timeout:

# Type: int
timescaledb2_docker_healthy_wait_timeout:

timescaledb_role_docker_inittimescaledb2_docker_init

# Type: bool (true/false)
timescaledb_role_docker_init:

# Type: bool (true/false)
timescaledb2_docker_init:

timescaledb_role_docker_kill_signaltimescaledb2_docker_kill_signal

# Type: string
timescaledb_role_docker_kill_signal:

# Type: string
timescaledb2_docker_kill_signal:

timescaledb_role_docker_log_drivertimescaledb2_docker_log_driver

# Type: string
timescaledb_role_docker_log_driver:

# Type: string
timescaledb2_docker_log_driver:

timescaledb_role_docker_log_optionstimescaledb2_docker_log_options

# Type: dict
timescaledb_role_docker_log_options:

# Type: dict
timescaledb2_docker_log_options:

timescaledb_role_docker_oom_killertimescaledb2_docker_oom_killer

# Type: bool (true/false)
timescaledb_role_docker_oom_killer:

# Type: bool (true/false)
timescaledb2_docker_oom_killer:

timescaledb_role_docker_oom_score_adjtimescaledb2_docker_oom_score_adj

# Type: int
timescaledb_role_docker_oom_score_adj:

# Type: int
timescaledb2_docker_oom_score_adj:

timescaledb_role_docker_output_logstimescaledb2_docker_output_logs

# Type: bool (true/false)
timescaledb_role_docker_output_logs:

# Type: bool (true/false)
timescaledb2_docker_output_logs:

timescaledb_role_docker_pausedtimescaledb2_docker_paused

# Type: bool (true/false)
timescaledb_role_docker_paused:

# Type: bool (true/false)
timescaledb2_docker_paused:

timescaledb_role_docker_recreatetimescaledb2_docker_recreate

# Type: bool (true/false)
timescaledb_role_docker_recreate:

# Type: bool (true/false)
timescaledb2_docker_recreate:

timescaledb_role_docker_restart_retriestimescaledb2_docker_restart_retries

# Type: int
timescaledb_role_docker_restart_retries:

# Type: int
timescaledb2_docker_restart_retries:

timescaledb_role_docker_stop_signaltimescaledb2_docker_stop_signal

# Type: string
timescaledb_role_docker_stop_signal:

# Type: string
timescaledb2_docker_stop_signal:

timescaledb_role_docker_stop_timeouttimescaledb2_docker_stop_timeout

# Type: int
timescaledb_role_docker_stop_timeout:

# Type: int
timescaledb2_docker_stop_timeout:

Other Options

timescaledb_role_docker_capabilitiestimescaledb2_docker_capabilities

# Type: list
timescaledb_role_docker_capabilities:

# Type: list
timescaledb2_docker_capabilities:

timescaledb_role_docker_cgroup_parenttimescaledb2_docker_cgroup_parent

# Type: string
timescaledb_role_docker_cgroup_parent:

# Type: string
timescaledb2_docker_cgroup_parent:

timescaledb_role_docker_commandstimescaledb2_docker_commands

# Type: list
timescaledb_role_docker_commands:

# Type: list
timescaledb2_docker_commands:

timescaledb_role_docker_create_timeouttimescaledb2_docker_create_timeout

# Type: int
timescaledb_role_docker_create_timeout:

# Type: int
timescaledb2_docker_create_timeout:

timescaledb_role_docker_entrypointtimescaledb2_docker_entrypoint

# Type: string
timescaledb_role_docker_entrypoint:

# Type: string
timescaledb2_docker_entrypoint:

timescaledb_role_docker_env_filetimescaledb2_docker_env_file

# Type: string
timescaledb_role_docker_env_file:

# Type: string
timescaledb2_docker_env_file:

timescaledb_role_docker_labelstimescaledb2_docker_labels

# Type: dict
timescaledb_role_docker_labels:

# Type: dict
timescaledb2_docker_labels:

timescaledb_role_docker_labels_use_commontimescaledb2_docker_labels_use_common

# Type: bool (true/false)
timescaledb_role_docker_labels_use_common:

# Type: bool (true/false)
timescaledb2_docker_labels_use_common:

timescaledb_role_docker_read_onlytimescaledb2_docker_read_only

# Type: bool (true/false)
timescaledb_role_docker_read_only:

# Type: bool (true/false)
timescaledb2_docker_read_only:

timescaledb_role_docker_runtimetimescaledb2_docker_runtime

# Type: string
timescaledb_role_docker_runtime:

# Type: string
timescaledb2_docker_runtime:

timescaledb_role_docker_sysctlstimescaledb2_docker_sysctls

# Type: list
timescaledb_role_docker_sysctls:

# Type: list
timescaledb2_docker_sysctls:

timescaledb_role_docker_ulimitstimescaledb2_docker_ulimits

# Type: list
timescaledb_role_docker_ulimits:

# Type: list
timescaledb2_docker_ulimits:

timescaledb_role_autoheal_enabledtimescaledb2_autoheal_enabled

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

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

timescaledb_role_depends_ontimescaledb2_depends_on

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

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

timescaledb_role_depends_on_delaytimescaledb2_depends_on_delay

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

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

timescaledb_role_depends_on_healthcheckstimescaledb2_depends_on_healthchecks

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

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

timescaledb_role_diun_enabledtimescaledb2_diun_enabled

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

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

timescaledb_role_docker_controllertimescaledb2_docker_controller

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

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

timescaledb_role_docker_networks_alias_customtimescaledb2_docker_networks_alias_custom

# Type: list
timescaledb_role_docker_networks_alias_custom:

# Type: list
timescaledb2_docker_networks_alias_custom:

timescaledb_role_docker_volumes_downloadtimescaledb2_docker_volumes_download

# Type: bool (true/false)
timescaledb_role_docker_volumes_download:

# Type: bool (true/false)
timescaledb2_docker_volumes_download: