S3StorageClass

Scope: Cluster
Version: v1alpha1

S3StorageClass is a Kubernetes Custom Resource that defines a configuration for an S3-backed Kubernetes Storage class.

  • metadata
    object
  • spec
    object

    Required value

    Configuration for the S3 storage class.

    • spec.accessKeyID
      string

      Required value

      The access key ID for connecting to the S3 storage. Identical to AWS aws_access_key_id.

    • spec.accessKeySecret
      string

      Required value

      The secret access key for connecting to the S3 storage. Identical to AWS aws_secret_access_key.

    • spec.bucketName
      string

      The name of the bucket in S3. If empty, a new bucket will be dynamically created for each PVC. If not empty, folders (paths) will be dynamically created within the specified bucket for each PVC.

    • spec.endpointUrl
      string

      Required value

      The URL of the S3 API endpoint. For AWS, it should be in the format: “https://s3..amazonaws.com" (e.g., "https://s3.eu-central-1.amazonaws.com").

    • spec.insecure
      boolean

      If set to true, the S3 storage class will not verify the SSL certificate of the S3 endpoint. It enables ignoring of SSL-certificates erros - we do not recommend to use the option, it’s not safe.

      Default: false

    • spec.maxCacheSize
      integer

      Required value

      The size of the mounter’s cache in megabytes.

      Allowed values: 200 <= X

    • spec.region
      string

      Specifies the S3 storage region. For AWS, this can be specified via the endpointUrl parameter