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 check

Duration

name*

Name of the check, must be unique within the canary

string

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

awsConnectionName

AWS connection name for S3 repositories

aws

caCert

Path to CA certificate for self-signed certificates

string

checkIntegrity

When enabled it checks the Integrity and consistency of the restic repository

boolean

password

Password for encrypted repositories

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

connection

The connection url to use, mutually exclusive with username and password

Connection

url

If connection is specified and it also includes a url, this field will take precedence

string

username

EnvVar

password

EnvVar