Skip to content

S3 Protocol

Note

This check if S3 compatible endpoints are functioning correctly, to check the contents of a S3 bucket use (S3)(../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
Field Description Scheme Required
bucket Bucket name to test against Bucket Yes
objectPath Path to create a test object e.g. s3-dummy/ string Yes
* All other common fields Common
Connection
connection Path of existing connection e.g. connection://aws/instance. Mutually exclusive with accessKey and secretKey Connection
accessKey Mutually exclusive with connection EnvVar Yes
secretKey Mutually exclusive with connection EnvVar Yes
endpoint Custom AWS endpoint string
region AWS region string
skipTLSVerify Skip TLS verify when connecting to aws bool