InfluxDB

Overview

InfluxDB is an open source time series database for recording metrics, events, and analytics.

Manual

Releases

Community

---

Note

This role is version locked to version 1.8.4 to support the varken role. To utilize InfluxDB version 2.0, utilize the influxdb2 role.

Deployment

sb install sandbox-influxdb

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   influxdb_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsDockerDocker+Global Override Options

influxdb_name

# Type: string
influxdb_name: influxdb

Container

influxdb_role_docker_container

# Type: string
influxdb_role_docker_container: "{{ influxdb_name }}"

Image

influxdb_role_docker_image_pull

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

influxdb_role_docker_image_repo

# Type: string
influxdb_role_docker_image_repo: "influxdb"

influxdb_role_docker_image_tag

# Type: string
influxdb_role_docker_image_tag: "1.12"

influxdb_role_docker_image

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

Volumes

influxdb_role_docker_volumes_default

# Type: list
influxdb_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='influxdb') }}:/var/lib/influxdb"

influxdb_role_docker_volumes_custom

# Type: list
influxdb_role_docker_volumes_custom: []

Hostname

influxdb_role_docker_hostname

# Type: string
influxdb_role_docker_hostname: "{{ influxdb_name }}"

Networks

influxdb_role_docker_networks_alias

# Type: string
influxdb_role_docker_networks_alias: "{{ influxdb_name }}"

influxdb_role_docker_networks_default

# Type: list
influxdb_role_docker_networks_default: []

influxdb_role_docker_networks_custom

# Type: list
influxdb_role_docker_networks_custom: []

Restart Policy

influxdb_role_docker_restart_policy

# Type: string
influxdb_role_docker_restart_policy: unless-stopped

State

influxdb_role_docker_state

# Type: string
influxdb_role_docker_state: started

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

Resource Limits

influxdb_role_docker_blkio_weight

# Type: int
influxdb_role_docker_blkio_weight:

influxdb_role_docker_cpu_period

# Type: int
influxdb_role_docker_cpu_period:

influxdb_role_docker_cpu_quota

# Type: int
influxdb_role_docker_cpu_quota:

influxdb_role_docker_cpu_shares

# Type: int
influxdb_role_docker_cpu_shares:

influxdb_role_docker_cpus

# Type: string
influxdb_role_docker_cpus:

influxdb_role_docker_cpuset_cpus

# Type: string
influxdb_role_docker_cpuset_cpus:

influxdb_role_docker_cpuset_mems

# Type: string
influxdb_role_docker_cpuset_mems:

influxdb_role_docker_kernel_memory

# Type: string
influxdb_role_docker_kernel_memory:

influxdb_role_docker_memory

# Type: string
influxdb_role_docker_memory:

influxdb_role_docker_memory_reservation

# Type: string
influxdb_role_docker_memory_reservation:

influxdb_role_docker_memory_swap

# Type: string
influxdb_role_docker_memory_swap:

influxdb_role_docker_memory_swappiness

# Type: int
influxdb_role_docker_memory_swappiness:

influxdb_role_docker_shm_size

# Type: string
influxdb_role_docker_shm_size:

Security & Devices

influxdb_role_docker_cap_drop

# Type: list
influxdb_role_docker_cap_drop:

influxdb_role_docker_cgroupns_mode

# Type: string
influxdb_role_docker_cgroupns_mode:

influxdb_role_docker_device_cgroup_rules

# Type: list
influxdb_role_docker_device_cgroup_rules:

influxdb_role_docker_device_read_bps

# Type: list
influxdb_role_docker_device_read_bps:

influxdb_role_docker_device_read_iops

# Type: list
influxdb_role_docker_device_read_iops:

influxdb_role_docker_device_requests

# Type: list
influxdb_role_docker_device_requests:

influxdb_role_docker_device_write_bps

# Type: list
influxdb_role_docker_device_write_bps:

influxdb_role_docker_device_write_iops

# Type: list
influxdb_role_docker_device_write_iops:

influxdb_role_docker_devices

# Type: list
influxdb_role_docker_devices:

influxdb_role_docker_devices_default

# Type: string
influxdb_role_docker_devices_default:

influxdb_role_docker_groups

# Type: list
influxdb_role_docker_groups:

influxdb_role_docker_privileged

# Type: bool (true/false)
influxdb_role_docker_privileged:

influxdb_role_docker_security_opts

# Type: list
influxdb_role_docker_security_opts:

influxdb_role_docker_user

# Type: string
influxdb_role_docker_user:

influxdb_role_docker_userns_mode

# Type: string
influxdb_role_docker_userns_mode:

Networking

influxdb_role_docker_dns_opts

# Type: list
influxdb_role_docker_dns_opts:

influxdb_role_docker_dns_search_domains

# Type: list
influxdb_role_docker_dns_search_domains:

influxdb_role_docker_dns_servers

# Type: list
influxdb_role_docker_dns_servers:

influxdb_role_docker_domainname

# Type: string
influxdb_role_docker_domainname:

influxdb_role_docker_exposed_ports

# Type: list
influxdb_role_docker_exposed_ports:

influxdb_role_docker_hosts

