S3Bucket

The S3Bucket Check:

• Searches objects matching the provided object path pattern.
• Checks that the latest object is no older than provided MaxAge value in seconds
• Checks that the latest object size is not smaller than provided MinSize value in bytes.

Example

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: s3-bucket-check
spec:
  interval: 30
  s3Bucket:
    # Check for any backup not older than 7 days and min size 25 bytes
    - bucket: tests-e2e-1
      accessKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_ACCESS_KEY_ID
      secretKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_SECRET_ACCESS_KEY
      region: "minio"
      endpoint: "http://minio.minio:9000"
      filter:
        regex: "(.*)backup.zip$"
      maxAge: 7d
      minSize: 25b
      usePathStyle: true
      skipTLSVerify: true
    # Check for any mysql backup not older than 7 days and min size 25 bytes
    - bucket: tests-e2e-1
      accessKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_ACCESS_KEY_ID
      secretKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_SECRET_ACCESS_KEY
      region: "minio"
      endpoint: "http://minio.minio:9000"
      filter:
        regex: "mysql\\/backups\\/(.*)\\/mysql.zip$"
      maxAge: 7d
      minSize: 25b
      usePathStyle: true
      skipTLSVerify: true
    # Check for any pg backup not older than 7 days and min size 50 bytes
    - bucket: tests-e2e-1
      accessKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_ACCESS_KEY_ID
      secretKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_SECRET_ACCESS_KEY
      region: "minio"
      endpoint: "http://minio.minio:9000"
      filter:
        regex: "pg\\/backups\\/(.*)\\/backup.zip$"
      maxAge: 7d
      minSize: 25b
      usePathStyle: true
      skipTLSVerify: true

Field	Description	Scheme	Required
accessKey	Access key value or valueFrom configMapKeyRef or SecretKeyRef to access your s3	kommons.EnvVar	Yes
bucket	Array of Bucket objects to be checked	Bucket	Yes
description	Description for the check	string
display	Template to display the result in	Template
endpoint	S3/Minio HTTP Endpoint to establish connection	string
filter	Used to filter the objects	FolderFilter
icon	Icon for overwriting default icon on the dashboard	string
maxAge	MaxAge the latest object should be younger than defined age	Duration
maxCount	MinCount the minimum number of files inside the searchPath	int
maxSize	MaxSize of the files inside the searchPath	Size
minAge	MinAge the latest object should be older than defined age	Duration
minCount	MinCount the minimum number of files inside the searchPath	int
minSize	MinSize of the files inside the searchPath	Size
name	Name of the check	string
objectPath	glob path to restrict matches to a subset	string
region	Region where S3 bucket is located	string
secretKey	secret key value or valueFrom configMapKeyRef or SecretKeyRef to access your s3/minio bucket	kommons.EnvVar	Yes
skipTLSVerify	Skip TLS verify when connecting to aws	bool
test	Template to test the result against	Template
usePathStyle	Use path style path: http://s3.amazonaws.com/BUCKET/KEY instead of http://BUCKET.s3.amazonaws.com/KEY	bool

---

Scheme Reference

Bucket

Field	Description	Scheme	Required
endpoint	Set bucket HTTP endpoint	string	Yes
name	Specify name for bucket	string	Yes
region	Specify region for bucket	string	Yes

FolderFilter

Field	Description	Scheme	Required
maxAge	MaxAge the latest object should be younger than defined age	Duration
maxSize	MaxSize of the files inside the searchPath	Size
minAge	MinAge the latest object should be older than defined age	Duration
minSize	MinSize of the files inside the searchPath	Size
regex	Filter files based on regular expression	string

Template

Field	Description	Scheme	Required
jsonPath	Specify path to JSON element for use in template	string
template	Specify Go template for use	string
expr	Specify expression for use in template	string
javascript	Specify javascript syntax for template	string