S3 Protocol

info

This checks if S3 compatible endpoints (like Minio, EMC ECS) are functioning correctly, to check the contents of a S3 bucket use: S3 Bucket

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

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: s3-protocol-check
spec:
  interval: 30
  s3:
    - name: s3-check
      bucketName: flanksource-public
      objectPath: dummy
      region: us-east-1
      accessKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_ACCESS_KEY_ID
      secretKey:
        valueFrom:
          secretKeyRef:
            name: aws-credentials
            key: AWS_SECRET_ACCESS_KEY

Field	Description	Scheme	Required
bucket	Bucket name to test against	string	Yes
objectPath	Path to create a test object e.g. s3-dummy/	string	Yes
name	Name of the check, must be unique within the canary	string	Yes
description	Description for the check	string
icon	Icon for overwriting default icon on the dashboard	string
labels	Labels for check	map[string]string
test	Evaluate whether a check is healthy	Expression
display	Expression to change the formatting of the display	Expression
transform	Transform data from a check into multiple individual checks	Expression
metrics	Metrics to export from	[]Metrics
Connection
connection	Path of existing connection e.g. connection://aws/instance. Mutually exclusive with accessKey and secretKey	Connections
accessKey		EnvVar	Yes
secretKey		EnvVar	Yes
endpoint	Custom AWS endpoint	string
region	AWS region	string	Yes
skipTLSVerify	Skip TLS verify when connecting to aws	bool