Skip to content
This repository has been archived by the owner on Dec 17, 2020. It is now read-only.


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


(pronounced “fen-rear”)

No Maintenance Intended


This project has been archived. No future work will be done here.

Build Status Go Report Card Apache V2 License GitHub release Quality Gate Status

The service that prunes expired entries from the database.


Fenrir prunes expired events from the database. For more information on how Fenrir fits into codex, check out the codex README.

This project isn't currently being worked on, as yugabyte doesn't need this service.

Table of Contents

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.


Fenrir makes a call to the database at a configurable interval. The database call tells the database to delete records whose deathdate has passed, but there is a configurable limit to the number of records to delete, to avoid timeout issues.



In order to build from the source, you need a working Go environment with version 1.11 or greater. Find more information on the Go website.

You can directly use go get to put the Fenrir binary into your GOPATH:

GO111MODULE=on go get

You can also clone the repository yourself and build using make:

mkdir -p $GOPATH/src/
cd $GOPATH/src/
git clone
cd fenrir
make build


The Makefile has the following options you may find helpful:

  • make build: builds the Fenrir binary
  • make rpm: builds an rpm containing Fenrir
  • make docker: builds a docker image for Fenrir, making sure to get all dependencies
  • make local-docker: builds a docker image for Fenrir with the assumption that the dependencies can be found already
  • make it: runs make docker, then deploys Fenrir and a cockroachdb database into docker.
  • make test: runs unit tests with coverage for Fenrir
  • make clean: deletes previously-built binaries and object files


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.

For running a command, either you can run docker build after getting all dependencies, or make the command fetch the dependencies. If you don't want to get the dependencies, run the following command:

docker build -t fenrir:local -f deploy/Dockerfile .

If you want to get the dependencies then build, run the following commands:

GO111MODULE=on go mod vendor
docker build -t fenrir:local -f deploy/Dockerfile.local .

For either command, if you want the tag to be a version instead of local, then replace local in the docker build command.


WIP. TODO: add info


For deploying on Docker or in Kubernetes, refer to the deploy README.

For running locally, ensure you have the binary built. If it's in your GOPATH, run:


If the binary is in your current folder, run:



Refer to