hecate

README

hecate

(pronounced "HEK-uh-tee")

Hecate was a goddess in ancient Greek religion associated with crossroads. In XMiDT, Hecate is a tool to help transition webhook backends in XMiDT from AWS SNS to Argus.

Summary

XMiDT has historically relied on SNS as the method to keep a distributed list of event webhook subscriptions. Now, it relies on argus to handle those storage needs. As teams may need to upgrade their XMiDT services without downtime or disruptions, Hecate is here to help ensure all the webhook data between SNS and Argus is synchronized during the migration.

Table of Contents

• Code of Conduct
• Details
• Build
• Contributing

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Details

Hecate's job consists in listening for webhook updates from SNS and pushing them to Argus.

Build

Source

In order to build from source, you need a working 1.x Go environment. Find more information on the Go website.

Then, clone the repository and build using make:

git clone git@github.com:xmidt-org/hecate.git
cd hecate
make build

Makefile

The Makefile has the following options you may find helpful:

• make build: builds the Hecate binary
• make docker: fetches all dependencies from source and builds a Hecate docker image
• make local-docker: vendors dependencies and builds a Hecate docker image (recommended for local testing)
• make test: runs unit tests with coverage for Hecate
• make clean: deletes previously-built binaries and object files

Docker

The docker image can be built either with the Makefile or by running a docker command. Either option requires first getting the source code.

See Makefile on specifics of how to build the image that way.

If you'd like to build it without make, follow these instructions based on your use case:

• Local testing

go mod vendor
docker build -t hecate:local -f deploy/Dockerfile .

This allows you to test local changes to a dependency. For example, you can build a hecate image with the changes to an upcoming changes to webpa-common by using the replace directive in your go.mod file like so:

replace github.com/xmidt-org/webpa-common v1.10.2 => ../webpa-common

Note: if you omit go mod vendor, your build will fail as the path ../webpa-common does not exist on the builder container.

• Building a specific version

git checkout v0.5.1
docker build -t hecate:v0.5.1 -f deploy/Dockerfile .

Contributing

Refer to CONTRIBUTING.md.