Files
ansible-docker/roles/prometheus/meta/argument_specs.yml
2023-12-21 01:31:05 +02:00

143 lines
4.9 KiB
YAML

---
argument_specs:
main:
short_description: Prometheus docker container
options:
prometheus_scrape_interval:
description: Interval how often prometheus will scrape the monitoring targets
type: str
required: false
default: 5s
prometheus_evaluation_interval:
description: Interval how often prometheus will evaluate the scraped metrics against defined conditions
type: str
required: false
default: 15s
prometheus_storage_retention:
description: Period of time for which prometheus metrics are stored for. A number followed by unit (s, m, h, d, w, y)
type: str
required: false
default: 3650d
prometheus_hcloud_enabled:
description: Whether to use hcloud discovery
type: bool
required: false
default: false
prometheus_hcloud_token:
description: Access token for hetzner cloud service discovery.
type: str
required: "{{ prometheus_hcloud_enabled }}"
prometheus_hcloud_relabel_configs:
description: Relabel configs for hcloud
type: list
required: false
default: []
elements: dict
options:
source_labels:
type: list
required: true
elements: str
target_label:
type: str
required: true
replacement:
type: str
required: false
prometheus_install_grafana:
description: If true, installs grafana in the same docker network as prometheus and configures it with prometheus as data source
type: bool
required: false
default: false
prometheus_install_alertmanager:
description: If true, installs alertmanager in the same docker network as prometheus and configures it
type: bool
required: false
default: true
prometheus_install_webhook:
description: If true, installs webhook server in the same docker network as prometheus and configures it
type: bool
required: false
default: false
alertmanager_storage_retention:
description: Period of time for which alertmanager data is stored for. A number followed by unit (s, m, h, d, w, y). Passed directly to alertmanager role
type: str
required: false
default: "{{ prometheus_storage_retention | default('3650d') }}"
prometheus_webhook_handlers:
description: List of webhook server handlers
type: list
required: "{{ prometheus_install_webhook }}"
elements: dict
options:
id:
description: specifies the ID of your hook. This value is used to create the HTTP endpoint
type: str
required: true
execute-command:
description: specifies the command that should be executed when the hook is triggered
type: str
required: true
command-working-directory:
description: specifies the working directory that will be used for the script when it's executed
type: str
required: false
pass-arguments-to-command:
description: >
specifies the list of arguments that will be passed to the
command. See for more info:
https://github.com/adnanh/webhook/blob/master/docs/Referencing-Request-Values.md
type: list
required: false
elements: dict
options:
source:
description: Source of the argument. Use `string` to specify argument here.
type: str
required: true
choices:
- string
- header
- url
- request
- payload
name:
description: Argument if source is string, otherwise the source attribute name.
type: str
required: true
# All options after this will be passed directly to the container role
docker_service_suffix:
description: "Passed to container role"
required: false
docker_host_user:
description: "Passed to container role"
required: false
database_passwords:
description: "Passed to container role"
required: false
docker_additional_services:
description: "Passed to container role"
required: false
docker_volume_type:
description: "Passed to container role"
required: false
reverse_proxy_type:
description: "Passed to container role"
required: false
ports:
description: "Passed to container role"
required: false
docker_vhost_domains:
description: "Passed to container role"
required: false
docker_entrypoint:
description: "Passed to container role"
required: false