Getting Started

Install canary checker

helm repo add flanksource https://flanksource.github.io/charts
helm repo update
helm install canary-checker flanksource/canary-checker -n "canary-checker"  --create-namespace

Create a new check

canary.yaml

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: http-check
spec:
  interval: 30
  http:
    - name: basic-check
      url: https://httpbin.demo.aws.flanksource.com/status/200
    - name: failing-check
      url: https://httpbin.demo.aws.flanksource.com/status/500

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

:::

3. Check the status of the health check:

   kubectl get canary

4. 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

http://localhost:8080

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

Parameter	Description
flanksource-ui.ingress.host	URL at which the UI will be accessed
flanksource-ui.ingress.annotations	Map of annotations required by the ingress controller or certificate issuer
flanksource-ui.ingress.tls	Map 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:

• Invite yourself to the CNCF community slack and join the #canary-checker channel.
• Check out the Youtube Playlist.
• File an issue - (We do provide user support via Github Issues, so don't worry if your issue a real bug or not)
• Flanksource provides both commercial support for canary checker and a SaaS offering called Mission Control.

Your feedback is always welcome!