The module lifecycle stage: General Availability
The module has requirements for installation

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

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
    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.

      Minimal length: 1

    • spec.accessKeySecret
      string

      Required value

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

      Minimal length: 1

    • 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.<region>.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

      Minimal length: 1

  • status
    object
    Represents the current status of the S3 storage class.
    • status.conditions
      array of objects
      The latest observations of the resource state. Condition type: Ready.
      • status.conditions.lastTransitionTime
        string
        Timestamp of the last status transition for this condition. It is not bumped when only the reason or the message changes.
      • status.conditions.message
        string
        Human-readable explanation of the current status.

        Maximum length: 32768

      • status.conditions.observedGeneration
        integer
        The value of metadata.generation this condition was set against.

        Allowed values: 0 <= X

      • status.conditions.reason
        string
        Machine-readable reason for the current status, suitable for log filtering and alerting.

        Length: 1..1024

        Pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

      • status.conditions.status
        string
        Current status of the condition.

        Allowed values: True, False, Unknown

      • status.conditions.type
        string
        Condition type. Ready is True once the StorageClass and the credentials secret are in place, and False when a reconcile pass failed or the resource is being deleted — the reason tells those apart (ReconcileFailed / Deleting). Until the controller has produced its first verdict the condition is absent rather than Unknown.

        Maximum length: 316

        Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

    • status.observedGeneration
      integer
      The value of metadata.generation the controller has last acted on. When it trails metadata.generation, the controller has not yet processed the latest spec, and the conditions below still describe the previous one.

      Allowed values: 0 <= X

    • status.phase
      string

      The current state of the S3 storage class. Might be:

      • Failed (indicating errors in the configuration or setup)
      • Created (indicating successful creation and operation).

      Allowed values: Failed, Created

    • status.reason
      string
      Additional information about the current state.