kdnotify/README.md

# kdnotify - A keepalived FIFO handler

This is a utility that is primary focused on integrating with [Keepalived][@keepalived]'s
`vrrp_notify_fifo_script` and `vrrp_notify_fifo` configuration options.

It provides a more structured approach than Keepalived's suggested shell script, allowing
users to specify rules for processing events, rather than requiring tedious and error
prone handling of parsing and processing each event individually.

## Usage

The primary usage of this binary requires three things:

1. A configuration file in `/etc/kdnotify/config.yaml`
2. A running kdnotify service, see [kdnotify.socket](./systemd/kdnotify.socket)
3. Enabling Keepalived to use this project for notifications via:

```conf
# Or in any other block where vrrp_notify_fifo_script is legal
global_defs {
  notify_fifo /run/kdnotify.fifo [username [groupname]]
}
```

## Development

You can run `make help` in the repo root to get a list of available targets, but these
are the most useful:

| Target      | Description                             |
|:------------|:----------------------------------------|
| `build`     | Build the binary to `build/kdnotify`    |
| `check`     | Run project checks and lints            |
| `install`   | Install the project to the local system |
| `clean`     | Cleans build directory                  |
| `configure` | Configures build time directives        |

Make sure you run `check` before merging to `master`.

<!-- Links and file refs -->

[@keepalived]: https://www.keepalived.org/index.html