ansible-collection-prometheus/roles/cadvisor/meta/argument_specs.yml
github-actions[bot] ffa7ad9add
patch: 🎉 automated upstream release update (#317)
Signed-off-by: prombot <prometheus-team@googlegroups.com>
Co-authored-by: prombot <prometheus-team@googlegroups.com>
2024-03-20 16:45:30 +01:00

88 lines
3 KiB
YAML

---
# yamllint disable rule:line-length
argument_specs:
main:
short_description: "cAdvisor"
description:
- "Deploy L(cadvisor,https://github.com/google/cadvisor) using ansible"
author:
- "Prometheus Community"
options:
cadvisor_version:
description: "cAdvisor package version. Also accepts latest as parameter."
default: "0.49.1"
cadvisor_skip_install:
description: "cAdvisor installation tasks gets skipped when set to true."
type: bool
default: false
cadvisor_binary_local_dir:
description:
- "Enables the use of local packages instead of those distributed on github."
- "The parameter may be set to a directory where the C(cadvisor) binary is stored on the host where ansible is run."
- "This overrides the I(cadvisor_version) parameter"
cadvisor_binary_url:
description: "URL of the cadvisor binary file"
default: "https://github.com/{{ _cadvisor_repo }}/releases/download/v{{ cadvisor_version }}/cadvisor-{{ cadvisor_version }}-linux-{{ go_arch }}"
cadvisor_listen_ip:
description: "Address on which cadvisor will listen"
default: "0.0.0.0"
cadvisor_port:
description: "Port on which cadvisor will listen"
default: "8080"
cadvisor_prometheus_endpoint:
description: "Path under which to expose metrics"
default: "/metrics"
cadvisor_disable_metrics:
description:
- "comma-separated list of metrics to be disabled"
- "(default advtcp,cpu_topology,cpuset,hugetlb,memory_numa,process,referenced_memory,resctrl,sched,tcp,udp)"
type: "list"
default: []
choices: &metrics_choices
- advtcp
- app
- cpu
- cpuLoad
- cpu_topology
- cpuset
- disk
- diskIO
- hugetlb
- memory
- memory_numa
- network
- oom_event
- percpu
- perf_event
- process
- referenced_memory
- resctrl
- sched
- tcp
cadvisor_enable_metrics:
description: "comma-separated list of metrics to be enabled. If set, overrides 'cadvisor_disable_metrics'"
default: []
type: "list"
choices: *metrics_choices
cadvisor_docker_only:
description: "do not report raw cgroup metrics, except the root cgroup"
type: "bool"
default: false
cadvisor_binary_install_dir:
description:
- "I(Advanced)"
- "Directory to install cadvisor binary"
default: "/usr/local/bin"
cadvisor_system_group:
description:
- "I(Advanced)"
- "System group for cadvisor"
default: "root"
cadvisor_system_user:
description:
- "I(Advanced)"
- "cAdvisor user"
default: "root"
cadvisor_archive_path:
description: 'Local path to stash the archive and its extraction'
default: "/tmp"