Skip to main content

Restic

<FullImage />

The Restic check:

  • Queries a Restic Repository for content
  • Checks the integrity and consistency of the repository and data-blobs
  • Checks for backup freshness.
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: restic-check
spec:
interval: 30
restic:
- repository: s3:http://minio.minio:9000/restic-canary-checker
name: restic check
password:
valueFrom:
secretKeyRef:
name: restic-credentials
key: PASSWORD
maxAge: 1h
accessKey:
valueFrom:
secretKeyRef:
name: restic-credentials
key: ACCESS_KEY_ID
secretKey:
valueFrom:
secretKeyRef:
name: restic-credentials
key: SECRET_ACCESS_KEY
FieldDescriptionSchemeRequired
maxAgeMaxAge for backup freshnessstringYes
repositoryThe restic repository path e.g., rest: https://user:pass@host:8000/ or rest: https://host:8000/ or s3:s3.amazonaws.com/bucket_namestringYes
caCertCaCert path to the root cert. In case of self-signed certificatesstring
checkIntegrityWhen enabled will check the Integrity and consistency of the restic repositorybool
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
Encryption Connection
connectionPath of an existing connection to get the encryption key e.g., connection://restic/key
Mutually exclusive with password
Connection
password Mutually exclusive with connection EnvVarYes
AWS Connection
awsConnectionNamePath of an existing connection to connect to S3 e.g., connection://aws/instance
Mutually exclusive with accessKey
Connection
accessKeyMutually exclusive with awsConnectionNameEnvVarYes
secretKeyMutually exclusive with awsConnectionNameEnvVarYes
endpointCustom AWS Config endpointstring
regionAWS regionstring
skipTLSVerifySkip TLS verify when connecting to AWSbool