Skip to content

Telegraf

Overview

Telegraf is a plugin-driven server agent for collecting and sending metrics and events from databases, systems, and IoT sensors.


Deployment

sb install sandbox-telegraf

Role Defaults

Use the Inventory to customize variables. (1)

  1. This role supports multiple instances via telegraf_instances.

    Example override

    telegraf_role_web_subdomain: "custom"
    

    Applies to all instances of telegraf

    telegraf2_web_subdomain: "custom2"
    

    Applies to the instance named telegraf2

    Avoid overriding variables ending in _default

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

telegraf_instances
# Type: list
telegraf_instances: ["telegraf"]

Example Override

# Type: list
telegraf_instances: ["telegraf", "telegraf2"]
telegraf_role_web_subdomaintelegraf2_web_subdomain
# Type: string
telegraf_role_web_subdomain: "{{ telegraf_name }}"
# Type: string
telegraf2_web_subdomain: "{{ telegraf_name }}"
telegraf_role_web_domaintelegraf2_web_domain
# Type: string
telegraf_role_web_domain: "{{ user.domain }}"
# Type: string
telegraf2_web_domain: "{{ user.domain }}"
telegraf_role_dns_recordtelegraf2_dns_record
# Type: string
telegraf_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='telegraf') }}"
# Type: string
telegraf2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='telegraf') }}"
telegraf_role_dns_zonetelegraf2_dns_zone
# Type: string
telegraf_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='telegraf') }}"
# Type: string
telegraf2_dns_zone: "{{ lookup('role_var', '_web_domain', role='telegraf') }}"
telegraf_role_dns_proxytelegraf2_dns_proxy
# Type: bool (true/false)
telegraf_role_dns_proxy: false
# Type: bool (true/false)
telegraf2_dns_proxy: false
telegraf_role_traefik_sso_middlewaretelegraf2_traefik_sso_middleware
# Type: string
telegraf_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
# Type: string
telegraf2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
telegraf_role_traefik_middleware_defaulttelegraf2_traefik_middleware_default
# Type: string
telegraf_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
# Type: string
telegraf2_traefik_middleware_default: "{{ traefik_default_middleware }}"
telegraf_role_traefik_middleware_customtelegraf2_traefik_middleware_custom
# Type: string
telegraf_role_traefik_middleware_custom: ""
# Type: string
telegraf2_traefik_middleware_custom: ""
telegraf_role_traefik_certresolvertelegraf2_traefik_certresolver
# Type: string
telegraf_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
telegraf2_traefik_certresolver: "{{ traefik_default_certresolver }}"
telegraf_role_traefik_enabledtelegraf2_traefik_enabled
# Type: bool (true/false)
telegraf_role_traefik_enabled: true
# Type: bool (true/false)
telegraf2_traefik_enabled: true
telegraf_role_traefik_api_enabledtelegraf2_traefik_api_enabled
# Type: bool (true/false)
telegraf_role_traefik_api_enabled: false
# Type: bool (true/false)
telegraf2_traefik_api_enabled: false
telegraf_role_traefik_api_endpointtelegraf2_traefik_api_endpoint
# Type: string
telegraf_role_traefik_api_endpoint: ""
# Type: string
telegraf2_traefik_api_endpoint: ""

Container

telegraf_role_docker_containertelegraf2_docker_container
# Type: string
telegraf_role_docker_container: "{{ telegraf_name }}"
# Type: string
telegraf2_docker_container: "{{ telegraf_name }}"

Image

telegraf_role_docker_image_pulltelegraf2_docker_image_pull
# Type: bool (true/false)
telegraf_role_docker_image_pull: true
# Type: bool (true/false)
telegraf2_docker_image_pull: true
telegraf_role_docker_image_repotelegraf2_docker_image_repo
# Type: string
telegraf_role_docker_image_repo: "telegraf"
# Type: string
telegraf2_docker_image_repo: "telegraf"
telegraf_role_docker_image_tagtelegraf2_docker_image_tag
# Type: string
telegraf_role_docker_image_tag: "latest"
# Type: string
telegraf2_docker_image_tag: "latest"
telegraf_role_docker_imagetelegraf2_docker_image
# Type: string
telegraf_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='telegraf') }}:{{ lookup('role_var', '_docker_image_tag', role='telegraf') }}"
# Type: string
telegraf2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='telegraf') }}:{{ lookup('role_var', '_docker_image_tag', role='telegraf') }}"

