Sign inSign up

leominov/alertmanager-devops-toolkit

By leominov

•Updated about 6 years ago

Image
0

2.0K

leominov/alertmanager-devops-toolkit repository overview

⁠Alertmanager DevOps Toolkit

Build Status codecov

⁠Tool #1. Linter

⁠Rules
  • All routes must contains receiver;
  • All receivers must be used;
  • Receivers must contains slack_configs, email_configs or webhook_configs;
  • Slack api_url only in global settings;
  • Slack channels starts with # or @;
  • Only valid webhook URLs;
  • Only valid Email recipients.

And some other.

⁠Usage
-lint
    Lint config
-lint-config string
    Configuration file to lint (default "alertmanager.yml")
⁠Configuration

You may disable rules by configuration file .alertmanager-devops-toolkit.yml:

---
checks:
  default_receiver:
    active: false
  empty_receivers:
    active: false
  receiver_email_to:
    active: false
  receiver_has_slack_api_url:
    active: false
  receiver_slack_channels:
    active: false
  receiver_slack_http_config_proxy_url:
    active: false
  receiver_unique_email_to:
    active: false
  receiver_unique_slack_channel:
    active: false
  receiver_unique_webhook_url:
    active: false
  receiver_webhook_http_config_proxy_url:
    active: false
  receiver_webhook_urls:
    active: false
  route_has_receiver:
    active: false
  route_receiver_is_defined:
    active: false

⁠Tool #2. Render

Render given template, include and indent are supported, useful for categorization of receivers and routes (see GitLab Code Owners⁠ and Atlassian Stash Approvers⁠). For example, you have an structure:

conf/
    teamA/
        routes.yml
        receivers.yml
    teamB/
        routes.yml
        receivers.yml
    teamC/
        routes.yml
        receivers.yml

And template of configuration file:

---
global:
  slack_api_url: {{ .Env.SLACK_API_URL | secret }}
receivers:
{{ include "conf/*/receivers.yml" . | indent 2 }}
route:
  receiver: receiver
  routes:
{{ include "conf/*/routes.yml" . | indent 4 }}

After rendering you got:

---
global:
  slack_api_url: http://slack.com/blablah
receivers:
  # conf/teamA/receivers.yml content
  ...
  # conf/teamB/receivers.yml content
  ...
  # conf/teamC/receivers.yml content
  ...
route:
  receiver: receiver
  routes:
    # conf/teamA/routes.yml content
    ...
    # conf/teamB/routes.yml content
    ...
    # conf/teamC/routes.yml content
    ...
⁠Usage
-render
    Render template
-render-template string
    Template file to render (default ".alertmanager.tmpl.yml")
-safe
    Included all specified secrets (default true)

⁠Tool #3. Tests

Wrapper for amtool config routes test command, arguments was stored in YAML-files.

tests/
    groupA.yaml

groupA.yaml content:

---
- receivers:
    - group1-dev
  labels:
    env: dev
⁠Usage
-test
    Test config
-test-config string
    Configuration file to test (default "alertmanager.yml")
-test-dir string
    Directory with tests (default "tests")
⁠Configuration

You may specify Glob-mask for test files by setting up configuration file .alertmanager-devops-toolkit.yml:

---
# Default: [*.yaml, *.yml]
testFiles:
  - tests.yaml
  - tests.yml

Tag summary

Content type

Image

Digest

Size

16.5 MB

Last updated

about 6 years ago

docker pull leominov/alertmanager-devops-toolkit