rancher v2.15.1

RKEControlPlane.spec.etcd.s3

S3 defines the S3 configuration for the cluster if enabled.

8 fields
RKEControlPlane.spec.etcd.s3 fields and descriptions
Field / TypeDescription
bucket
string

Bucket is the name of the S3 bucket used for snapshot operations. If this field is not explicitly set, the 'defaultBucket' value from the referenced CloudCredential will be used. An empty bucket name will cause a 'failed to initialize S3 client: s3 bucket name was not set' error.

  • maxLength: 63
  • nullable
cloudCredentialName
string

CloudCredentialName is the name of the secret containing the credentials used to access the S3 bucket. The secret is expected to have the following keys: - accessKey [required] - secretKey [required] - defaultRegion - defaultEndpoint - defaultEndpointCA - defaultSkipSSLVerify - defaultBucket - defaultFolder Fields set directly in this spec (`ETCDSnapshotS3`) take precedence over the corresponding values from the CloudCredential secret. This field must be in the format of "namespace:name".

  • nullable
endpoint
string

Endpoint is the S3 endpoint used for snapshot operations. If this field is not explicitly set, the 'defaultEndpoint' value from the referenced CloudCredential will be used.

  • nullable
endpointCA
string

EndpointCA is the CA certificate for validating the S3 endpoint. This can be either a file path (e.g., "/etc/ssl/certs/my-ca.crt") or the CA certificate content, in base64-encoded or plain PEM format. If this field is not explicitly set, the 'defaultEndpointCA' value from the referenced CloudCredential will be used.

  • nullable
folder
string

Folder is the name of the S3 folder used for snapshot operations. If this field is not explicitly set, the folder from the referenced CloudCredential will be used.

  • nullable
region
string

Region is the S3 region used for snapshot operations. (e.g., "us-east-1"). If this field is not explicitly set, the 'defaultRegion' value from the referenced CloudCredential will be used.

  • nullable
retention
integer

Retention defines the number of snapshots to retain in the S3 bucket. Older snapshots beyond this retention count will be deleted. If this field is not explicitly set, the retention value from the etcd retention will be used.

  • minimum: 0
  • nullable
skipSSLVerify
boolean

SkipSSLVerify defines whether TLS certificate verification is disabled. If this field is not explicitly set, the 'defaultSkipSSLVerify' value from the referenced CloudCredential will be used.