SGObjectStorage

Kind: SGObjectStorage

listKind: SGObjectStorageList

plural: sgobjectstorages

singular: sgobjectstorage

shortNames sgobjs

The SGObjectStorage custom resource allows to configure where backups are going to be stored. The object storage represents a persistence location.

Example:

apiVersion: stackgres.io/v1beta1
kind: SGObjectStorage
metadata:
  name: objectstorage
spec:
  type: s3Compatible
  s3Compatible:
    bucket: stackgres
    region: k8s
    enablePathStyleAddressing: true
    endpoint: http://my-cluster-minio:9000
    awsCredentials:
      secretKeySelectors:
        accessKeyId:
          key: accesskey
          name: my-cluster-minio
        secretAccessKey:
          key: secretkey
          name: my-cluster-minio

See also Backup Storage section.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

apiVersion ✓ string stackgres.io/v1beta1
kind ✓ string SGObjectStorage
metadata ✓ ✓ object Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ✓ ✓ object Object Storage configuration

SGObjectStorage.spec

↩ Parent

Object Storage configuration

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

type ✓ ✓ enum Determine the type of object storage used for storing the base backups and WAL segments. Possible values: * s3: Amazon Web Services S3 (Simple Storage Service). * s3Compatible: non-AWS services that implement a compatibility API with AWS S3. * gcs: Google Cloud Storage. * azureBlob: Microsoft Azure Blob Storage.

Enum: s3, s3Compatible, gcs, azureBlob
azureBlob ✓ object Azure Blob Storage configuration.
gcs ✓ object Google Cloud Storage configuration.
s3 ✓ object Amazon Web Services S3 configuration.
s3Compatible ✓ object AWS S3-Compatible API configuration

SGObjectStorage.spec.azureBlob

↩ Parent

Azure Blob Storage configuration.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

azureCredentials ✓ ✓ object The credentials to access Azure Blob Storage for writing and reading.
bucket ✓ ✓ string Azure Blob Storage bucket name.

SGObjectStorage.spec.azureBlob.azureCredentials

↩ Parent

The credentials to access Azure Blob Storage for writing and reading.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

secretKeySelectors ✓ object Kubernetes SecretKeySelector(s) to reference the Secret(s) that contain the information about the azureCredentials. . Note that you may use the same or different Secrets for the storageAccount and the accessKey. In the former case, the keys that identify each must be, obviously, different.
SGObjectStorage.spec.azureBlob.azureCredentials.secretKeySelectors

↩ Parent

Kubernetes SecretKeySelector(s) to reference the Secret(s) that contain the information about the azureCredentials. . Note that you may use the same or different Secrets for the storageAccount and the accessKey. In the former case, the keys that identify each must be, obviously, different.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

accessKey ✓ ✓ object The storage account access key.
storageAccount ✓ ✓ object The Storage Account that contains the Blob bucket to be used.
SGObjectStorage.spec.azureBlob.azureCredentials.secretKeySelectors.accessKey

↩ Parent

The storage account access key.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.
SGObjectStorage.spec.azureBlob.azureCredentials.secretKeySelectors.storageAccount

↩ Parent

The Storage Account that contains the Blob bucket to be used.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.

SGObjectStorage.spec.gcs

↩ Parent

Google Cloud Storage configuration.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

bucket ✓ ✓ string GCS bucket name.
gcpCredentials ✓ ✓ object The credentials to access GCS for writing and reading.

SGObjectStorage.spec.gcs.gcpCredentials

↩ Parent

The credentials to access GCS for writing and reading.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

fetchCredentialsFromMetadataService ✓ boolean If true, the credentials will be fetched from the GCE/GKE metadata service and the field secretKeySelectors have to be set to null or omitted.

This is useful when running StackGres inside a GKE cluster using Workload Identity.

secretKeySelectors ✓ object A Kubernetes SecretKeySelector to reference the Secrets that contain the information about the Service Account to access GCS.
SGObjectStorage.spec.gcs.gcpCredentials.secretKeySelectors

↩ Parent

A Kubernetes SecretKeySelector to reference the Secrets that contain the information about the Service Account to access GCS.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

serviceAccountJSON ✓ ✓ object A service account key from GCP. In JSON format, as downloaded from the GCP Console.
SGObjectStorage.spec.gcs.gcpCredentials.secretKeySelectors.serviceAccountJSON

↩ Parent

A service account key from GCP. In JSON format, as downloaded from the GCP Console.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.

SGObjectStorage.spec.s3

↩ Parent

Amazon Web Services S3 configuration.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