# Type: dict
influxdb_role_docker_hosts:

influxdb_role_docker_hosts_use_common

# Type: bool (true/false)
influxdb_role_docker_hosts_use_common:

influxdb_role_docker_ipc_mode

# Type: string
influxdb_role_docker_ipc_mode:

influxdb_role_docker_links

# Type: list
influxdb_role_docker_links:

influxdb_role_docker_network_mode

# Type: string
influxdb_role_docker_network_mode:

influxdb_role_docker_pid_mode

# Type: string
influxdb_role_docker_pid_mode:

influxdb_role_docker_ports

# Type: list
influxdb_role_docker_ports:

influxdb_role_docker_uts

# Type: string
influxdb_role_docker_uts:

Storage

influxdb_role_docker_keep_volumes

# Type: bool (true/false)
influxdb_role_docker_keep_volumes:

influxdb_role_docker_mounts

# Type: list
influxdb_role_docker_mounts:

influxdb_role_docker_storage_opts

# Type: dict
influxdb_role_docker_storage_opts:

influxdb_role_docker_tmpfs

# Type: list
influxdb_role_docker_tmpfs:

influxdb_role_docker_volume_driver

# Type: string
influxdb_role_docker_volume_driver:

influxdb_role_docker_volumes_from

# Type: list
influxdb_role_docker_volumes_from:

influxdb_role_docker_volumes_global

# Type: bool (true/false)
influxdb_role_docker_volumes_global:

influxdb_role_docker_working_dir

# Type: string
influxdb_role_docker_working_dir:

Monitoring & Lifecycle

influxdb_role_docker_auto_remove

# Type: bool (true/false)
influxdb_role_docker_auto_remove:

influxdb_role_docker_cleanup

# Type: bool (true/false)
influxdb_role_docker_cleanup:

influxdb_role_docker_force_kill

# Type: string
influxdb_role_docker_force_kill:

influxdb_role_docker_healthcheck

# Type: dict
influxdb_role_docker_healthcheck:

influxdb_role_docker_healthy_wait_timeout

# Type: int
influxdb_role_docker_healthy_wait_timeout:

influxdb_role_docker_init

# Type: bool (true/false)
influxdb_role_docker_init:

influxdb_role_docker_kill_signal

# Type: string
influxdb_role_docker_kill_signal:

influxdb_role_docker_log_driver

# Type: string
influxdb_role_docker_log_driver:

influxdb_role_docker_log_options

# Type: dict
influxdb_role_docker_log_options:

influxdb_role_docker_oom_killer

# Type: bool (true/false)
influxdb_role_docker_oom_killer:

influxdb_role_docker_oom_score_adj

# Type: int
influxdb_role_docker_oom_score_adj:

influxdb_role_docker_output_logs

# Type: bool (true/false)
influxdb_role_docker_output_logs:

influxdb_role_docker_paused

# Type: bool (true/false)
influxdb_role_docker_paused:

influxdb_role_docker_recreate

# Type: bool (true/false)
influxdb_role_docker_recreate:

influxdb_role_docker_restart_retries

# Type: int
influxdb_role_docker_restart_retries:

influxdb_role_docker_stop_timeout

# Type: int
influxdb_role_docker_stop_timeout:

Other Options

influxdb_role_docker_capabilities

# Type: list
influxdb_role_docker_capabilities:

influxdb_role_docker_cgroup_parent

# Type: string
influxdb_role_docker_cgroup_parent:

influxdb_role_docker_commands

# Type: list
influxdb_role_docker_commands:

influxdb_role_docker_create_timeout

# Type: int
influxdb_role_docker_create_timeout:

influxdb_role_docker_entrypoint

# Type: string
influxdb_role_docker_entrypoint:

influxdb_role_docker_env_file

# Type: string
influxdb_role_docker_env_file:

influxdb_role_docker_envs

# Type: dict
influxdb_role_docker_envs:

influxdb_role_docker_labels

# Type: dict
influxdb_role_docker_labels:

influxdb_role_docker_labels_use_common

# Type: bool (true/false)
influxdb_role_docker_labels_use_common:

influxdb_role_docker_read_only

# Type: bool (true/false)
influxdb_role_docker_read_only:

influxdb_role_docker_runtime

# Type: string
influxdb_role_docker_runtime:

influxdb_role_docker_sysctls

# Type: list
influxdb_role_docker_sysctls:

influxdb_role_docker_ulimits

# Type: list
influxdb_role_docker_ulimits:

influxdb_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
influxdb_role_autoheal_enabled: true

influxdb_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
influxdb_role_depends_on: ""

influxdb_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
influxdb_role_depends_on_delay: "0"

influxdb_role_depends_on_healthchecks

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

influxdb_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
influxdb_role_diun_enabled: true

influxdb_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
influxdb_role_docker_controller: true

influxdb_role_docker_image_repo

# Type: string
influxdb_role_docker_image_repo:

influxdb_role_docker_image_tag

# Type: string
influxdb_role_docker_image_tag:

influxdb_role_docker_volumes_download

# Type: bool (true/false)
influxdb_role_docker_volumes_download:

influxdb_role_paths_location

# Type: string
influxdb_role_paths_location: