--- # .. vim: foldmarker=[[[,]]]:foldmethod=marker # ipr-cnrs.netdata default variables [[[ # ====================================== # Packages and installation [[[ # ----------------------------- # .. envvar:: netdata__base_packages [[[ # # List of base packages to install. netdata__base_packages: - 'netdata' # ]]] # .. envvar:: netdata__install_recommends [[[ # # If recommended packages should be install ? Possible options : # # ``True`` # Default. Ensure all probes can work. # # ``False`` # netdata__install_recommends: True # ]]] # .. envvar:: netdata__deploy_state [[[ # # What is the desired state which this role should achieve ? Possible options : # # ``present`` # Default. Ensure that netdata is installed and configured as requested. # # ``absent`` # Ensure that netdata is uninstalled and it's configuration is removed. # netdata__deploy_state: 'present' # ]]] # .. envvar:: netdata__service_name [[[ # # The service name to manage. # netdata__service_name: 'netdata' # ]]] # .. envvar:: netdata__service_manage [[[ # # If the Netdata service should be managed ? Possible options : # # ``True`` # Default. The service is started and enabled. # # ``False`` # The service is disabled from startup. # netdata__service_manage: True # ]]] # ]]] # Common configuration [[[ # ----------------------------- # .. envvar:: netdata__group_name [[[. # # Name of the directory which contains configuration files which should be # generated on hosts in a specific group. This variable needs to be set on a # group level in the inventory to take effect. Only one group is supported at # a time. netdata__group_name: 'nonexistent-host-group' # ]]] # .. envvar:: netdata__default_etc_src [[[. # # Directory which contains configuration files from this role that should be # managed on all hosts. netdata__default_etc_src: '../templates/etc/netdata' # ]]] # .. envvar:: netdata__etc_src [[[. # # Directory which contains configuration files that should be managed on all # hosts in the Ansible inventory. # # Must be a relative path to group directory of this role or to your # ansible inventory directory. netdata__etc_src: '{{ (inventory_dir | realpath + "/../resources/") + "files/by-group/all/etc/netdata/" }}' # ]]] # .. envvar:: netdata__group_etc_src [[[. # # Directory which contains configuration files for Netdata that should be # managed on hosts in a specific Ansible inventory group. # # Must be a relative path to Netdata group directory on your Ansible inventory # directory. netdata__group_etc_src: '{{ (inventory_dir | realpath + "/../resources/") + "files/by-group/" + netdata__group_name + "/etc/netdata" }}' # ]]] # .. envvar:: netdata__host_etc_src [[[. # # Directory which contains configuration files for Netdata that should be # managed on specific host in the Ansible inventory for Netdata. # # Must be a relative path to Netdata configuration directory for these hosts in # your Ansible inventory directory. netdata__host_etc_src: '{{ (inventory_dir | realpath + "/../resources/") + "files/by-host/" + inventory_hostname + "/etc/netdata" }}' # ]]] # .. envvar:: netdata__conf_bind_ip [[[. # # IP address Netdata will listen to. # netdata__conf_bind_ip: '127.0.0.1' # ]]] # .. envvar:: netdata__conf_bind_port [[[. # # Port Netdata will listen to. # netdata__conf_bind_port: '19999' # ]]] # .. envvar:: netdata__conf_memory_mode [[[. # # The memory mode of the database. # # Check the possible options on Netdata wiki : # https://github.com/firehol/netdata/wiki/Memory-Requirements#memory-modes # netdata__conf_memory_mode: 'ram' # ]]] # ]]] # Registry configuration [[[ # ----------------------------- # .. envvar:: netdata__registry_enable [[[. # # If node should be a registry. Possible options : # # ``False`` # Default. # # ``True`` # See https://github.com/firehol/netdata/wiki/mynetdata-menu-item#what-is-the-registry # netdata__registry_enable: False # ]]] # .. envvar:: netdata__registry_announce [[[. # # The URL of the registry. # # Default empty, so the default one will be used (https://registry.my-netdata.io). # netdata__registry_announce: '' # ]]] # .. envvar:: netdata__registry_hostname [[[. # # The server name to display on the registry (max 50. char). # netdata__registry_hostname: '{{ ansible_hostname }}' # ]]] # ]]] # Slave configuration [[[ # ----------------------------- # .. envvar:: netdata__slave_enable [[[. # # If node should send metrics to a master. Possible options : # # # ``False`` # Default. # # ``True`` # netdata__slave_enable: False # ]]] # .. envvar:: netdata__slave_destination [[[. # # The destination to send metrics to. # https://github.com/firehol/netdata/wiki/Replication-Overview#options-for-the-sending-node # netdata__slave_destination: 'netdata.{{ ansible_domain }}' # ]]] # .. envvar:: netdata__slave_api_key [[[. # # The API KEY to use (as the sender). # https://github.com/firehol/netdata/wiki/Replication-Overview#streaming-configuration # netdata__slave_api_key: '' # ]]] # .. envvar:: netdata__slave_buffer_size [[[. # # The buffer to use for sending metrics. # 1MB by default is good for 2-3 seconds of data. # netdata__slave_buffer_size: '1048576' # ]]] # .. envvar:: netdata__slave_reconnect [[[. # # If the connection fails, or it disconnects, retry after that many seconds. # netdata__slave_reconnect: '5' # ]]] # ]]] # Master configuration [[[ # ----------------------------- # .. envvar:: netdata__master_enable [[[. # # If node should receive metrics from other nodes. Possible options : # # ``False`` # Default. # # ``True`` # netdata__master_enable: False # ]]] # .. envvar:: netdata__master_api_key [[[. # # The API key to authenticate slaves. # netdata__master_api_key: '' # ]]] # .. envvar:: netdata__master_history [[[. # # The number of entries in the database per hosts. # netdata__master_history: '3600' # ]]] # .. envvar:: netdata__master_memory_mode [[[. # # The memory mode to be used for all hosts using this API key. # https://github.com/firehol/netdata/wiki/Memory-Requirements#memory-modes # netdata__master_memory_mode: 'ram' # ]]] # .. envvar:: netdata__master_health_alarm [[[. # # Shall the master send alarms for hosts using the API key. Possible options : # # ``auto`` # Default. Enable alarms, only when the sending Netdata is connected. # # ``yes`` # Enable alarms. # # ``no`` # Do not enable alarms netdata__master_health_alarm: 'auto' # ]]] # ]]]