Badgr
This project has moved to brigadecore/badgr!
Badgr is a simple server for displaying the results of a check suite for any
public GitHub project.
It can run anywhere you can run Docker containers, but is also packaged
as a Helm chart for ease of deployment to a Kubernetes cluster.
Installation
These directions assume you have a Kubernetes cluster up and running and have
the Helm package manager installed, with both of these in good working order.
First, add the chart repository that hosts the badgr chart:
$ helm repo add badgr https://lovethedrake.github.io/badgr
To install the chart with default options:
Helm 3:
$ helm create namespace badgr
$ helm install badgr badgr/badgr --namespace badgr
Helm 2:
$ helm install badgr/badgr --name badgr --namespace badgr
Advanced Installation
To modify any of the default options during installation, start by extracting
the full set up configuration options from the badgr
chart and saving them to
a file:
$ helm inspect values badgr/badgr > my-badgr-values.yaml
Open the my-badgr-values.yaml
file in your favorite editor and edit options
as desired. Install using these options like so:
Helm 3:
$ helm create namespace badgr
$ helm install badgr badgr/badgr --namespace badgr --values my-badgr-values.yaml
Helm 2:
$ helm install badgr/badgr --name badgr --namespace badgr --values my-badgr-values.yaml
If Badgr is already installed and you wish to update the configuration:
Helm 3:
$ helm upgrade badgr badgr/badgr --namespace badgr --values my-badgr-values.yaml
Helm 2:
$ helm upgrade badgr badgr/badgr --values my-badgr-values.yaml
Contributing
This project accepts contributions via GitHub pull requests. The
Contributing document outlines the process to help get your
contribution accepted.
Code of Conduct
Although not a CNCF project, this project abides by the
CNCF Code of Conduct.