gbp-notifications 2.0.0

Get notifications for GBP events

gbp-notifications

gbp-notifications is a plugin for Gentoo Build Publisher that can send notifications when various events occur in a GBP instance. This is to scratch my personal itch where i want to receive emails when certain machines have new builds pulled.

gbp-notifications supports the following built-in notification methods:

• email
• webhook
• pushover

Other notification methods can be added via a plugin system.

Installation

This assumes you already have a working Gentoo Build Publisher installation. If not refer to the GBP Install Guide first.

Install the gbp-notifications package onto the GBP instance.

cd /home/gbp
sudo -u gbp -H ./bin/pip install gbp-notifications

Restart your web app.

systemctl restart gentoo-build-publisher-wsgi.service

Configuration

Environment variables

Like Gentoo Build Publisher itself, gbp-notifications relies on environment variables for configuration. It looks at variables with a GBP_NOTIFICATIONS_ prefix. For example to set up a recipient to receive email notifications when a build for the machine "babette" gets pulled:

# /etc/gentoo-build-publisher.conf

GBP_NOTIFICATIONS_RECIPIENTS="albert:email=[e-mail]"
GBP_NOTIFICATIONS_SUBSCRIPTIONS="babette.postpull=albert"

GBP_NOTIFICATIONS_EMAIL_FROM="[e-mail]"
GBP_NOTIFICATIONS_EMAIL_SMTP_HOST="smtp.email.invalid"
GBP_NOTIFICATIONS_EMAIL_SMTP_USERNAME="[e-mail]"
GBP_NOTIFICATIONS_EMAIL_SMTP_PASSWORD="supersecret"

The first two lines are setting up recipients and subscriptions. There is a single recipient named albert that has an email address. The second line sets up subscriptions. There is one subscription: when the machine "babette" receives a postpull event the the recipient with the name "albert" will be notified. Since "albert" has one notification method defined (email) that recipient will be notified via email.

The wildcard is supported for machines and events, on subscriptions. So *.postpull=albert means "send a notification to albert when any machine receives a postpull event" and babette.*=albert means "send a notification to albert when any event is receive for the machine babette. The double-wildcard, *.*=albert does what you'd think. Notifications are only sent once per recipient (per notification method).

The last lines are settings for the email notification method. gbp-notifications has support for multiple notification methods but currently only email is implemented.

Config file for Recipients and Subscriptions

Alternatively you can use a toml-formatted config file for recipients and subscriptions. For that instead define the GBP_NOTIFICATIONS_CONFIG_FILE environment variable that points to the path of the config file, e.g.

GBP_NOTIFICATIONS_CONFIG_FILE="/etc/gbp-subscribers.toml"

Then in your config file, the above configuration would look like this:

[recipients]
albert = {email = "[e-mail]"}

[subscriptions]
babette = {postpull = ["albert"]}

A more sophisticated example might be:

[recipients]
# Albert and Bob are recipients with email addresses.
albert = {email = "[e-mail]"}
bob = {email = "[e-mail]"}

[subscriptions]
# Both Albert and Bob want to be notified when builds for babette are pulled
babette = {postpull = ["albert", "bob"]}

# For lighthouse Albert only wants to be notified when builds are pulled. Bob
# only wants to be notified when builds are published.
lighthouse = {postpull = ["albert"], published = ["bob"]}

Webhook method

In addition to email, gbp-notifications supports web hooks. For example, consider the environment variables:

GBP_NOTIFICATIONS_RECIPIENTS="marduk:webhook=http://host.invalid/webhook|X-Pre-Shared-Key=1234",
GBP_NOTIFICATIONS_SUBSCRIPTIONS="*.postpull=marduk"

The subscriber "marduk" is subscribed the postpull event for all machines. The recipient for marduk has a "webhook". The configuration for the web hook has values that are delimited with "|". The first item will be the URL of the webhook and any remainint items will be HTTP headers used when requesting the URL. Note that header definitions are to be given in form name=value and not name: value.

Webhooks might be used, for example, to automatically update machines whenever a new build is published. Or perhaps a desktop notification:

Pushover method

Pushover is a service that allows apps to send push notifications to mobile and other devices. gbp-notifications supports the Pushover service. To enable gbp-notifications to sent Pushover notifications you'll need to create a user account as well as app key for your GBP instance. Then define the following denvironment variables:

# /etc/gentoo-build-publisher.conf


GBP_NOTIFICATIONS_PUSHOVER_USER_KEY="[Pushover user key]",
GBP_NOTIFICATIONS_PUSHOVER_APP_TOKEN"="[Pushover app token]",

Pushover subscriptions will look like this:

GBP_NOTIFICATIONS_RECIPIENTS="marduk:pushover=iphone16pro",
GBP_NOTIFICATIONS_SUBSCRIPTIONS="*.postpull=marduk"

Replacing "iphone16pro" with the device name you've registered with Pushover.