https://github.com/jrasell/nomad-toast

A tool for receiving notifications based on HashiCorp Nomad events.
https://github.com/jrasell/nomad-toast

chatops go golang hashicorp nomad slack

Last synced: 3 months ago
JSON representation

A tool for receiving notifications based on HashiCorp Nomad events.

• Host: GitHub
• URL: https://github.com/jrasell/nomad-toast
• Owner: jrasell
• License: mpl-2.0
• Created: 2018-10-10T11:57:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-06T16:30:25.000Z (over 4 years ago)
• Last Synced: 2024-08-03T19:09:30.935Z (6 months ago)
• Topics: chatops, go, golang, hashicorp, nomad, slack
• Language: Go
• Homepage:
• Size: 2.36 MB
• Stars: 49
• Watchers: 5
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nomad Toast

[![Build Status](https://travis-ci.org/jrasell/nomad-toast.svg?branch=master)](https://travis-ci.org/jrasell/nomad-toast) [![Go Report Card](https://goreportcard.com/badge/github.com/jrasell/nomad-toast)](https://goreportcard.com/report/github.com/jrasell/nomad-toast)

nomad-toast in an open source tool for receiving notifications based on [HashiCorp Nomad](https://www.nomadproject.io/) events. It is designed to increase observability throughout an organisation and provide insights within chatops style environments. 

### Supported Nomad Endpoints

nomad-toast currently supports watching the following Nomad API endpoints:

* Allocations - https://www.nomadproject.io/api/allocations.html

* Deployments - https://www.nomadproject.io/api/deployments.html

### Supported Notification Endpoints

* Slack - https://slack.com/

## Download & Install

* The nomad-toast binary can be downloaded from the [GitHub releases page](https://github.com/jrasell/nomad-toast/releases) using `curl -L https://github.com/jrasell/nomad-toast/releases/download/0.0.1/nomad-toast_linux_amd64 -o nomad-toast`

* A docker image can be found on [Docker Hub](https://hub.docker.com/r/jrasell/nomad-toast/), the latest version can be downloaded using `docker pull jrasell/nomad-toast`.

* nomad-toast can be built from source by firstly cloning the repository `git clone github.com/jrasell/nomad-toast.git`. Once cloned the binary can be built using the `make` command.

## Commands and Flags

nomad-toast supports the following global flags:

* **--log-format** (string: "AUTO") Specify the format of nomad-toast logs. Valid values are AUTO, ZEROLOG or HUMAN.

* **--log-level** (string: "INFO") The level at which nomad-toast will log. Valid values are DEBUG, INFO, WARNING, ERROR and FATAL.

* **--log-use-color** (bool: true) Use ANSI colors in logging output.

* **--nomad-address** (string: "http://localhost:4646") The HTTP(S) API endpoint for Nomad where all calls will be made.

* **--nomad-allow-stale** (bool: true) Allow stale Nomad consistency when making API calls.

* **--slack-auth-token** (string: "") The Slack API auth token for connectivity to slack.

* **--slack-channel** (string: "") The Slack channel to send Nomad notifications to.

#### Command: `allocations`

Allocations triggers a watcher on the Nomad allocations endpoint and will notify you when allocations go through a state change. This can be helpful when keeping an eye on failed allocations, or just to have a general insight into allocation churn.

#### Command: `deployments`

Deployments triggers a watcher on the Nomad deployments endpoint. This allows you to get notified of deployment activities on your cluster and allows stakeholders to gain insight.