canonical / alertmanager-configurer-k8s-operator

Alertmanager Configurer Charmed Operator

Description

The Alertmanager Configurer Charmed Operator provides an HTTP-based API for managing Alertmanager configuration.

This charm has been designed to supplement the alertmanager-k8s charm. It leverages the alertmanager_remote_configuration interface, provided by the alertmanager-k8s, to send the configuration over to the Alertmanager inside the Juju relation data bag.

Full description of the API is available in github.

Usage

Deployment

NOTE: This charm is only compatible with Juju 3.x!

The Alertmanager Configurer Charmed Operator may be deployed using the Juju command line as in:

juju deploy alertmanager-configurer-k8s --trust

Relating to the Alertmanager

juju deploy alertmanager-k8s --channel=edge --trust
juju relate alertmanager-configurer-k8s:alertmanager alertmanager-k8s:remote-configuration

Configuring Alertmanager via alertmanager-configurer

Alertmanager Configurer exposes an HTTP API which allows managing Alertmanager's configuration. The API is available at port 9101 on the IP address of the charm unit. This unit and its IP address may be determined using the juju status command.
Full description of Alertmanager Configurer's API is available in github.

Alertmanager Configurer has been designed to support multiple tenants. In a multitenant Alertmanager Configurer setup, each alert is first routed on the tenancy label, and then the routing tree is distinct for each tenant.

Examples:

Get tenants:

curl -X GET http://<ALERTMANAGER CONFIGURER CHARM UNIT IP>:9101/v1/tenants

Create Alertmanager's global config:

global:
  resolve_timeout: 5m
  http_config:
    tls_config:
      insecure_skip_verify: true

curl -X POST http://<ALERTMANAGER CONFIGURER CHARM UNIT IP>:9101/v1/global
  -H 'Content-Type: application/json'
  -d '{"resolve_timeout": "5m", "http_config": {"tls_config": {"insecure_skip_verify": true}}}'

Get Alertmanager's global config:

curl -X GET http://<ALERTMANAGER CONFIGURER CHARM UNIT IP>:9101/v1/global

Create receiver:

receivers:
- name: <TENANT_ID>_example
  webhook_configs:
  - send_resolved: false
    url: http://receiver_example.com

curl -X POST http://<ALERTMANAGER CONFIGURER CHARM UNIT IP>:9101/v1/<TENANT_ID>/receiver
  -H 'Content-Type: application/json'
  -d '{"name": "example", "webhook_configs": [{"url": "http://receiver_example.com"}]}'

Delete receiver:

curl -X DELETE http://<ALERTMANAGER CONFIGURER CHARM UNIT IP>:9101/v1/<TENANT_ID>/receiver/<RECEIVER_NAME>

OCI Images

• facebookincubator/alertmanager-configurer
• canonical/200-ok

alertmanager-configurer-k8s-operator's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update canonical/charming-actions action to v2.4.0
• Update actions/checkout action to v4

Detected dependencies

github-actions

.github/workflows/ci.yaml

• actions/checkout v3
• actions/checkout v3
• actions/checkout v3
• actions/checkout v3
• actions/upload-artifact v3
• actions/upload-artifact v3
• actions/upload-artifact v3
• actions/checkout v3
• actions/download-artifact v3
• canonical/charming-actions 2.2.5
• canonical/charming-actions 2.2.5
• ubuntu 22.04
• ubuntu 22.04
• ubuntu 22.04
• ubuntu 22.04
• ubuntu 22.04

.github/workflows/codeql-analysis.yml

• actions/checkout v3
• github/codeql-action v2
• github/codeql-action v2
• github/codeql-action v2
• ubuntu 22.04

.github/workflows/promote.yaml

• actions/checkout v3
• canonical/charming-actions 2.2.5
• ubuntu 22.04

pip_requirements

requirements.txt

---

• Check this box to trigger a request for Renovate to run again on this repository