Skip to main content

Restic

Full Image variant required.

The Restic check:

  • Queries a Restic Repository for content
  • Checks the integrity and consistency of the repository and data-blobs
  • Checks for backup freshness.
restic.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: restic-pass-withoutinegrity
spec:
schedule: "@every 5m"
restic:
- repository: s3:http://minio.minio.svc.cluster.local:9000/restic-canary-checker
name: restic check
password:
value: S0m3p@sswd
maxAge: 1h
accessKey:
value: minio
secretKey:
value: minio123
FieldDescriptionScheme
maxAge*

Max age for backup freshness

Duration

name*

Name of the check, must be unique within the canary

string

password*

Password for the restic repository

EnvVar

repository*

The restic repository path e.g., rest:https://user:pass@host:8000/ or rest:https://host:8000/ or s3:s3.amazonaws.com/bucket_name

string

accessKey

Access key ID for connection with AWS S3, MinIO, Wasabi, Alibaba OSS

EnvVar

awsConnectionName

AWS connection name used to derive the access key and secret key

string

caCert

Path to the root cert for self-signed certificates

string

checkIntegrity

When enabled, checks the integrity and consistency of the restic repository

boolean

connection

Connection name used to derive restic password

string

secretKey

Secret access key for connection with AWS S3, MinIO, Wasabi, Alibaba OSS

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]

markFailOnEmpty

If a transformation or datasource returns empty results, the check should fail

boolean

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