awsCredentials ✓ ✓ object The credentials to access AWS S3 for writing and reading.
bucket ✓ ✓ string AWS S3 bucket name.
region ✓ string The AWS S3 region. The Region may be detected using s3:GetBucketLocation, but if you wish to avoid giving permissions to this API call or forbid it from the applicable IAM policy, you must then specify this property.
storageClass ✓ string The Amazon S3 Storage Class to use for the backup object storage. By default, the STANDARD storage class is used. Other supported values include STANDARD_IA for Infrequent Access and REDUCED_REDUNDANCY.

SGObjectStorage.spec.s3.awsCredentials

↩ Parent

The credentials to access AWS S3 for writing and reading.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

secretKeySelectors ✓ ✓ object Kubernetes SecretKeySelector(s) to reference the Secrets that contain the information about the awsCredentials. Note that you may use the same or different Secrets for the accessKeyId and the secretAccessKey. In the former case, the keys that identify each must be, obviously, different.
SGObjectStorage.spec.s3.awsCredentials.secretKeySelectors

↩ Parent

Kubernetes SecretKeySelector(s) to reference the Secrets that contain the information about the awsCredentials. Note that you may use the same or different Secrets for the accessKeyId and the secretAccessKey. In the former case, the keys that identify each must be, obviously, different.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

accessKeyId ✓ ✓ object AWS access key ID. For example, AKIAIOSFODNN7EXAMPLE.
secretAccessKey ✓ ✓ object AWS secret access key. For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.
SGObjectStorage.spec.s3.awsCredentials.secretKeySelectors.accessKeyId

↩ Parent

AWS access key ID. For example, AKIAIOSFODNN7EXAMPLE.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.
SGObjectStorage.spec.s3.awsCredentials.secretKeySelectors.secretAccessKey

↩ Parent

AWS secret access key. For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.

SGObjectStorage.spec.s3Compatible

↩ Parent

AWS S3-Compatible API configuration

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

awsCredentials ✓ ✓ object The credentials to access AWS S3 for writing and reading.
bucket ✓ ✓ string Bucket name.
enablePathStyleAddressing ✓ boolean Enable path-style addressing (i.e. http://s3.amazonaws.com/BUCKET/KEY) when connecting to an S3-compatible service that lacks support for sub-domain style bucket URLs (i.e. http://BUCKET.s3.amazonaws.com/KEY).

Defaults to false.

endpoint ✓ string Overrides the default url to connect to an S3-compatible service. For example: http://s3-like-service:9000.
region ✓ string The AWS S3 region. The Region may be detected using s3:GetBucketLocation, but if you wish to avoid giving permissions to this API call or forbid it from the applicable IAM policy, you must then specify this property.
storageClass ✓ string The Amazon S3 Storage Class to use for the backup object storage. By default, the STANDARD storage class is used. Other supported values include STANDARD_IA for Infrequent Access and REDUCED_REDUNDANCY.

SGObjectStorage.spec.s3Compatible.awsCredentials

↩ Parent

The credentials to access AWS S3 for writing and reading.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

secretKeySelectors ✓ ✓ object Kubernetes SecretKeySelector(s) to reference the Secret(s) that contain the information about the awsCredentials. Note that you may use the same or different Secrets for the accessKeyId and the secretAccessKey. In the former case, the keys that identify each must be, obviously, different.
SGObjectStorage.spec.s3Compatible.awsCredentials.secretKeySelectors

↩ Parent

Kubernetes SecretKeySelector(s) to reference the Secret(s) that contain the information about the awsCredentials. Note that you may use the same or different Secrets for the accessKeyId and the secretAccessKey. In the former case, the keys that identify each must be, obviously, different.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

accessKeyId ✓ ✓ object AWS access key ID. For example, AKIAIOSFODNN7EXAMPLE.
secretAccessKey ✓ ✓ object AWS secret access key. For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.
caCertificate ✓ object CA Certificate file to be used when connecting to the S3 Compatible Service.
SGObjectStorage.spec.s3Compatible.awsCredentials.secretKeySelectors.accessKeyId

↩ Parent

AWS access key ID. For example, AKIAIOSFODNN7EXAMPLE.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.
SGObjectStorage.spec.s3Compatible.awsCredentials.secretKeySelectors.secretAccessKey

↩ Parent

AWS secret access key. For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.
SGObjectStorage.spec.s3Compatible.awsCredentials.secretKeySelectors.caCertificate

↩ Parent

CA Certificate file to be used when connecting to the S3 Compatible Service.

Property
Required
Updatable
May Require Restart
Type
 Description

Workaround for hugo bug not rendering first table row

key ✓ ✓ string The key of the secret to select from. Must be a valid secret key.
name ✓ ✓ string Name of the referent. More information.