https://github.com/xmidt-org/hecate
Hecate is a simple tool to live migrate a XMiDT cluster from SNS to Argus as webhook backend.
https://github.com/xmidt-org/hecate
Last synced: 12 days ago
JSON representation
Hecate is a simple tool to live migrate a XMiDT cluster from SNS to Argus as webhook backend.
- Host: GitHub
- URL: https://github.com/xmidt-org/hecate
- Owner: xmidt-org
- License: apache-2.0
- Created: 2020-11-20T21:33:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T19:08:30.000Z (6 months ago)
- Last Synced: 2025-05-13T00:52:34.903Z (12 days ago)
- Language: Go
- Homepage:
- Size: 405 KB
- Stars: 0
- Watchers: 13
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
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.
[](https://github.com/xmidt-org/hecate/actions/workflows/ci.yml)
[](https://github.com/xmidt-org/hecate/actions/workflows/updater.yml)
[](http://codecov.io/github/xmidt-org/hecate?branch=main)
[](https://goreportcard.com/report/github.com/xmidt-org/hecate)
[](https://sonarcloud.io/dashboard?id=xmidt-org_hecate)
[](https://github.com/xmidt-org/hecate/blob/main/LICENSE)
[](CHANGELOG.md)
## Summary
XMiDT has historically relied on SNS as the method to keep a distributed list of event webhook subscriptions. Now, it relies on [argus](https://github.com/xmidt-org/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](#code-of-conduct)
- [Details](#details)
- [Build](#build)
- [Contributing](#contributing)
## Code of Conduct
This project and everyone participating in it are governed by the [XMiDT Code Of Conduct](https://xmidt.io/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](https://golang.org/doc/install).
Then, clone the repository and build using make:
```bash
git clone [email protected]: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](#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
```bash
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](https://github.com/xmidt-org/webpa-common) by using the [replace](https://golang.org/ref/mod#go) directive in your go.mod file like so:
```go.mod
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
```bash
git checkout v0.5.1
docker build -t hecate:v0.5.1 -f deploy/Dockerfile .
```
## Contributing
Refer to [CONTRIBUTING.md](CONTRIBUTING.md).