Skip to main content

Getting Started

  1. Install canary checker using helm

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

  2. Create a new check

    canary.yaml
    apiVersion: canaries.flanksource.com/v1
    kind: Canary
    metadata:
    name: http-check
    spec:
    schedule: "@every 30s"
    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

  3. And then apply it to the cluster:

    kubectl apply -f canary.yaml

    Run the check locally

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

    canary-checker run canary.yaml
  4. Check the status via kubectl

    kubectl get canary
  5. Port Forward the dashboard

    You can access the web dashboard by forwarding the port:

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

  6. View the dashboard

    The dashboard can be accessed at 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

ParameterDescription
flanksource-ui.ingress.hostURL at which the UI is 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.