cAdvisor

Description / name	Input element
Your domain name

Overview

cAdvisor is an open-source monitoring tool to collect, aggregate, process, and export resource usage and performance characteristics of running containers.

Manual

Releases

Community

---

Deployment

sb install cadvisor

Usage

Visit https://cadvisor.iYOUR_DOMAIN_NAMEi.

Basics

cAdvisor automatically monitors all Docker containers on your system. No additional configuration is required. The web interface provides resource usage, performance metrics, and container information.

cAdvisor is often used with Prometheus and Grafana for advanced metrics collection and visualization.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   cadvisor_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

cadvisor_name

# Type: string
cadvisor_name: cadvisor

cadvisor_role_web_subdomain

# Type: string
cadvisor_role_web_subdomain: "{{ cadvisor_name }}"

cadvisor_role_web_domain

# Type: string
cadvisor_role_web_domain: "{{ user.domain }}"

cadvisor_role_web_port

# Type: string
cadvisor_role_web_port: "8080"

cadvisor_role_web_url

# Type: string
cadvisor_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='cadvisor') + '.' + lookup('role_var', '_web_domain', role='cadvisor')
                        if (lookup('role_var', '_web_subdomain', role='cadvisor') | length > 0)
                        else lookup('role_var', '_web_domain', role='cadvisor')) }}"

cadvisor_role_dns_record

# Type: string
cadvisor_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='cadvisor') }}"

cadvisor_role_dns_zone

# Type: string
cadvisor_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='cadvisor') }}"

cadvisor_role_dns_proxy

# Type: bool (true/false)
cadvisor_role_dns_proxy: "{{ dns_proxied }}"

cadvisor_role_traefik_sso_middleware

# Type: string
cadvisor_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

cadvisor_role_traefik_middleware_default

# Type: string
cadvisor_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

cadvisor_role_traefik_middleware_custom

# Type: string
cadvisor_role_traefik_middleware_custom: ""

cadvisor_role_traefik_certresolver

# Type: string
cadvisor_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

cadvisor_role_traefik_enabled

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

cadvisor_role_traefik_api_enabled

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

cadvisor_role_traefik_api_endpoint

# Type: string
cadvisor_role_traefik_api_endpoint: ""

Container

cadvisor_role_docker_container

# Type: string
cadvisor_role_docker_container: "{{ cadvisor_name }}"

Image

cadvisor_role_docker_image_pull

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

cadvisor_role_docker_image_repo

# Type: string
cadvisor_role_docker_image_repo: "gcr.io/cadvisor/cadvisor"

cadvisor_role_docker_image_tag

# Type: string
cadvisor_role_docker_image_tag: "latest"

cadvisor_role_docker_image

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

Envs

cadvisor_role_docker_envs_default

# Type: dict
cadvisor_role_docker_envs_default:
  TZ: "{{ tz }}"

cadvisor_role_docker_envs_custom

# Type: dict
cadvisor_role_docker_envs_custom: {}

Volumes

cadvisor_role_docker_volumes_default

# Type: list
cadvisor_role_docker_volumes_default:
  - "/:/rootfs:ro"
  - "/var/run:/var/run:ro"
  - "/sys:/sys:ro"
  - "/var/lib/docker/:/var/lib/docker:ro"
  - "/dev/disk/:/dev/disk:ro"

cadvisor_role_docker_volumes_custom

# Type: list
cadvisor_role_docker_volumes_custom: []

Hostname

cadvisor_role_docker_hostname

# Type: string
cadvisor_role_docker_hostname: "{{ cadvisor_name }}"

Networks

cadvisor_role_docker_networks_alias

# Type: string
cadvisor_role_docker_networks_alias: "{{ cadvisor_name }}"

cadvisor_role_docker_networks_default

# Type: list
cadvisor_role_docker_networks_default: []

cadvisor_role_docker_networks_custom

# Type: list
cadvisor_role_docker_networks_custom: []