Envs

telegraf_role_docker_envs_defaulttelegraf2_docker_envs_default
# Type: dict
telegraf_role_docker_envs_default:
  TZ: "{{ tz }}"
  EULA: "TRUE"
  UID: "{{ uid }}"
  GID: "{{ gid }}"
# Type: dict
telegraf2_docker_envs_default:
  TZ: "{{ tz }}"
  EULA: "TRUE"
  UID: "{{ uid }}"
  GID: "{{ gid }}"
telegraf_role_docker_envs_customtelegraf2_docker_envs_custom
# Type: dict
telegraf_role_docker_envs_custom: {}
# Type: dict
telegraf2_docker_envs_custom: {}

Volumes

telegraf_role_docker_volumes_defaulttelegraf2_docker_volumes_default
# Type: list
telegraf_role_docker_volumes_default:
  - "{{ server_appdata_path }}/telegraf/{{ telegraf_name }}:/etc/telegraf:ro"
  - "/var/run/docker.sock:/var/run/docker.sock:ro"
  - "/var/run/utmp:/var/run/utmp"
  - "/:/host:ro"
  - "/sys:/host/sys:ro"
  - "/proc:/host/proc:ro"
  - "/etc:/host/etc:ro"
# Type: list
telegraf2_docker_volumes_default:
  - "{{ server_appdata_path }}/telegraf/{{ telegraf_name }}:/etc/telegraf:ro"
  - "/var/run/docker.sock:/var/run/docker.sock:ro"
  - "/var/run/utmp:/var/run/utmp"
  - "/:/host:ro"
  - "/sys:/host/sys:ro"
  - "/proc:/host/proc:ro"
  - "/etc:/host/etc:ro"
telegraf_role_docker_volumes_customtelegraf2_docker_volumes_custom
# Type: list
telegraf_role_docker_volumes_custom: []
# Type: list
telegraf2_docker_volumes_custom: []

Hostname

telegraf_role_docker_hostnametelegraf2_docker_hostname
# Type: string
telegraf_role_docker_hostname: "{{ telegraf_name }}"
# Type: string
telegraf2_docker_hostname: "{{ telegraf_name }}"

Networks

telegraf_role_docker_networks_aliastelegraf2_docker_networks_alias
# Type: string
telegraf_role_docker_networks_alias: "{{ telegraf_name }}"
# Type: string
telegraf2_docker_networks_alias: "{{ telegraf_name }}"
telegraf_role_docker_networks_defaulttelegraf2_docker_networks_default
# Type: list
telegraf_role_docker_networks_default: []
# Type: list
telegraf2_docker_networks_default: []
telegraf_role_docker_networks_customtelegraf2_docker_networks_custom
# Type: list
telegraf_role_docker_networks_custom: []
# Type: list
telegraf2_docker_networks_custom: []

Restart Policy

telegraf_role_docker_restart_policytelegraf2_docker_restart_policy
# Type: string
telegraf_role_docker_restart_policy: unless-stopped
# Type: string
telegraf2_docker_restart_policy: unless-stopped

State

telegraf_role_docker_statetelegraf2_docker_state
# Type: string
telegraf_role_docker_state: started
# Type: string
telegraf2_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

