Run alerta in a docker container
Permalink
Failed to load latest commit information.
config Support all env vars for web UI config.js (#88) Sep 5, 2018
contrib/kubernetes Run pip from virtualenv (#81) Jul 26, 2018
examples Add Prometheus-Alertmanager example (#82) Aug 5, 2018
hooks Support all env vars for web UI config.js (#88) Sep 5, 2018
.gitignore Update to support both postgres and mongodb backends Feb 11, 2018
Dockerfile Update Docker to Release 6.0 (#91) Sep 18, 2018
LICENSE Update to support both postgres and mongodb backends Feb 11, 2018
Makefile Allow alerta client config file to be overridden by user (#75) Jul 8, 2018
README.md Allow alerta client config file to be overridden by user (#75) Jul 8, 2018
RUNBOOK.md Support all env vars for web UI config.js (#88) Sep 5, 2018
VERSION Update Docker to Release 6.0 (#91) Sep 18, 2018
config.json.template Update Docker to Release 6.0 (#91) Sep 18, 2018
docker-compose.mongo-replica.yml Bump docker-compose to version 3.1 (#85) Aug 24, 2018
docker-compose.mongo.yml Bump docker-compose to version 3.1 (#85) Aug 24, 2018
docker-compose.postgres.yml Bump docker-compose to version 3.1 (#85) Aug 24, 2018
docker-compose.simple.yml Bump docker-compose to version 3.1 (#85) Aug 24, 2018
docker-compose.yml Support all env vars for web UI config.js (#88) Sep 5, 2018
docker-entrypoint.sh Update Docker to Release 6.0 (#91) Sep 18, 2018
nginx.conf Apply BASE_URL to web console URL also (#66) May 1, 2018
run.sh Add labels for automated docker hub builds Feb 15, 2018
supervisord.conf Make use of new housekeeping command Feb 13, 2018
uwsgi.ini Double the uwsgi request header buffer size (#89) Sep 11, 2018
wsgi.py Update Docker to Release 6.0 (#91) Sep 18, 2018

README.md

What is Alerta?

The alerta monitoring system is a tool used to consolidate and de-duplicate alerts from multiple sources for quick ‘at-a-glance’ visualisation. With just one system you can monitor alerts from many other monitoring tools on a single screen.

How to use this image

To use this image run either a mongo or postgres container first:

$ docker run --name alerta-db -d mongo

Then link to the database container when running the alerta-web container:

$ export DATABASE_URL=mongodb://db:27017/monitoring
$ docker run --name alerta-web -e DATABASE_URL=$DATABASE_URL --link alerta-db:db \
-d -p <port>:8080 alerta/alerta-web

The API endpoint is at:

http://<docker>:<port>/api

Browse to the alerta console at:

http://<docker>:<port>/

Environment Variables

The following environment variables are supported for configuring the alerta-web container:

DEBUG - debug mode for increased logging. (eg. DEBUG=1)

BASE_URL - used to make links in API responses relative. (default: /api)

SECRET_KEY - a unique, randomly generated sequence of ASCII characters.

DATABASE_URL - database connection URI string. Only MongoDB and Postgres allowed.

DATABASE_NAME - used to override database name in DATABASE_URL.

AUTH_REQUIRED - require users to authenticate when using web UI or alerta CLI.

ADMIN_USERS - comma-separated list of logins that will be created with "admin" role.

ADMIN_PASSWORD - sets the password of all admins. Should be changed at first login.

ADMIN_KEY - sets an admin API key.

CUSTOMER_VIEWS - enable alert views partitioned by customer. (default:False)

OAUTH2_CLIENT_ID - client ID required by OAuth2 provider

OAUTH2_CLIENT_SECRET - client secret required by OAuth2 provider

ALLOWED_EMAIL_DOMAINS - list of authorised email domains when using Google

GITHUB_URL - GitHub Enteprise URL for privately run GitHub server

ALLOWED_GITHUB_ORGS - list of authorised GitHub organisations when using GitHub

GITLAB_URL - GitLab website URL for public or privately run GitLab server

ALLOWED_GITLAB_GROUPS - list of authorised GitLab groups when using GitLab

KEYCLOAK_URL - Keycloak URL

KEYCLOAK_REALM - Keycloak realm

ALLOWED_KEYCLOAK_ROLES - Keycloak roles

CORS_ORIGINS - list of URL origins that can access the API

MAIL_FROM - valid email address from which verification emails are sent

SMTP_PASSWORD - password for MAIL_FROM email account

PLUGINS - list of plugins to enable.

INSTALL_PLUGINS - list of plugins to automatically install.

Configuration Files

To set configuration settings not supported by environment variables use configuration files instead. For example:

$ docker run -v $PWD/config/alertad.conf:/app/alertad.conf \
  -v $PWD/config/config.js:/app/config.js \
  -p <port>:8080 alerta/alerta-web

For a full list of server configuration options see http://docs.alerta.io.

Installing Plugins

Plugins listed in the INSTALL_PLUGINS environment variable will be installed automatically at container start time. Only plugins listed in PLUGINS will be enabled. This allows plugins to be installed and enabled at a later time.

In the example below, the reject and blackout plugins are installed by default, the slack and prometheus plugins are also installed but of the two only the slack plugin is enabled:

PLUGINS=reject,blackout,slack
INSTALL_PLUGINS=slack,prometheus

Alternatively, install all wanted plugins as an additional image layer.

Authentication

To make it easy to get going with Alerta on docker quickly, the default image will use Basic Auth for user logins and login will be optional.

To allow users to login using Google OAuth, go to the Google Developer Console and create a new client ID for a web application. Then set the CLIENT_ID and CLIENT_SECRET environment variables on the command line as follows:

$ export CLIENT_ID=379647311730-6tfdcopl5fodke08el52nnoj3x8mpl3.apps.googleusercontent.com
$ export CLIENT_SECRET=UpJxs02c_bx9GlI3X8MPL3-p

Now pass in the defined environment variables to the docker run command:

$ docker run --name alerta-web  -e PROVIDER=google -e CLIENT_ID=$CLIENT_ID \
-e CLIENT_SECRET=$CLIENT_SECRET -d -p <port>:8080 alerta/alerta-web

This will allow users to login but will only make it optional. To enforce users to login you must also set the AUTH_REQUIRED environment variable to True when starting the docker image:

$ docker run --name alerta-web -e AUTH_REQUIRED=True -e ...

To restrict logins to a certain email domain set the ALLOWED_EMAIL_DOMAIN environment variable as follows:

$ docker run --name alerta-web -e ALLOWED_EMAIL_DOMAIN=example.com ...

GitHub and GitLab can also be used as the OAuth2 providers by setting the PROVIDER environment variable to github and gitlab respectively. For more information on using GitHub, GitHub Enterprise or GitLab as th OAuth2 provider see http://docs.alerta.io

Docker Compose

Use docker-compose to create and start Alerta and Postgres with one command:

$ docker-compose up

Example Docker Compose File

version: '2.1'
services:
  web:
    image: alerta/alerta-web
    ports:
      - "8080:8080"
    depends_on:
      - db
    environment:
      - DEBUG=1  # remove this line to turn DEBUG off
      - DATABASE_URL=postgres://postgres:postgres@db:5432/monitoring
      - AUTH_REQUIRED=True
      - ADMIN_USERS=admin@alerta.io,devops@alerta.io
      - PLUGINS=reject,blackout,normalise,enhance
      - INSTALL_PLUGINS=normalise,enhance
    restart: always
  db:
    image: postgres
    volumes:
      - ./pg-data:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: monitoring
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
    restart: always

Command-line Tool

A command-line tool for alerta is available. To install it run:

$ pip install alerta

Configuration file $HOME/.alerta.conf:

[DEFAULT]
endpoint = http://<docker>:<port>/api

If authentication is enabled (ie. AUTH_REQUIRED is True), then create a new API key in the Alerta console and add the key to the configuration file. For example:

[DEFAULT]
endpoint = ...
key = 4nHAAslsGjLQ9P0QxmAlKIapLTSDfEfMDSy8BT+0

Further Reading

More information about Alerta can be found at http://docs.alerta.io

License

Copyright (c) 2014-2018 Nick Satterly. Available under the MIT License.