ansible/roles/cadvisor/meta/argument_specs.yml at d7a2c295b3b3eab6008eb739c00b31e04c87b9e9 · prometheus-community/ansible · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
---
# 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.56.2"
      cadvisor_binary_url:
        description: "URL of the cadvisor binary file"
        default: "https://github.com/{{ _cadvisor_repo }}/releases/download/v{{ cadvisor_version }}/cadvisor-v{{ cadvisor_version }}-{{ ansible_facts['system'] | lower }}-{{ _cadvisor_go_ansible_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:
          - "A list of metrics to be disabled"
          - "cAdvisor disables by 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
          - pressure
          - process
          - referenced_memory
          - resctrl
          - sched
          - tcp
          - udp
      cadvisor_enable_metrics:
        description: "A list of metrics to be enabled. If set, overrides 'cadvisor_disable_metrics'"
        default: []
        type: "list"
        choices: *metrics_choices
      cadvisor_store_container_labels:
        description: "store all container labels"
        type: "bool"
        default: true
      cadvisor_whitelisted_container_labels:
        description: "A list of container labels to be used as labels on prometheus metrics"
        default: []
        type: "list"
      cadvisor_env_metadata_whitelist:
        description: "A list of env variables to be used as labels on prometheus metrics"
        default: []
        type: "list"
      cadvisor_docker_only:
        description: "do not report raw cgroup metrics, except the root cgroup"
        type: "bool"
        default: false
      cadvisor_basic_auth_users:
        description:
          - "Dictionary of username / password for HTTP basic authentication"
          - >-
            Warning : The endpoints `/api/*` and `/metrics` are exposed without authentication. See https://github.com/google/cadvisor/blob/master/docs/web.md#web-ui-authentication and https://github.com/google/cadvisor/issues/3401 for more details.
        type: "dict"
        default: {}
      cadvisor_system_group:
        description:
          - "I(Advanced)"
          - "System group for cadvisor"
        default: "root"
      cadvisor_system_user:
        description:
          - "I(Advanced)"
          - "cAdvisor user"
        default: "root"
      cadvisor_binary_install_dir:
        description:
          - "I(Advanced)"
          - "Directory to install binaries"
        default: "/usr/local/bin"
      cadvisor_local_cache_path:
        description: 'Local path to stash the archive and its extraction'
        default: "/tmp/cadvisor-{{ ansible_facts['system'] | lower }}-{{ _cadvisor_go_ansible_arch }}/{{ cadvisor_version }}"
      cadvisor_housekeeping_interval:
        description: 'Interval between container housekeepings'
        default: '10s'
      cadvisor_max_housekeeping_interval:
        description: 'Largest interval to allow between container housekeepings'
        default: '10s'
      cadvisor_config_dir:
        description: "Directory for cAdvisor configuration files"
        default: "/etc/cadvisor"