S3
The S3 check:
- Lists objects in the bucket to check for Read permissions
- Puts an object into the bucket for Write permissions
- Downloads previously uploaded object to check for Get permissions
Example
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: s3-check
annotations:
trace: "false"
spec:
interval: 30
s3Bucket:
# Check for any backup not older than 7 days and min size 25 bytes
- bucket: flanksource-public
region: eu-central-1
minSize: 50M
maxAge: 10d
filter:
regex: .*.ova
minSize: 100M
# maxAge: 18760h
display:
template: |
{{- range $f := .results.Files }}
{{- if gt $f.Size 0 }}
Name: {{$f.Name}} {{$f.ModTime | humanizeTime }} {{ $f.Size | humanizeBytes}}
{{- end}}
{{- end }}
Field | Description | Scheme | Required |
---|---|---|---|
accessKey |
AWS access Key to access Bucket | string | Yes |
bucket |
Array of Bucket objects to be checked | Bucket | Yes |
description |
Description for the check | string | |
icon |
Icon for overwriting default icon on the dashboard | string | |
name |
Name of the check | string | |
objectPath |
Path of object in bucket to | string | Yes |
secretKey |
AWS secret Key to access Bucket | string | Yes |
skipTLSVerify |
Skip TLS verify when connecting to s3 | 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 |