-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
meta/argument_specs.yml file (#23)
- Loading branch information
1 parent
38fbe24
commit f52dc3c
Showing
3 changed files
with
122 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| --- | ||
| argument_specs: | ||
| main: | ||
| short_description: 'Postgres Exporter' | ||
| description: | ||
| - 'An Ansible role to install, configure and update the L(Postgres Exporter,https://github.com/prometheus-community/postgres_exporter).' | ||
| author: | ||
| - 'Melekhin Anton' | ||
| options: | ||
| postgres_exporter_version: | ||
| type: 'str' | ||
| description: 'The version of Postgres Exporter to install.' | ||
| default: '0.15.0' | ||
| postgres_exporter_archive_name: | ||
| type: 'str' | ||
| description: 'The Postgres Exporter archive name without an extension.' | ||
| default: 'postgres_exporter-{{ postgres_exporter_version }}.{{ __postgres_exporter_os }}-{{ __postgres_exporter_architecture }}' | ||
| postgres_exporter_download_url: | ||
| type: 'str' | ||
| description: 'The Postgres Exporter archive download URL.' | ||
| default: 'https://github.com/prometheus-community/postgres_exporter/releases/download/v{{ postgres_exporter_version }}' | ||
| postgres_exporter_checksum_url: | ||
| type: 'str' | ||
| description: 'The Postgres Exporter checksum file URL.' | ||
| default: '{{ postgres_exporter_download_url }}/sha256sums.txt' | ||
| postgres_exporter_download_path: | ||
| type: 'path' | ||
| description: 'Local path to download and extract the archive.' | ||
| default: '/tmp' | ||
| postgres_exporter_user: | ||
| type: 'str' | ||
| description: 'System user that will be created.' | ||
| default: 'postgres_exporter' | ||
| postgres_exporter_group: | ||
| type: 'str' | ||
| description: 'System group that will be created.' | ||
| default: '{{ postgres_exporter_user }}' | ||
| postgres_exporter_install_path: | ||
| type: 'path' | ||
| description: 'The Postgres Exporter installation directory.' | ||
| default: '{{ __postgres_exporter_install_path }}' | ||
| postgres_exporter_config_path: | ||
| type: 'path' | ||
| description: 'The Postgres Exporter directory, that contains the PostgreSQL connection settings.' | ||
| default: '{{ __postgres_exporter_config_path }}' | ||
| postgres_exporter_data_source_name: | ||
| type: 'str' | ||
| description: 'Accepts URI form and key=value form arguments. The URI may contain the username and password to connect with.' | ||
| default: '{{ __postgres_exporter_data_source_name }}' | ||
| postgres_exporter_data_source_uri: | ||
| type: 'str' | ||
| description: | ||
| - 'I(Only for Linux)' | ||
| - 'An alternative to C(postgres_exporter_data_source_name) which exclusively accepts the hostname without a username and password component.' | ||
| postgres_exporter_data_source_user: | ||
| type: 'str' | ||
| description: | ||
| - 'I(Only for Linux)' | ||
| - 'When using C(postgres_exporter_data_source_uri), this variable is used to specify the username.' | ||
| postgres_exporter_data_source_pass: | ||
| type: 'str' | ||
| description: | ||
| - 'I(Only for Linux)' | ||
| - 'When using C(postgres_exporter_data_source_uri), this variable is used to specify the password to connect with.' | ||
| postgres_exporter_web_listen_address: | ||
| type: 'str' | ||
| description: 'The address to listen for the web interface and telemetry.' | ||
| default: '0.0.0.0' | ||
| postgres_exporter_web_listen_port: | ||
| type: 'int' | ||
| description: 'The port number that Postgres Exporter listens on.' | ||
| default: 9187 | ||
| postgres_exporter_web_telemetry_path: | ||
| type: 'str' | ||
| description: 'The path to expose metrics.' | ||
| default: '/metrics' | ||
| postgres_exporter_collectors: | ||
| type: 'list' | ||
| elements: 'str' | ||
| description: 'A list of collectors to use.' | ||
| default: [] | ||
| postgres_exporter_disable_default_metrics: | ||
| type: 'bool' | ||
| description: 'Use only metrics supplied from queries.yaml via C(postgres_exporter_extend_query_path).' | ||
| default: false | ||
| postgres_exporter_disable_settings_metrics: | ||
| type: 'bool' | ||
| description: "Use the flag if you don't want to scrape pg_settings." | ||
| default: false | ||
| postgres_exporter_extend_query_path: | ||
| type: 'path' | ||
| description: 'Path to a YAML file containing custom queries to run.' | ||
| postgres_exporter_log_level: | ||
| type: 'str' | ||
| description: 'The Postgres Exporter logging level.' | ||
| choices: | ||
| - 'debug' | ||
| - 'info' | ||
| - 'warn' | ||
| - 'error' | ||
| default: 'info' | ||
| postgres_exporter_log_format: | ||
| type: 'str' | ||
| description: 'A log message output format.' | ||
| choices: | ||
| - 'logfmt' | ||
| - 'json' | ||
| default: 'logfmt' | ||
| postgres_exporter_tls_server_config: | ||
| type: 'dict' | ||
| description: 'Certificate and key files for server to use to authenticate to client' | ||
| postgres_exporter_http_server_config: | ||
| type: 'dict' | ||
| description: 'Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.' | ||
| postgres_exporter_basic_auth_users: | ||
| type: 'dict' | ||
| description: 'Users and password for basic authentication. Passwords are automatically hashed with bcrypt.' |