telegraf_role_docker_blkio_weighttelegraf2_docker_blkio_weight
# Type: int
telegraf_role_docker_blkio_weight:
# Type: int
telegraf2_docker_blkio_weight:
telegraf_role_docker_cpu_periodtelegraf2_docker_cpu_period
# Type: int
telegraf_role_docker_cpu_period:
# Type: int
telegraf2_docker_cpu_period:
telegraf_role_docker_cpu_quotatelegraf2_docker_cpu_quota
# Type: int
telegraf_role_docker_cpu_quota:
# Type: int
telegraf2_docker_cpu_quota:
telegraf_role_docker_cpu_sharestelegraf2_docker_cpu_shares
# Type: int
telegraf_role_docker_cpu_shares:
# Type: int
telegraf2_docker_cpu_shares:
telegraf_role_docker_cpustelegraf2_docker_cpus
# Type: string
telegraf_role_docker_cpus:
# Type: string
telegraf2_docker_cpus:
telegraf_role_docker_cpuset_cpustelegraf2_docker_cpuset_cpus
# Type: string
telegraf_role_docker_cpuset_cpus:
# Type: string
telegraf2_docker_cpuset_cpus:
telegraf_role_docker_cpuset_memstelegraf2_docker_cpuset_mems
# Type: string
telegraf_role_docker_cpuset_mems:
# Type: string
telegraf2_docker_cpuset_mems:
telegraf_role_docker_kernel_memorytelegraf2_docker_kernel_memory
# Type: string
telegraf_role_docker_kernel_memory:
# Type: string
telegraf2_docker_kernel_memory:
telegraf_role_docker_memorytelegraf2_docker_memory
# Type: string
telegraf_role_docker_memory:
# Type: string
telegraf2_docker_memory:
telegraf_role_docker_memory_reservationtelegraf2_docker_memory_reservation
# Type: string
telegraf_role_docker_memory_reservation:
# Type: string
telegraf2_docker_memory_reservation:
telegraf_role_docker_memory_swaptelegraf2_docker_memory_swap
# Type: string
telegraf_role_docker_memory_swap:
# Type: string
telegraf2_docker_memory_swap:
telegraf_role_docker_memory_swappinesstelegraf2_docker_memory_swappiness
# Type: int
telegraf_role_docker_memory_swappiness:
# Type: int
telegraf2_docker_memory_swappiness:
telegraf_role_docker_shm_sizetelegraf2_docker_shm_size
# Type: string
telegraf_role_docker_shm_size:
# Type: string
telegraf2_docker_shm_size:

Security & Devices

telegraf_role_docker_cap_droptelegraf2_docker_cap_drop
# Type: list
telegraf_role_docker_cap_drop:
# Type: list
telegraf2_docker_cap_drop:
telegraf_role_docker_cgroupns_modetelegraf2_docker_cgroupns_mode
# Type: string
telegraf_role_docker_cgroupns_mode:
# Type: string
telegraf2_docker_cgroupns_mode:
telegraf_role_docker_device_cgroup_rulestelegraf2_docker_device_cgroup_rules
# Type: list
telegraf_role_docker_device_cgroup_rules:
# Type: list
telegraf2_docker_device_cgroup_rules:
telegraf_role_docker_device_read_bpstelegraf2_docker_device_read_bps
# Type: list
telegraf_role_docker_device_read_bps:
# Type: list
telegraf2_docker_device_read_bps:
telegraf_role_docker_device_read_iopstelegraf2_docker_device_read_iops
# Type: list
telegraf_role_docker_device_read_iops:
# Type: list
telegraf2_docker_device_read_iops:
telegraf_role_docker_device_requeststelegraf2_docker_device_requests
# Type: list
telegraf_role_docker_device_requests:
# Type: list
telegraf2_docker_device_requests:
telegraf_role_docker_device_write_bpstelegraf2_docker_device_write_bps
# Type: list
telegraf_role_docker_device_write_bps:
# Type: list
telegraf2_docker_device_write_bps:
telegraf_role_docker_device_write_iopstelegraf2_docker_device_write_iops
# Type: list
telegraf_role_docker_device_write_iops:
# Type: list
telegraf2_docker_device_write_iops:
telegraf_role_docker_devicestelegraf2_docker_devices
# Type: list
telegraf_role_docker_devices:
# Type: list
telegraf2_docker_devices:
telegraf_role_docker_devices_defaulttelegraf2_docker_devices_default
# Type: string
telegraf_role_docker_devices_default:
# Type: string
telegraf2_docker_devices_default:
telegraf_role_docker_groupstelegraf2_docker_groups
# Type: list
telegraf_role_docker_groups:
# Type: list
telegraf2_docker_groups:
telegraf_role_docker_privilegedtelegraf2_docker_privileged
# Type: bool (true/false)
telegraf_role_docker_privileged:
# Type: bool (true/false)
telegraf2_docker_privileged:
telegraf_role_docker_security_optstelegraf2_docker_security_opts
# Type: list
telegraf_role_docker_security_opts:
# Type: list
telegraf2_docker_security_opts:
telegraf_role_docker_usertelegraf2_docker_user
# Type: string
telegraf_role_docker_user:
# Type: string
telegraf2_docker_user:
telegraf_role_docker_userns_modetelegraf2_docker_userns_mode
# Type: string
telegraf_role_docker_userns_mode:
# Type: string
telegraf2_docker_userns_mode:

Networking

telegraf_role_docker_dns_optstelegraf2_docker_dns_opts
# Type: list
telegraf_role_docker_dns_opts:
# Type: list
telegraf2_docker_dns_opts:
telegraf_role_docker_dns_search_domainstelegraf2_docker_dns_search_domains
# Type: list
telegraf_role_docker_dns_search_domains:
# Type: list
telegraf2_docker_dns_search_domains:
telegraf_role_docker_dns_serverstelegraf2_docker_dns_servers
# Type: list
telegraf_role_docker_dns_servers:
# Type: list
telegraf2_docker_dns_servers:
telegraf_role_docker_domainnametelegraf2_docker_domainname
# Type: string
telegraf_role_docker_domainname:
# Type: string
telegraf2_docker_domainname:
telegraf_role_docker_exposed_portstelegraf2_docker_exposed_ports
# Type: list
telegraf_role_docker_exposed_ports:
# Type: list
telegraf2_docker_exposed_ports:
telegraf_role_docker_hoststelegraf2_docker_hosts
# Type: dict
telegraf_role_docker_hosts:
# Type: dict
telegraf2_docker_hosts:
telegraf_role_docker_hosts_use_commontelegraf2_docker_hosts_use_common
# Type: bool (true/false)
telegraf_role_docker_hosts_use_common:
# Type: bool (true/false)
telegraf2_docker_hosts_use_common:
telegraf_role_docker_ipc_modetelegraf2_docker_ipc_mode
# Type: string
telegraf_role_docker_ipc_mode:
# Type: string
telegraf2_docker_ipc_mode:
telegraf_role_docker_linkstelegraf2_docker_links
# Type: list
telegraf_role_docker_links:
# Type: list
telegraf2_docker_links:
telegraf_role_docker_network_modetelegraf2_docker_network_mode
# Type: string
telegraf_role_docker_network_mode:
# Type: string
telegraf2_docker_network_mode:
telegraf_role_docker_pid_modetelegraf2_docker_pid_mode
# Type: string
telegraf_role_docker_pid_mode:
# Type: string
telegraf2_docker_pid_mode:
telegraf_role_docker_portstelegraf2_docker_ports
# Type: list
telegraf_role_docker_ports:
# Type: list
telegraf2_docker_ports:
telegraf_role_docker_utstelegraf2_docker_uts
# Type: string
telegraf_role_docker_uts:
# Type: string
telegraf2_docker_uts:

Storage

telegraf_role_docker_keep_volumestelegraf2_docker_keep_volumes
# Type: bool (true/false)
telegraf_role_docker_keep_volumes:
# Type: bool (true/false)
telegraf2_docker_keep_volumes:
telegraf_role_docker_mountstelegraf2_docker_mounts
# Type: list
telegraf_role_docker_mounts:
# Type: list
telegraf2_docker_mounts:
telegraf_role_docker_storage_optstelegraf2_docker_storage_opts
# Type: dict
telegraf_role_docker_storage_opts:
# Type: dict
telegraf2_docker_storage_opts:
telegraf_role_docker_tmpfstelegraf2_docker_tmpfs
# Type: list
telegraf_role_docker_tmpfs:
# Type: list
telegraf2_docker_tmpfs:
telegraf_role_docker_volume_drivertelegraf2_docker_volume_driver
# Type: string
telegraf_role_docker_volume_driver:
# Type: string
telegraf2_docker_volume_driver:
telegraf_role_docker_volumes_fromtelegraf2_docker_volumes_from
# Type: list
telegraf_role_docker_volumes_from:
# Type: list
telegraf2_docker_volumes_from:
telegraf_role_docker_volumes_globaltelegraf2_docker_volumes_global
# Type: bool (true/false)
telegraf_role_docker_volumes_global:
# Type: bool (true/false)
telegraf2_docker_volumes_global:
telegraf_role_docker_working_dirtelegraf2_docker_working_dir
# Type: string
telegraf_role_docker_working_dir:
# Type: string
telegraf2_docker_working_dir:

Monitoring & Lifecycle

telegraf_role_docker_auto_removetelegraf2_docker_auto_remove
# Type: bool (true/false)
telegraf_role_docker_auto_remove:
# Type: bool (true/false)
telegraf2_docker_auto_remove:
telegraf_role_docker_cleanuptelegraf2_docker_cleanup
# Type: bool (true/false)
telegraf_role_docker_cleanup:
# Type: bool (true/false)
telegraf2_docker_cleanup:
telegraf_role_docker_force_killtelegraf2_docker_force_kill
# Type: string
telegraf_role_docker_force_kill:
# Type: string
telegraf2_docker_force_kill:
telegraf_role_docker_healthchecktelegraf2_docker_healthcheck
# Type: dict
telegraf_role_docker_healthcheck:
# Type: dict
telegraf2_docker_healthcheck:
telegraf_role_docker_healthy_wait_timeouttelegraf2_docker_healthy_wait_timeout
# Type: int
telegraf_role_docker_healthy_wait_timeout:
# Type: int
telegraf2_docker_healthy_wait_timeout:
telegraf_role_docker_inittelegraf2_docker_init
# Type: bool (true/false)
telegraf_role_docker_init:
# Type: bool (true/false)
telegraf2_docker_init:
telegraf_role_docker_kill_signaltelegraf2_docker_kill_signal
# Type: string
telegraf_role_docker_kill_signal:
# Type: string
telegraf2_docker_kill_signal:
telegraf_role_docker_log_drivertelegraf2_docker_log_driver
# Type: string
telegraf_role_docker_log_driver:
# Type: string
telegraf2_docker_log_driver:
telegraf_role_docker_log_optionstelegraf2_docker_log_options
# Type: dict
telegraf_role_docker_log_options:
# Type: dict
telegraf2_docker_log_options:
telegraf_role_docker_oom_killertelegraf2_docker_oom_killer
# Type: bool (true/false)
telegraf_role_docker_oom_killer:
# Type: bool (true/false)
telegraf2_docker_oom_killer:
telegraf_role_docker_oom_score_adjtelegraf2_docker_oom_score_adj
# Type: int
telegraf_role_docker_oom_score_adj:
# Type: int
telegraf2_docker_oom_score_adj:
telegraf_role_docker_output_logstelegraf2_docker_output_logs
# Type: bool (true/false)
telegraf_role_docker_output_logs:
# Type: bool (true/false)
telegraf2_docker_output_logs:
telegraf_role_docker_pausedtelegraf2_docker_paused
# Type: bool (true/false)
telegraf_role_docker_paused:
# Type: bool (true/false)
telegraf2_docker_paused:
telegraf_role_docker_recreatetelegraf2_docker_recreate
# Type: bool (true/false)
telegraf_role_docker_recreate:
# Type: bool (true/false)
telegraf2_docker_recreate:
telegraf_role_docker_restart_retriestelegraf2_docker_restart_retries
# Type: int
telegraf_role_docker_restart_retries:
# Type: int
telegraf2_docker_restart_retries:
telegraf_role_docker_stop_timeouttelegraf2_docker_stop_timeout
# Type: int
telegraf_role_docker_stop_timeout:
# Type: int
telegraf2_docker_stop_timeout:

Other Options