Restart Policy

cadvisor_role_docker_restart_policy

# Type: string
cadvisor_role_docker_restart_policy: unless-stopped

State

cadvisor_role_docker_state

# Type: string
cadvisor_role_docker_state: started

Privileged

cadvisor_role_docker_privileged

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

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

Resource Limits

cadvisor_role_docker_blkio_weight

# Type: int
cadvisor_role_docker_blkio_weight:

cadvisor_role_docker_cpu_period

# Type: int
cadvisor_role_docker_cpu_period:

cadvisor_role_docker_cpu_quota

# Type: int
cadvisor_role_docker_cpu_quota:

cadvisor_role_docker_cpu_shares

# Type: int
cadvisor_role_docker_cpu_shares:

cadvisor_role_docker_cpus

# Type: string
cadvisor_role_docker_cpus:

cadvisor_role_docker_cpuset_cpus

# Type: string
cadvisor_role_docker_cpuset_cpus:

cadvisor_role_docker_cpuset_mems

# Type: string
cadvisor_role_docker_cpuset_mems:

cadvisor_role_docker_kernel_memory

# Type: string
cadvisor_role_docker_kernel_memory:

cadvisor_role_docker_memory

# Type: string
cadvisor_role_docker_memory:

cadvisor_role_docker_memory_reservation

# Type: string
cadvisor_role_docker_memory_reservation:

cadvisor_role_docker_memory_swap

# Type: string
cadvisor_role_docker_memory_swap:

cadvisor_role_docker_memory_swappiness

# Type: int
cadvisor_role_docker_memory_swappiness:

cadvisor_role_docker_shm_size

# Type: string
cadvisor_role_docker_shm_size:

Security & Devices

cadvisor_role_docker_cap_drop

# Type: list
cadvisor_role_docker_cap_drop:

cadvisor_role_docker_cgroupns_mode

# Type: string
cadvisor_role_docker_cgroupns_mode:

cadvisor_role_docker_device_cgroup_rules

# Type: list
cadvisor_role_docker_device_cgroup_rules:

cadvisor_role_docker_device_read_bps

# Type: list
cadvisor_role_docker_device_read_bps:

cadvisor_role_docker_device_read_iops

# Type: list
cadvisor_role_docker_device_read_iops:

cadvisor_role_docker_device_requests

# Type: list
cadvisor_role_docker_device_requests:

cadvisor_role_docker_device_write_bps

# Type: list
cadvisor_role_docker_device_write_bps:

cadvisor_role_docker_device_write_iops

# Type: list
cadvisor_role_docker_device_write_iops:

cadvisor_role_docker_devices

# Type: list
cadvisor_role_docker_devices:

cadvisor_role_docker_devices_default

# Type: string
cadvisor_role_docker_devices_default:

cadvisor_role_docker_groups

# Type: list
cadvisor_role_docker_groups:

cadvisor_role_docker_security_opts

# Type: list
cadvisor_role_docker_security_opts:

cadvisor_role_docker_user

# Type: string
cadvisor_role_docker_user:

cadvisor_role_docker_userns_mode

# Type: string
cadvisor_role_docker_userns_mode:

Networking

cadvisor_role_docker_dns_opts

# Type: list
cadvisor_role_docker_dns_opts:

cadvisor_role_docker_dns_search_domains

# Type: list
cadvisor_role_docker_dns_search_domains:

cadvisor_role_docker_dns_servers

# Type: list
cadvisor_role_docker_dns_servers:

cadvisor_role_docker_domainname

# Type: string
cadvisor_role_docker_domainname:

cadvisor_role_docker_exposed_ports

# Type: list
cadvisor_role_docker_exposed_ports:

cadvisor_role_docker_hosts

# Type: dict
cadvisor_role_docker_hosts:

cadvisor_role_docker_hosts_use_common

# Type: bool (true/false)
cadvisor_role_docker_hosts_use_common:

