Restic

Full Image variant required.

The Restic check:

• Queries a Restic repository for content.
• When checkIntegrity is true, reads a file from the latest snapshot to verify that Restic can restore data.
• Checks 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

Field	Description	Scheme
maxAge*	Maximum age for backup freshness. The CRD requires this field even when connection supplies the runtime value.	Duration
name*	Name of the check, must be unique within the canary	string
password*	Password for the Restic repository. The CRD requires this field even when connection supplies the runtime value.	EnvVar
repository*	Restic repository path, such as rest:https://user:pass@host:8000/, rest:https://host:8000/, or s3:s3.amazonaws.com/bucket_name. The CRD requires this field even when connection supplies the runtime value.	string
accessKey	Access key ID for AWS S3, MinIO, Wasabi, or Alibaba OSS. Current runtime requires this field unless awsConnectionName is set.	EnvVar
awsConnectionName	AWS connection URL that supplies the access key and secret key.	string
caCert	Path to the root certificate for self-signed certificates.	string
checkIntegrity	Read a file from the latest snapshot to verify that Restic can restore data.	boolean
connection	Connection URL, such as connection://restic/prod, that supplies runtime values for the repository URL, password, certificate, and optional checkIntegrity or maxAge properties.	string
secretKey	Secret access key for AWS S3, MinIO, Wasabi, or Alibaba OSS. Current runtime requires this field unless awsConnectionName is set.	EnvVar
dependsOn	Checks that must complete before this check runs	[]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]
markFailOnEmpty	If a transformation or datasource returns empty results, the check should fail	boolean
metrics	Metrics to export from	[]Metrics
namespace	Namespace to insert the check result into when it differs from the canary namespace	string
relationships	Relationships that link check results to components or configs	Relationship
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression
transformDeleteStrategy	Status to apply to transformed checks when the source check no longer returns them	string