ContainerD / Docker

This check will try to pull a Docker image from specified registry using containerd and then verify its checksum and size.

Root Privileges Required

The containerd and docker health checks require access to a working socket that is mounted at runtime

Pulling images

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: containerd-pull-check
spec:
  interval: 30
  containerd: # use docker if running outside kubernetes / docker
    - image: docker.io/library/busybox:1.31.1
      expectedDigest: sha256:95cf004f559831017cdf4628aaf1bb30133677be8702a8c5f2994629f637a209
      expectedSize: 764556

Field	Description	Scheme
image*	Full path to image, including registry	string
name*	Name of the check, must be unique within the canary	string
expectedDigest	Expected digest of the pulled image	string
expectedSize	Expected size of the pulled image	int64
password	Registry password for authentication	string
username	Registry username for authentication	string
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

---

Pushing images

This check will try to push a Docker image to a specified registry using containerd.

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: containerd-push-check
spec:
  interval: 30
  containerdPush: # use dockerPush if running outside kubernetes / docker
    - name: ContainerdPush Check
      image: docker.io/library/busybox:1.31.1
      username: <insert-username>
      password: <insert-password>

Field	Description	Scheme
image*	Full path to image, including registry	string
name*	Name of the check, must be unique within the canary	string
password*	Registry password for authentication	string
username*	Registry username for authentication	string
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