telegraf_role_docker_capabilitiestelegraf2_docker_capabilities
# Type: list
telegraf_role_docker_capabilities:
# Type: list
telegraf2_docker_capabilities:
telegraf_role_docker_cgroup_parenttelegraf2_docker_cgroup_parent
# Type: string
telegraf_role_docker_cgroup_parent:
# Type: string
telegraf2_docker_cgroup_parent:
telegraf_role_docker_commandstelegraf2_docker_commands
# Type: list
telegraf_role_docker_commands:
# Type: list
telegraf2_docker_commands:
telegraf_role_docker_create_timeouttelegraf2_docker_create_timeout
# Type: int
telegraf_role_docker_create_timeout:
# Type: int
telegraf2_docker_create_timeout:
telegraf_role_docker_entrypointtelegraf2_docker_entrypoint
# Type: string
telegraf_role_docker_entrypoint:
# Type: string
telegraf2_docker_entrypoint:
telegraf_role_docker_env_filetelegraf2_docker_env_file
# Type: string
telegraf_role_docker_env_file:
# Type: string
telegraf2_docker_env_file:
telegraf_role_docker_labelstelegraf2_docker_labels
# Type: dict
telegraf_role_docker_labels:
# Type: dict
telegraf2_docker_labels:
telegraf_role_docker_labels_use_commontelegraf2_docker_labels_use_common
# Type: bool (true/false)
telegraf_role_docker_labels_use_common:
# Type: bool (true/false)
telegraf2_docker_labels_use_common:
telegraf_role_docker_read_onlytelegraf2_docker_read_only
# Type: bool (true/false)
telegraf_role_docker_read_only:
# Type: bool (true/false)
telegraf2_docker_read_only:
telegraf_role_docker_runtimetelegraf2_docker_runtime
# Type: string
telegraf_role_docker_runtime:
# Type: string
telegraf2_docker_runtime:
telegraf_role_docker_sysctlstelegraf2_docker_sysctls
# Type: list
telegraf_role_docker_sysctls:
# Type: list
telegraf2_docker_sysctls:
telegraf_role_docker_ulimitstelegraf2_docker_ulimits
# Type: list
telegraf_role_docker_ulimits:
# Type: list
telegraf2_docker_ulimits:
telegraf_role_autoheal_enabledtelegraf2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
telegraf_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
telegraf2_autoheal_enabled: true
telegraf_role_depends_ontelegraf2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
telegraf_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
telegraf2_depends_on: ""
telegraf_role_depends_on_delaytelegraf2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
telegraf_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
telegraf2_depends_on_delay: "0"
telegraf_role_depends_on_healthcheckstelegraf2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
telegraf_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
telegraf2_depends_on_healthchecks:
telegraf_role_diun_enabledtelegraf2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
telegraf_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
telegraf2_diun_enabled: true
telegraf_role_dns_enabledtelegraf2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
telegraf_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
telegraf2_dns_enabled: true
telegraf_role_docker_controllertelegraf2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
telegraf_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
telegraf2_docker_controller: true
telegraf_role_docker_image_repotelegraf2_docker_image_repo
# Type: string
telegraf_role_docker_image_repo:
# Type: string
telegraf2_docker_image_repo:
telegraf_role_docker_image_tagtelegraf2_docker_image_tag
# Type: string
telegraf_role_docker_image_tag:
# Type: string
telegraf2_docker_image_tag:
telegraf_role_docker_volumes_downloadtelegraf2_docker_volumes_download
# Type: bool (true/false)
telegraf_role_docker_volumes_download:
# Type: bool (true/false)
telegraf2_docker_volumes_download:
telegraf_role_themepark_addonstelegraf2_themepark_addons
# Type: string
telegraf_role_themepark_addons:
# Type: string
telegraf2_themepark_addons:
telegraf_role_themepark_apptelegraf2_themepark_app
# Type: string
telegraf_role_themepark_app:
# Type: string
telegraf2_themepark_app:
telegraf_role_themepark_themetelegraf2_themepark_theme
# Type: string
telegraf_role_themepark_theme:
# Type: string
telegraf2_themepark_theme:
telegraf_role_traefik_api_endpointtelegraf2_traefik_api_endpoint
# Type: dict/omit
telegraf_role_traefik_api_endpoint:
# Type: dict/omit
telegraf2_traefik_api_endpoint:
telegraf_role_traefik_api_middlewaretelegraf2_traefik_api_middleware
# Type: string
telegraf_role_traefik_api_middleware:
# Type: string
telegraf2_traefik_api_middleware:
telegraf_role_traefik_api_middleware_httptelegraf2_traefik_api_middleware_http
# Type: string
telegraf_role_traefik_api_middleware_http:
# Type: string
telegraf2_traefik_api_middleware_http:
telegraf_role_traefik_autodetect_enabledtelegraf2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
telegraf_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
telegraf2_traefik_autodetect_enabled: false
telegraf_role_traefik_certresolvertelegraf2_traefik_certresolver
# Type: string
telegraf_role_traefik_certresolver:
# Type: string
telegraf2_traefik_certresolver:
telegraf_role_traefik_crowdsec_enabledtelegraf2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
telegraf_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
telegraf2_traefik_crowdsec_enabled: false
telegraf_role_traefik_error_pages_enabledtelegraf2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
telegraf_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
telegraf2_traefik_error_pages_enabled: false
telegraf_role_traefik_gzip_enabledtelegraf2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
telegraf_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
telegraf2_traefik_gzip_enabled: false
telegraf_role_traefik_middleware_httptelegraf2_traefik_middleware_http
# Type: string
telegraf_role_traefik_middleware_http:
# Type: string
telegraf2_traefik_middleware_http:
telegraf_role_traefik_middleware_http_api_insecuretelegraf2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
telegraf_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
telegraf2_traefik_middleware_http_api_insecure:
telegraf_role_traefik_middleware_http_insecuretelegraf2_traefik_middleware_http_insecure
# Type: bool (true/false)
telegraf_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
telegraf2_traefik_middleware_http_insecure:
telegraf_role_traefik_prioritytelegraf2_traefik_priority
# Type: string
telegraf_role_traefik_priority:
# Type: string
telegraf2_traefik_priority:
telegraf_role_traefik_robot_enabledtelegraf2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
telegraf_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
telegraf2_traefik_robot_enabled: true
telegraf_role_traefik_tailscale_enabledtelegraf2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
telegraf_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
telegraf2_traefik_tailscale_enabled: false
telegraf_role_traefik_wildcard_enabledtelegraf2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
telegraf_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
telegraf2_traefik_wildcard_enabled: true
telegraf_role_web_domaintelegraf2_web_domain
# Type: string
telegraf_role_web_domain:
# Type: string
telegraf2_web_domain:
telegraf_role_web_fqdn_overridetelegraf2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
telegraf_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
telegraf2_web_fqdn_override:

