Exec

Executes a bash (Linux) or powershell (Windows) script. The check is considered passing if the script exits with 0

Docker Image variants

See image-variants

exec.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: exec-pass
spec:
  interval: 30
  exec:
    - name: exec-pass-check
      description: "exec dummy check"
      script: |
        echo "hello"
      test:
        expr: 'results.stdout == "hello"'

Field	Description	Scheme
name*	Name of the check, must be unique within the canary	string
script*	Script can be a inline script or a path to a script that needs to be executed. On windows executed via Powershell and in darwin and Linux executed using bash
checkout	Specify git repository to mount to the exec process	[]GitCheckout
connections	Setup connections for the script (eg: aws credentials)	ExecConnection
env	Setup environment variables that are accessible to the exec process	[]EnvVar
description	Description for the check	string
display	Expression to change the formatting of the display	Expression
icon	Icon for overwriting default icon on the dashboard	Icon
labels	Labels for check	map[string]string
metrics	Metrics to export from	[]Metrics
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression

Exec with an Environment Variables

exec_artifact.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: exec-env
spec:
  interval: 30
  exec:
    - name: exec-env
      description: "exec with env"
      script: |
        echo -n ${FL_HELLO} ${FL_WORLD}
      env:
        - name: FL_HELLO
          value: "hello"
        - name: FL_WORLD
          value: "world"
      test:
        expr: 'results.stdout == "hello world"'

Git Checkout

Exec with Checkout

exec_artifact.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: exec-checkout
spec:
  interval: 30
  exec:
    - name: exec-checkout
      description: "exec with git"
      script: |
        cat go.mod | head -n 1
      checkout:
        url: github.com/flanksource/duty
      test:
        expr: 'results.stdout == "module github.com/flanksource/duty"'

Field	Description	Scheme
destination	Destination is the full path to where the contents of the URL should be downloaded to. If left empty, the sha256 hash of the URL will be used as the dir name
url		string
certificate		EnvVar
username		EnvVar
password		EnvVar