prometheus.prometheus.pushgateway role – Prometheus Pushgateway

Note

This role is part of the prometheus.prometheus collection (version 0.7.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.pushgateway.

Entry point main – Prometheus Pushgateway

Synopsis

Parameters

Parameter

Comments

pushgateway_basic_auth_users

dictionary

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

pushgateway_binary_install_dir

string

Advanced

Directory to install pushgateway binary

Default: "/usr/local/bin"

pushgateway_binary_local_dir

string

Enables the use of local packages instead of those distributed on github.

The parameter may be set to a directory where the pushgateway binary is stored on the host where ansible is run.

This overrides the pushgateway_version parameter

pushgateway_binary_url

string

URL of the Pushgateway binaries .tar.gz file

Default: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"

pushgateway_checksums_url

string

URL of the Pushgateway checksums file

Default: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/sha256sums.txt"

pushgateway_http_server_config

dictionary

Config for HTTP/2 support.

Keys and values are the same as in pushgateway docs.

pushgateway_skip_install

boolean

Pushgateway installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

pushgateway_system_group

string

Advanced

System group for Pushgateway

Default: "pushgateway"

pushgateway_system_user

string

Advanced

Pushgateway user

Default: "pushgateway"

pushgateway_tls_server_config

dictionary

Configuration for TLS authentication.

Keys and values are the same as in pushgateway docs.

pushgateway_version

string

Pushgateway package version. Also accepts latest as parameter.

Default: "1.6.2"

pushgateway_web_listen_address

string

Address on which Pushgateway will listen

Default: "0.0.0.0:9091"

pushgateway_web_telemetry_path

string

Path under which to expose metrics

Default: "/metrics"

Authors

  • Prometheus Community