https://github.com/rolehippie/alertmanager

Ansible role to install and configure Alertmanager
https://github.com/rolehippie/alertmanager

ansible ansible-role hacktoberfest role

Last synced: 4 months ago
JSON representation

Ansible role to install and configure Alertmanager

Host: GitHub
URL: https://github.com/rolehippie/alertmanager
Owner: rolehippie
License: apache-2.0
Created: 2020-12-17T12:05:49.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2026-02-26T18:13:17.000Z (4 months ago)
Last Synced: 2026-02-27T00:23:14.352Z (4 months ago)
Topics: ansible, ansible-role, hacktoberfest, role
Language: Jinja
Homepage:
Size: 373 KB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# alertmanager

[![Source Code](https://img.shields.io/badge/github-source%20code-blue?logo=github&logoColor=white)](https://github.com/rolehippie/alertmanager)
[![General Workflow](https://github.com/rolehippie/alertmanager/actions/workflows/general.yml/badge.svg)](https://github.com/rolehippie/alertmanager/actions/workflows/general.yml)
[![Readme Workflow](https://github.com/rolehippie/alertmanager/actions/workflows/docs.yml/badge.svg)](https://github.com/rolehippie/alertmanager/actions/workflows/docs.yml)
[![Galaxy Workflow](https://github.com/rolehippie/alertmanager/actions/workflows/galaxy.yml/badge.svg)](https://github.com/rolehippie/alertmanager/actions/workflows/galaxy.yml)
[![License: Apache-2.0](https://img.shields.io/github/license/rolehippie/alertmanager)](https://github.com/rolehippie/alertmanager/blob/master/LICENSE)
[![Ansible Role](https://img.shields.io/badge/role-rolehippie.alertmanager-blue)](https://galaxy.ansible.com/rolehippie/alertmanager)

Ansible role to install and configure Alertmanager.

## Sponsor

Building and improving this Ansible role have been sponsored by my current and previous employers like **[Cloudpunks GmbH](https://cloudpunks.de)** and **[Proact Deutschland GmbH](https://www.proact.eu)**.

## Table of contents

- [Requirements](#requirements)
- [Default Variables](#default-variables)
- [alertmanager_arch](#alertmanager_arch)
- [alertmanager_cpu_shares](#alertmanager_cpu_shares)
- [alertmanager_data_retention](#alertmanager_data_retention)
- [alertmanager_default_folders](#alertmanager_default_folders)
- [alertmanager_default_labels](#alertmanager_default_labels)
- [alertmanager_default_publish](#alertmanager_default_publish)
- [alertmanager_default_templates](#alertmanager_default_templates)
- [alertmanager_default_volumes](#alertmanager_default_volumes)
- [alertmanager_domain](#alertmanager_domain)
- [alertmanager_download](#alertmanager_download)
- [alertmanager_extra_folders](#alertmanager_extra_folders)
- [alertmanager_extra_labels](#alertmanager_extra_labels)
- [alertmanager_extra_publish](#alertmanager_extra_publish)
- [alertmanager_extra_templates](#alertmanager_extra_templates)
- [alertmanager_extra_volumes](#alertmanager_extra_volumes)
- [alertmanager_group_by](#alertmanager_group_by)
- [alertmanager_image](#alertmanager_image)
- [alertmanager_inhibit_rules](#alertmanager_inhibit_rules)
- [alertmanager_installation](#alertmanager_installation)
- [alertmanager_listen_address](#alertmanager_listen_address)
- [alertmanager_memory_limit](#alertmanager_memory_limit)
- [alertmanager_memory_soft_limit](#alertmanager_memory_soft_limit)
- [alertmanager_memory_swap](#alertmanager_memory_swap)
- [alertmanager_network](#alertmanager_network)
- [alertmanager_number_of_cpus](#alertmanager_number_of_cpus)
- [alertmanager_oauth2_access_logging](#alertmanager_oauth2_access_logging)
- [alertmanager_oauth2_allowed_groups](#alertmanager_oauth2_allowed_groups)
- [alertmanager_oauth2_arch](#alertmanager_oauth2_arch)
- [alertmanager_oauth2_client_id](#alertmanager_oauth2_client_id)
- [alertmanager_oauth2_client_secret](#alertmanager_oauth2_client_secret)
- [alertmanager_oauth2_cookie_secret](#alertmanager_oauth2_cookie_secret)
- [alertmanager_oauth2_cpu_shares](#alertmanager_oauth2_cpu_shares)
- [alertmanager_oauth2_default_labels](#alertmanager_oauth2_default_labels)
- [alertmanager_oauth2_default_publish](#alertmanager_oauth2_default_publish)
- [alertmanager_oauth2_download](#alertmanager_oauth2_download)
- [alertmanager_oauth2_enabled](#alertmanager_oauth2_enabled)
- [alertmanager_oauth2_extra_labels](#alertmanager_oauth2_extra_labels)
- [alertmanager_oauth2_extra_publish](#alertmanager_oauth2_extra_publish)
- [alertmanager_oauth2_image](#alertmanager_oauth2_image)
- [alertmanager_oauth2_keycloak_url](#alertmanager_oauth2_keycloak_url)
- [alertmanager_oauth2_listen_address](#alertmanager_oauth2_listen_address)
- [alertmanager_oauth2_memory_limit](#alertmanager_oauth2_memory_limit)
- [alertmanager_oauth2_memory_soft_limit](#alertmanager_oauth2_memory_soft_limit)
- [alertmanager_oauth2_memory_swap](#alertmanager_oauth2_memory_swap)
- [alertmanager_oauth2_network](#alertmanager_oauth2_network)
- [alertmanager_oauth2_number_of_cpus](#alertmanager_oauth2_number_of_cpus)
- [alertmanager_oauth2_provider](#alertmanager_oauth2_provider)
- [alertmanager_oauth2_pull_image](#alertmanager_oauth2_pull_image)
- [alertmanager_oauth2_request_logging](#alertmanager_oauth2_request_logging)
- [alertmanager_oauth2_static_groups](#alertmanager_oauth2_static_groups)
- [alertmanager_oauth2_static_users](#alertmanager_oauth2_static_users)
- [alertmanager_oauth2_upstream](#alertmanager_oauth2_upstream)
- [alertmanager_oauth2_version](#alertmanager_oauth2_version)
- [alertmanager_pull_image](#alertmanager_pull_image)
- [alertmanager_receiver](#alertmanager_receiver)
- [alertmanager_receivers](#alertmanager_receivers)
- [alertmanager_routes](#alertmanager_routes)
- [alertmanager_smtp_from](#alertmanager_smtp_from)
- [alertmanager_smtp_password](#alertmanager_smtp_password)
- [alertmanager_smtp_require_tls](#alertmanager_smtp_require_tls)
- [alertmanager_smtp_smarthost](#alertmanager_smtp_smarthost)
- [alertmanager_smtp_username](#alertmanager_smtp_username)
- [alertmanager_template_paths](#alertmanager_template_paths)
- [alertmanager_version](#alertmanager_version)
- [Discovered Tags](#discovered-tags)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)

---

## Requirements

- Minimum Ansible version: `2.10`

## Default Variables

### alertmanager_arch

Target system architecture of the binary

#### Default value

```YAML
alertmanager_arch: "{{ 'arm64' if ansible_architecture == 'aarch64' or ansible_architecture
== 'arm64' else 'amd64' }}"
```

### alertmanager_cpu_shares

CPU shares with Docker deployment

#### Default value

```YAML
alertmanager_cpu_shares:
```

#### Example usage

```YAML
alertmanager_cpu_shares: '512'
```

### alertmanager_data_retention

Data retention for alertmanager state

#### Default value

```YAML
alertmanager_data_retention: 120h
```

### alertmanager_default_folders

List of default folders to create

#### Default value

```YAML
alertmanager_default_folders:
- /etc/alertmanager
- /etc/alertmanager/templates
- /var/lib/alertmanager
```

### alertmanager_default_labels

List of default labels to assign to docker

#### Default value

```YAML
alertmanager_default_labels: []
```

### alertmanager_default_publish

List of default port publishing for docker

#### Default value

```YAML
alertmanager_default_publish: []
```

#### Example usage

```YAML
alertmanager_default_publish:
- 127.0.0.1:9093:9093
```

### alertmanager_default_templates

List of default template file definition

#### Default value

```YAML
alertmanager_default_templates: []
```

### alertmanager_default_volumes

List of default volumes to mount for docker

#### Default value

```YAML
alertmanager_default_volumes:
- /var/lib/alertmanager:/var/lib/alertmanager
- /etc/alertmanager:/etc/alertmanager
```

### alertmanager_domain

Domain for external access

#### Default value

```YAML
alertmanager_domain:
```

#### Example usage

```YAML
alertmanager_domain: https://alertmanager.example.com
```

### alertmanager_download

URL to the archive of the release to install

#### Default value

```YAML
alertmanager_download:
https://github.com/prometheus/alertmanager/releases/download/v{{
alertmanager_version }}/alertmanager-{{ alertmanager_version }}.linux-{{
alertmanager_arch }}.tar.gz
```

### alertmanager_extra_folders

List of extra folders to create

#### Default value

```YAML
alertmanager_extra_folders: []
```

#### Example usage

```YAML
alertmanager_extra_folders:
- /path/to/host/folder1
- /path/to/host/folder2
- /path/to/host/folder3
```

### alertmanager_extra_labels

List of extra labels to assign to docker

#### Default value

```YAML
alertmanager_extra_labels: []
```

### alertmanager_extra_publish

List of extra port publishing for docker

#### Default value

```YAML
alertmanager_extra_publish: []
```

#### Example usage

```YAML
alertmanager_extra_publish:
- 127.0.0.1:9093:9093
```

### alertmanager_extra_templates

List of extra template file definition

#### Default value

```YAML
alertmanager_extra_templates: []
```

### alertmanager_extra_volumes

List of extra volumes to mount for docker

#### Default value

```YAML
alertmanager_extra_volumes: []
```

#### Example usage

```YAML
alertmanager_extra_volumes:
- /path/to/host/folder1:/path/within/container1
- /path/to/host/folder2:/path/within/container2
- /path/to/host/folder3:/path/within/container3
```

### alertmanager_group_by

List of alerting groups

#### Default value

```YAML
alertmanager_group_by: []
```

#### Example usage

```YAML
alertmanager_group_by:
- alertname
- app
```

### alertmanager_image

Docker image to use for deployment

#### Default value

```YAML
alertmanager_image: quay.io/prometheus/alertmanager:v{{ alertmanager_version }}
```

### alertmanager_inhibit_rules

List of alerting recipients

#### Default value

```YAML
alertmanager_inhibit_rules: []
```

#### Example usage

```YAML
alertmanager_inhibit_rules:
- source_match:
severity: critical
target_match:
severity: 'warning'
equal:
- alertname
- dev
- instance
```

### alertmanager_installation

Select installation method, could be native or docker

#### Default value

```YAML
alertmanager_installation: native
```

### alertmanager_listen_address

Listen address for the alertmanager

#### Default value

```YAML
alertmanager_listen_address: 0.0.0.0:9093
```

### alertmanager_memory_limit

Memory limit with Docker deployment

#### Default value

```YAML
alertmanager_memory_limit:
```

#### Example usage

```YAML
alertmanager_memory_limit: 1024m
```

### alertmanager_memory_soft_limit

Soft memory limit with Docker deployment

#### Default value

```YAML
alertmanager_memory_soft_limit:
```

#### Example usage

```YAML
alertmanager_memory_soft_limit: 512m
```

### alertmanager_memory_swap

Swap usage with Docker deployment

#### Default value

```YAML
alertmanager_memory_swap:
```

#### Example usage

```YAML
alertmanager_memory_swap: 2048m
```

### alertmanager_network

Optional docker network to attach

#### Default value

```YAML
alertmanager_network:
```

### alertmanager_number_of_cpus

Number of CPUs with Docker deployment

#### Default value

```YAML
alertmanager_number_of_cpus:
```

#### Example usage

```YAML
alertmanager_number_of_cpus: '1.0'
```

### alertmanager_oauth2_access_logging

Enable access logging for OAuth2 proxy

#### Default value

```YAML
alertmanager_oauth2_access_logging: false
```

### alertmanager_oauth2_allowed_groups

List of groups to allow access

#### Default value

```YAML
alertmanager_oauth2_allowed_groups: []
```

#### Example usage

```YAML
alertmanager_oauth2_allowed_groups:
- /Group1
- /Group2
- /Group3
```

### alertmanager_oauth2_arch

Target system architecture of the binary

#### Default value

```YAML
alertmanager_oauth2_arch: '{{ alertmanager_arch }}'
```

### alertmanager_oauth2_client_id

Client ID for OAuth2 authentication

#### Default value

```YAML
alertmanager_oauth2_client_id:
```

### alertmanager_oauth2_client_secret

Client secret for OAuth2 authentication

#### Default value

```YAML
alertmanager_oauth2_client_secret:
```

### alertmanager_oauth2_cookie_secret

Cookie secret used by OAuth2 proxy

#### Default value

```YAML
alertmanager_oauth2_cookie_secret:
```

### alertmanager_oauth2_cpu_shares

CPU shares with Docker deployment

#### Default value

```YAML
alertmanager_oauth2_cpu_shares:
```

#### Example usage

```YAML
alertmanager_oauth2_cpu_shares: '512'
```

### alertmanager_oauth2_default_labels

List of default labels to assign to docker on OAuth2 Proxy

#### Default value

```YAML
alertmanager_oauth2_default_labels: []
```

### alertmanager_oauth2_default_publish

List of default port publishing for docker on OAuth2 Proxy

#### Default value

```YAML
alertmanager_oauth2_default_publish: []
```

#### Example usage

```YAML
alertmanager_oauth2_default_publish:
- 127.0.0.1:9092:9092
```

### alertmanager_oauth2_download

#### Default value

```YAML
alertmanager_oauth2_download:
https://github.com/oauth2-proxy/oauth2-proxy/releases/download/v{{
alertmanager_oauth2_version }}/oauth2-proxy-v{{ alertmanager_oauth2_version
}}.linux-{{ alertmanager_oauth2_arch }}.tar.gz
```

### alertmanager_oauth2_enabled

URL of the OAuth2 Proxy to download

#### Default value

```YAML
alertmanager_oauth2_enabled: false
```

### alertmanager_oauth2_extra_labels

List of extra labels to assign to docker on OAuth2 Proxy

#### Default value

```YAML
alertmanager_oauth2_extra_labels: []
```

### alertmanager_oauth2_extra_publish

List of extra port publishing for docker on OAuth2 Proxy

#### Default value

```YAML
alertmanager_oauth2_extra_publish: []
```

#### Example usage

```YAML
alertmanager_oauth2_extra_publish:
- 127.0.0.1:9092:9092
```

### alertmanager_oauth2_image

Docker image to use for deployment

#### Default value

```YAML
alertmanager_oauth2_image: quay.io/oauth2-proxy/oauth2-proxy:v{{
alertmanager_oauth2_version }}
```

### alertmanager_oauth2_keycloak_url

URL of the Keycloak realm

#### Default value

```YAML
alertmanager_oauth2_keycloak_url:
```

### alertmanager_oauth2_listen_address

Listem address for the OAuth2 proxy

#### Default value

```YAML
alertmanager_oauth2_listen_address: 0.0.0.0:9092
```

### alertmanager_oauth2_memory_limit

Memory limit with Docker deployment

#### Default value

```YAML
alertmanager_oauth2_memory_limit:
```

#### Example usage

```YAML
alertmanager_oauth2_memory_limit: 1024m
```

### alertmanager_oauth2_memory_soft_limit

Soft memory limit with Docker deployment

#### Default value

```YAML
alertmanager_oauth2_memory_soft_limit:
```

#### Example usage

```YAML
alertmanager_oauth2_memory_soft_limit: 512m
```

### alertmanager_oauth2_memory_swap

Swap usage with Docker deployment

#### Default value

```YAML
alertmanager_oauth2_memory_swap:
```

#### Example usage

```YAML
alertmanager_oauth2_memory_swap: 2048m
```

### alertmanager_oauth2_network

Optional docker network to attach on OAuth2 Proxy

#### Default value

```YAML
alertmanager_oauth2_network: '{{ alertmanager_network }}'
```

### alertmanager_oauth2_number_of_cpus

Number of CPUs with Docker deployment

#### Default value

```YAML
alertmanager_oauth2_number_of_cpus:
```

#### Example usage

```YAML
alertmanager_oauth2_number_of_cpus: '1.0'
```

### alertmanager_oauth2_provider

Provider for OAuth2 authentication

#### Default value

```YAML
alertmanager_oauth2_provider: keycloak
```

### alertmanager_oauth2_pull_image

Pull OAuth2 Proxy image as part of the tasks

#### Default value

```YAML
alertmanager_oauth2_pull_image: '{{ alertmanager_pull_image }}'
```

### alertmanager_oauth2_request_logging

Enable request logging for OAuth2 proxy

#### Default value

```YAML
alertmanager_oauth2_request_logging: false
```

### alertmanager_oauth2_static_groups

List of groups assigned to static users

#### Default value

```YAML
alertmanager_oauth2_static_groups: []
```

### alertmanager_oauth2_static_users

List of users to allow access

#### Default value

```YAML
alertmanager_oauth2_static_users: []
```

#### Example usage

```YAML
alertmanager_oauth2_static_users:
- username: username1
password: p455w0rd
- username: username2
password: p455w0rd
- username: username3
password: p455w0rd
```

### alertmanager_oauth2_upstream

Upstream target for the OAuth2 proxy

#### Default value

```YAML
alertmanager_oauth2_upstream: http://{{ alertmanager_listen_address if
alertmanager_installation == 'native' else 'alertmanager:9093' }}
```

### alertmanager_oauth2_version

Version of the OAuth2 Proxy to download

#### Default value

```YAML
alertmanager_oauth2_version: 7.14.3
```

### alertmanager_pull_image

Pull image as part of the tasks

#### Default value

```YAML
alertmanager_pull_image: true
```

### alertmanager_receiver

Standard conect for alerts

#### Default value

```YAML
alertmanager_receiver:
```

### alertmanager_receivers

List of alerting recipients

#### Default value

```YAML
alertmanager_receivers: []
```

#### Example usage

```YAML
alertmanager_receivers:
- name: mail-devops
email_configs:
- to: devops@example.com
send_resolved: true
```

### alertmanager_routes

List of alerting routes

#### Default value

```YAML
alertmanager_routes: []
```

#### Example usage

```YAML
alertmanager_routes:
- receiver: mail-devops
match:
severity: critical
```

### alertmanager_smtp_from

Sender for emails

#### Default value

```YAML
alertmanager_smtp_from:
```

### alertmanager_smtp_password

Password for SMTP connection

#### Default value

```YAML
alertmanager_smtp_password:
```

### alertmanager_smtp_require_tls

Require TLS for SMTP connection

#### Default value

```YAML
alertmanager_smtp_require_tls: true
```

### alertmanager_smtp_smarthost

Host for SMTP connection

#### Default value

```YAML
alertmanager_smtp_smarthost:
```

### alertmanager_smtp_username

Username for SMTP connection

#### Default value

```YAML
alertmanager_smtp_username:
```

### alertmanager_template_paths

List of template paths for alertmanager

#### Default value

```YAML
alertmanager_template_paths:
- /etc/alertmanager/templates/*.tmpl
```

### alertmanager_version

Version of the release to install

#### Default value

```YAML
alertmanager_version: 0.31.1
```

## Discovered Tags

**_alertmanager_**

**_oauth2_**

## Dependencies

- [rolehippie.docker](https://github.com/rolehippie/docker)
- [community.docker](https://github.com/ansible-collections/community.docker)
- [community.general](https://github.com/ansible-collections/community.general)

## License

Apache-2.0

## Author

[Thomas Boerger](https://github.com/tboerger)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/rolehippie/alertmanager

Awesome Lists containing this project

README