README
¶
Chronologist 🎞
Chronologist is a Kubernetes controller that syncs your Helm chart deployments with Grafana annotations.
Key features:
- For each Helm release you install/upgrade creates related Grafana annotation
- Annotations are tagged with related info such as release name, release namespace, etc
- When you purge delete a release, deletes corresponding annotation
Deployment
The easiest way to install Chronologist into your Kubernetes cluster is to use Helm chart.
Replace values below with your actual Grafana address and API key
helm repo add chronologist https://hypnoglow.github.io/chronologist
helm install chronologist/chronologist \
--set grafana.addr=http://grafana.example.com \
--set grafana.apiKey=ABCDEF1234567890
See values.yaml for the full list of possible options.
Contributing
Contributions are welcome!
See docs/development.md for detailed instructions on how to run development environment for Chronologist.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
chronologist
Package chronologist provides domain types and logic for the application.
|
Package chronologist provides domain types and logic for the application. |
|
controller
Package controller encapsulates kubernetes controller logic that powers Chronologist.
|
Package controller encapsulates kubernetes controller logic that powers Chronologist. |
|
grafana
Package grafana provides integrations required by Chronologist to operate on Grafana.
|
Package grafana provides integrations required by Chronologist to operate on Grafana. |
|
helm
Package helm provides utilities required by Chronologist to work with Helm releases.
|
Package helm provides utilities required by Chronologist to work with Helm releases. |
|
kube
Package kube provides conveniences for working with Kubernetes.
|
Package kube provides conveniences for working with Kubernetes. |
|
zaplog
Package zaplog provides conveniences for zap logger.
|
Package zaplog provides conveniences for zap logger. |
|
tests
|
|
|
framework
Package framework provides conveniences for testing.
|
Package framework provides conveniences for testing. |
Click to show internal directories.
Click to hide internal directories.