prometheus.prometheus._common role

Note

This role is part of the prometheus.prometheus collection (version 0.23.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install prometheus.prometheus.

To use it in a playbook, specify: prometheus.prometheus._common.

Entry point configure – Internal only - common configuration tasks

Synopsis

  • Internal only - selinux requirements

Parameters

Parameter

Comments

_common_common_basic_auth_users

string

Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.

Default: ""

_common_config_dir

string

Path to directory to install configuration.

Default: ""

_common_http_server_config

string

Configuration for HTTP/2 support.

Default: ""

_common_service_name

string

Name of the system service (systemd)

Usually matches the role name

Default: "{{ ansible_parent_role_names | first | regex_replace(ansible_collection_name ~ '.', '') }}"

_common_system_group

string

User group for the system user.

Default: ""

_common_system_user

string

System user for running the service.

Default: ""

_common_tls_server_config

string

Configuration for TLS authentication.

Default: ""

Authors

  • Prometheus Community

Entry point install – Internal only - common installation tasks

Synopsis

  • Internal only - selinux requirements

Parameters

Parameter

Comments

_common_binaries

list / elements=string

List of binaries to install

Default: []

_common_binary_install_dir

string

Directory to install binaries

Default: ""

_common_binary_name

string

Name of main binary

Default: "{{ __common_binary_basename }}"

_common_binary_unarchive_opts

list / elements=string

Extra options to pass to binary unarchive task

Default: []

_common_binary_url

string

URL of the binaries to install

Default: ""

_common_checksums_url

string

URL of the checksums file for the binaries

Default: ""

_common_config_dir

string

Path to the configuration dir

Default: ""

_common_local_cache_path

string

Local path to stash the archive and its extraction

Default: ""

_common_system_group

string

User group for the system user.

Default: ""

_common_system_user

string

System user for running the service.

Default: ""

Authors

  • Prometheus Community

Entry point preflight – Internal only - common preflight tasks

Synopsis

  • Internal only - selinux requirements

Parameters

Parameter

Comments

_common_dependencies

string

Package dependencies to install

Default: "{% if (ansible_pkg_mgr == 'apt') %}{{ ('python-apt' if ansible_python_version is version('3', '<') else 'python3-apt') }} {% else %}{% endif %}"

_common_web_listen_address

string

Address on which to listen

Default: ""

Authors

  • Prometheus Community

Entry point selinux – Internal only - common selinux configuration tasks

Synopsis

  • Internal only - selinux requirements

Parameters

Parameter

Comments

_common_selinux_port

string

Port to allow in SELinux

Authors

  • Prometheus Community