Example Override

telegraf_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "telegraf2.{{ user.domain }}"
  - "telegraf.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

Example Override

telegraf2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "telegraf2.{{ user.domain }}"
  - "telegraf.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

telegraf_role_web_host_overridetelegraf2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
telegraf_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
telegraf2_web_host_override:

Example Override

telegraf_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'telegraf2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

Example Override

telegraf2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'telegraf2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

telegraf_role_web_http_porttelegraf2_web_http_port
# Type: string (quoted number)
telegraf_role_web_http_port:
# Type: string (quoted number)
telegraf2_web_http_port:
telegraf_role_web_http_schemetelegraf2_web_http_scheme
# Type: string ("http"/"https")
telegraf_role_web_http_scheme:
# Type: string ("http"/"https")
telegraf2_web_http_scheme:
telegraf_role_web_http_serverstransporttelegraf2_web_http_serverstransport
# Type: dict/omit
telegraf_role_web_http_serverstransport:
# Type: dict/omit
telegraf2_web_http_serverstransport:
telegraf_role_web_schemetelegraf2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
telegraf_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
telegraf2_web_scheme:
telegraf_role_web_serverstransporttelegraf2_web_serverstransport
# Type: dict/omit
telegraf_role_web_serverstransport:
# Type: dict/omit
telegraf2_web_serverstransport:
telegraf_role_web_subdomaintelegraf2_web_subdomain
# Type: string
telegraf_role_web_subdomain:
# Type: string
telegraf2_web_subdomain: