Skip to content

Commit 5c614dc

Browse files
committed
docs(README): update variables documentation
1 parent c4ff726 commit 5c614dc

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Postgres Exporter
22
=================
33

4-
An Ansible role to install, configure and update [Postgres Exporter](https://github.com/prometheus-community/postgres_exporter).
4+
An Ansible role to install, configure and update the [Postgres Exporter](https://github.com/prometheus-community/postgres_exporter).
55

66
Requirements
77
------------
@@ -31,17 +31,22 @@ Requirements
3131
Role Variables
3232
--------------
3333

34-
- `postgres_exporter_version` The specific version of Postgres Exporter to download (default: `0.15.0`).
34+
Variables used to install the Postgres Exporter:
35+
36+
- `postgres_exporter_version` The version of Postgres Exporter to download (default: `0.15.0`).
3537
- `postgres_exporter_archive_name` Postgres Exporter archive name.
3638

3739
Defaults:
3840
- `postgres_exporter-0.15.0.linux-amd64` (Linux)
3941
- `postgres_exporter-0.15.0.windows-amd64` (Windows)
4042

4143
- `postgres_exporter_archive_extension` Postgres Exporter archive extension (default: `tar.gz`)
42-
- `postgres_exporter_download_url` URL to download an archive with Postgres Exporter (default: `https://github.com/prometheus-community/postgres_exporter/releases/download/v0.15.0`).
44+
- `postgres_exporter_download_url` URL to download the Postgres Exporter archive (default: `https://github.com/prometheus-community/postgres_exporter/releases/download/v0.15.0`).
45+
46+
Variables used to configure the Postgres Exporter:
47+
4348
- `postgres_exporter_user` and `postgres_exporter_group` Unix user and group that will be created (default: `postgres`).
44-
- `postgres_exporter_install_path` Path to Postgres Exporter installation directory (default: `/usr/local/bin`).
49+
- `postgres_exporter_install_path` The Postgres Exporter installation directory (default: `/usr/local/bin`).
4550
- `postgres_exporter_data_source_name` Accepts URI form and key=value form arguments. The URI may contain the username and password to connect with. (default: `user=postgres host=/var/run/postgresql/ sslmode=disable`).
4651
- `postgres_exporter_web_listen_address` Address to listen on for web interface and telemetry (default: `0.0.0.0`).
4752
- `postgres_exporter_web_listen_port` The port to bind to (default: `9187`).
@@ -75,7 +80,7 @@ None.
7580
Example Playbook
7681
----------------
7782

78-
Install and configure `Postgres Exporter`:
83+
Install and configure the Postgres Exporter:
7984

8085
```yaml
8186
---

0 commit comments

Comments
 (0)