cadvisor_role_docker_ipc_mode

# Type: string
cadvisor_role_docker_ipc_mode:

cadvisor_role_docker_links

# Type: list
cadvisor_role_docker_links:

cadvisor_role_docker_network_mode

# Type: string
cadvisor_role_docker_network_mode:

cadvisor_role_docker_pid_mode

# Type: string
cadvisor_role_docker_pid_mode:

cadvisor_role_docker_ports

# Type: list
cadvisor_role_docker_ports:

cadvisor_role_docker_uts

# Type: string
cadvisor_role_docker_uts:

Storage

cadvisor_role_docker_keep_volumes

# Type: bool (true/false)
cadvisor_role_docker_keep_volumes:

cadvisor_role_docker_mounts

# Type: list
cadvisor_role_docker_mounts:

cadvisor_role_docker_storage_opts

# Type: dict
cadvisor_role_docker_storage_opts:

cadvisor_role_docker_tmpfs

# Type: list
cadvisor_role_docker_tmpfs:

cadvisor_role_docker_volume_driver

# Type: string
cadvisor_role_docker_volume_driver:

cadvisor_role_docker_volumes_from

# Type: list
cadvisor_role_docker_volumes_from:

cadvisor_role_docker_volumes_global

# Type: bool (true/false)
cadvisor_role_docker_volumes_global:

cadvisor_role_docker_working_dir

# Type: string
cadvisor_role_docker_working_dir:

Monitoring & Lifecycle

cadvisor_role_docker_auto_remove

# Type: bool (true/false)
cadvisor_role_docker_auto_remove:

cadvisor_role_docker_cleanup

# Type: bool (true/false)
cadvisor_role_docker_cleanup:

cadvisor_role_docker_force_kill

# Type: string
cadvisor_role_docker_force_kill:

cadvisor_role_docker_healthcheck

# Type: dict
cadvisor_role_docker_healthcheck:

cadvisor_role_docker_healthy_wait_timeout

# Type: int
cadvisor_role_docker_healthy_wait_timeout:

cadvisor_role_docker_init

# Type: bool (true/false)
cadvisor_role_docker_init:

cadvisor_role_docker_kill_signal

# Type: string
cadvisor_role_docker_kill_signal:

cadvisor_role_docker_log_driver

# Type: string
cadvisor_role_docker_log_driver:

cadvisor_role_docker_log_options

# Type: dict
cadvisor_role_docker_log_options:

cadvisor_role_docker_oom_killer

# Type: bool (true/false)
cadvisor_role_docker_oom_killer:

cadvisor_role_docker_oom_score_adj

# Type: int
cadvisor_role_docker_oom_score_adj:

cadvisor_role_docker_output_logs

# Type: bool (true/false)
cadvisor_role_docker_output_logs:

cadvisor_role_docker_paused

# Type: bool (true/false)
cadvisor_role_docker_paused:

cadvisor_role_docker_recreate

# Type: bool (true/false)
cadvisor_role_docker_recreate:

cadvisor_role_docker_restart_retries

# Type: int
cadvisor_role_docker_restart_retries:

cadvisor_role_docker_stop_timeout

# Type: int
cadvisor_role_docker_stop_timeout:

Other Options

cadvisor_role_docker_capabilities

# Type: list
cadvisor_role_docker_capabilities:

cadvisor_role_docker_cgroup_parent

# Type: string
cadvisor_role_docker_cgroup_parent:

cadvisor_role_docker_commands

# Type: list
cadvisor_role_docker_commands:

cadvisor_role_docker_create_timeout

# Type: int
cadvisor_role_docker_create_timeout:

cadvisor_role_docker_entrypoint

# Type: string
cadvisor_role_docker_entrypoint:

cadvisor_role_docker_env_file

# Type: string
cadvisor_role_docker_env_file:

cadvisor_role_docker_labels

# Type: dict
cadvisor_role_docker_labels:

