Skip to main content

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

FieldDescriptionSchemeRequired
authUsername and password value, configMapKeyRef or SecretKeyRef for registryAuthentication
expectedDigestExpected digest of the pulled imagestringYes
expectedSizeExpected size of the pulled imageint64Yes
imageFull path to image, including registrystringYes
nameName of the check, must be unique within the canarystringYes
descriptionDescription for the checkstring
iconIcon for overwriting default icon on the dashboardstring
labelsLabels for checkmap[string]string
testEvaluate whether a check is healthyExpression
displayExpression to change the formatting of the displayExpression
transformTransform data from a check into multiple individual checksExpression
metricsMetrics to export from[]Metrics

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>
FieldDescriptionSchemeRequired
imageFull path to image, including registrystringYes
passwordPassword to access ContainerdstringYes
usernameUsername to access ContainerdstringYes
nameName of the check, must be unique within the canarystringYes
descriptionDescription for the checkstring
iconIcon for overwriting default icon on the dashboardstring
labelsLabels for checkmap[string]string
testEvaluate whether a check is healthyExpression
displayExpression to change the formatting of the displayExpression
transformTransform data from a check into multiple individual checksExpression
metricsMetrics to export from[]Metrics