Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/puppetlabs/relay
Event-driven workflows for DevOps automation
https://github.com/puppetlabs/relay
relay
Last synced: about 2 months ago
JSON representation
Event-driven workflows for DevOps automation
- Host: GitHub
- URL: https://github.com/puppetlabs/relay
- Owner: puppetlabs
- License: apache-2.0
- Archived: true
- Created: 2019-06-19T21:27:18.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-09T21:12:02.000Z (over 1 year ago)
- Last Synced: 2024-06-20T17:53:19.260Z (3 months ago)
- Topics: relay
- Language: Go
- Homepage:
- Size: 12 MB
- Stars: 52
- Watchers: 47
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-repositories - puppetlabs/relay - Event-driven workflows for DevOps automation (Go)
README
Relay is a service that lets you connect tools, APIs, and infrastructure to automate common tasks through simpler, smarter workflows. It links infrastructure events to workflow execution, so that for example, when a new JIRA ticket or GitHub issue comes in, your workflow can trigger deployments or send notifications.
This repo contains the source for the CLI tool.
## Installation
For Macs, install via homebrew:
```bash
brew install puppetlabs/puppet/relay
```
For other platforms, install directly via GitHub Releases:
[Get the latest version](https://github.com/puppetlabs/relay/releases)
The program is just a single binary, so you can simply download the one that matches your architecture and copy it to a location in your `$PATH`.
```bash
mv ./relay-v4*-linux-arm64 /usr/local/bin/relay
```
## Getting started
Once it's installed, you'll need to authenticate with the service, then you'll be able to work with the default set of workflows that are enabled on your account:
```bash
relay auth login
relay workflow list
```
### Config
Relay uses [viper](https://github.com/spf13/viper) for customizable config. The following config values may be set in a yaml file at `$HOME/.config/relay/config.yaml` or as environment variables with corresponding names in all caps, prefixed with `RELAY_`:
- `debug`: Run Relay in debug mode. Overridden by global `--debug` flag.
- `out=(text|json)`: Output mode. Overridden by global `--out` flag.
- `yes`: Skip confirmation prompts. Overridden by global `--yes` flag.