Skip to main content

Getting Started

Install canary checker

helm repo add flanksource
helm repo update
helm install canary-checker flanksource/canary-checker -n "canary-checker" --create-namespace

Create a new check

kind: Canary
name: http-check
interval: 30
- name: basic-check
- name: failing-check

And then apply it to the cluster:

kubectl apply -f canary.yaml

:::info You can also run the check locally to see its output by using the cli

canary-checker run canary.yaml
  1. Check the status of the health check:

    kubectl get canary
  2. Check the Dashboard

You can access the web dashboard by forwarding the port:

kubectl  -n canary-checker port-forward svc/canary-checker-ui 8080:80


The canary checker itself only presents an API. To view the data graphically, the Flanksource UI is required, and is installed by default. The UI should be configured in values.yaml to allow external access via ingress

flanksource-ui.ingress.hostURL at which the UI will be accessed
flanksource-ui.ingress.annotationsMap of annotations required by the ingress controller or certificate issuer
flanksource-ui.ingress.tlsMap of configuration options for TLS

More details regarding ingress configuration can be found in the kubernetes documentation

Getting Help

If you have any questions about canary checker:

Your feedback is always welcome!