cadvisor_role_docker_labels_use_common

# Type: bool (true/false)
cadvisor_role_docker_labels_use_common:

cadvisor_role_docker_read_only

# Type: bool (true/false)
cadvisor_role_docker_read_only:

cadvisor_role_docker_runtime

# Type: string
cadvisor_role_docker_runtime:

cadvisor_role_docker_sysctls

# Type: list
cadvisor_role_docker_sysctls:

cadvisor_role_docker_ulimits

# Type: list
cadvisor_role_docker_ulimits:

cadvisor_role_autoheal_enabled

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

cadvisor_role_depends_on

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

cadvisor_role_depends_on_delay

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

cadvisor_role_depends_on_healthchecks

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

cadvisor_role_diun_enabled

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

cadvisor_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
cadvisor_role_dns_enabled: true

cadvisor_role_docker_controller

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

cadvisor_role_docker_image_repo

# Type: string
cadvisor_role_docker_image_repo:

cadvisor_role_docker_image_tag

# Type: string
cadvisor_role_docker_image_tag:

cadvisor_role_docker_volumes_download

# Type: bool (true/false)
cadvisor_role_docker_volumes_download:

cadvisor_role_themepark_addons

# Type: string
cadvisor_role_themepark_addons:

cadvisor_role_themepark_app

# Type: string
cadvisor_role_themepark_app:

cadvisor_role_themepark_theme

# Type: string
cadvisor_role_themepark_theme:

cadvisor_role_traefik_api_endpoint

# Type: dict/omit
cadvisor_role_traefik_api_endpoint:

cadvisor_role_traefik_api_middleware

# Type: string
cadvisor_role_traefik_api_middleware:

cadvisor_role_traefik_api_middleware_http

# Type: string
cadvisor_role_traefik_api_middleware_http:

cadvisor_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
cadvisor_role_traefik_autodetect_enabled: false

cadvisor_role_traefik_certresolver

# Type: string
cadvisor_role_traefik_certresolver:

cadvisor_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
cadvisor_role_traefik_crowdsec_enabled: false

cadvisor_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
cadvisor_role_traefik_error_pages_enabled: false

cadvisor_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
cadvisor_role_traefik_gzip_enabled: false

cadvisor_role_traefik_middleware_http

# Type: string
cadvisor_role_traefik_middleware_http:

cadvisor_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
cadvisor_role_traefik_middleware_http_api_insecure:

cadvisor_role_traefik_middleware_http_insecure

# Type: bool (true/false)
cadvisor_role_traefik_middleware_http_insecure:

cadvisor_role_traefik_priority

# Type: string
cadvisor_role_traefik_priority:

cadvisor_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
cadvisor_role_traefik_robot_enabled: true

cadvisor_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
cadvisor_role_traefik_tailscale_enabled: false

cadvisor_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
cadvisor_role_traefik_wildcard_enabled: true

cadvisor_role_web_domain

# Type: string
cadvisor_role_web_domain:

cadvisor_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
cadvisor_role_web_fqdn_override:

Example Override

cadvisor_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "cadvisor2.{{ user.domain }}"
  - "cadvisor.otherdomain.tld"

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

cadvisor_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
cadvisor_role_web_host_override:

Example Override

cadvisor_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'cadvisor2.' + user.domain }}`)"

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

cadvisor_role_web_http_port

# Type: string (quoted number)
cadvisor_role_web_http_port:

cadvisor_role_web_http_scheme

# Type: string ("http"/"https")
cadvisor_role_web_http_scheme:

cadvisor_role_web_http_serverstransport

# Type: dict/omit
cadvisor_role_web_http_serverstransport:

cadvisor_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
cadvisor_role_web_scheme:

cadvisor_role_web_serverstransport

# Type: dict/omit
cadvisor_role_web_serverstransport:

cadvisor_role_web_subdomain

# Type: string
cadvisor_role_web_subdomain: