cnpg-extensions.yandex.cloud_backupconfigs.yaml

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.20.1
  name: backupconfigs.cnpg-extensions.yandex.cloud
spec:
  group: cnpg-extensions.yandex.cloud
  names:
    kind: BackupConfig
    listKind: BackupConfigList
    plural: backupconfigs
    singular: backupconfig
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
    - description: Overall status of the BackupConfig
      jsonPath: .status.phase
      name: Phase
      type: string
    - description: Whether storage is accessible for reading
      jsonPath: .status.conditions[?(@.type=="StorageReadable")].status
      name: Readable
      type: string
    - description: Whether storage is accessible for writing
      jsonPath: .status.conditions[?(@.type=="StorageWritable")].status
      name: Writable
      type: string
    - description: Total consumed storage space
      jsonPath: .status.consumedStorage.total
      name: Storage
      type: string
    - description: Timestamp of the last successful backup
      jsonPath: .status.lastSuccessfulBackup
      name: Last Successful Backup
      type: date
    - description: Earliest point in time to which the database can be restored
      jsonPath: .status.firstRecoverabilityPoint
      name: First Recoverability Point
      type: date
    name: v1beta1
    schema:
      openAPIV3Schema:
        description: BackupConfig is the Schema for the backupconfigs API.
        properties:
          apiVersion:
            description: |-
              APIVersion defines the versioned schema of this representation of an object.
              Servers should convert recognized schemas to the latest internal value, and
              may reject unrecognized values.
              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
            type: string
          kind:
            description: |-
              Kind is a string value representing the REST resource this object represents.
              Servers may infer this from the endpoint the client submits requests to.
              Cannot be updated.
              In CamelCase.
              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
            type: string
          metadata:
            type: object
          spec:
            description: BackupConfigSpec defines the desired state of BackupConfig.
            properties:
              deltaMaxSteps:
                description: Determines how many delta backups can be between full
                  backups. Defaults to 0.
                type: integer
              downloadConcurrency:
                description: How many goroutines to use during backup && wal downloading.
                  Default value is evaluated at runtime
                type: integer
              downloadFileRetries:
                description: 'How many times failed file will be retried during backup
                  / wal download. Default: 15.'
                type: integer
              encryption:
                description: Backups encryption configuration
                properties:
                  encryptionSecret:
                    description: |-
                      Name of the existing secret with entryption keys.

                      If empty / not provided - secret will be generated automatically
                      with name "<backupconfig-name>-encryption" and random key

                      For "libsodium" method secret should contain single key "libsodiumKey"
                      containing hex-encoded 32-bytes length key i.e. created with `openssl rand -hex 32`
                    type: string
                  method:
                    description: |-
                      Method used for backup encryption.
                      Currently "libsodium" method supported only.
                      Use "none" or leave empty to disable encryption.
                    type: string
                type: object
              resources:
                description: |-
                  Resources for wal-g sidecar configurations

                  IMPORTANT: resource changes will NOT trigger auto-update on clusters
                  Manual rollout with pods recreation needed instead
                properties:
                  claims:
                    description: |-
                      Claims lists the names of resources, defined in spec.resourceClaims,
                      that are used by this container.

                      This field depends on the
                      DynamicResourceAllocation feature gate.

                      This field is immutable. It can only be set for containers.
                    items:
                      description: ResourceClaim references one entry in PodSpec.ResourceClaims.
                      properties:
                        name:
                          description: |-
                            Name must match the name of one entry in pod.spec.resourceClaims of
                            the Pod where this field is used. It makes that resource available
                            inside a container.
                          type: string
                        request:
                          description: |-
                            Request is the name chosen for a request in the referenced claim.
                            If empty, everything from the claim is made available, otherwise
                            only the result of this request.
                          type: string
                      required:
                      - name
                      type: object
                    type: array
                    x-kubernetes-list-map-keys:
                    - name
                    x-kubernetes-list-type: map
                  limits:
                    additionalProperties:
                      anyOf:
                      - type: integer
                      - type: string
                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                      x-kubernetes-int-or-string: true
                    description: |-
                      Limits describes the maximum amount of compute resources allowed.
                      More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
                    type: object
                  requests:
                    additionalProperties:
                      anyOf:
                      - type: integer
                      - type: string
                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                      x-kubernetes-int-or-string: true
                    description: |-
                      Requests describes the minimum amount of compute resources required.
                      If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
                      otherwise to an implementation-defined value. Requests cannot exceed Limits.
                      More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
                    type: object
                type: object
              retention:
                description: Backups retention configuration
                properties:
                  deleteBackupsAfter:
                    description: |-
                      DeleteBackupsAfter is the retention policy to be used for backups
                      and WALs (i.e. '60d'). It is expressed in the form
                      of `XXu` where `XX` is a positive integer and `u` is in `[dwmh]` -
                      days, weeks, months, hours (i.e. '7d', '4w', '1m', '6h').
                      Different units should not be used at the same time
                      If not specified - backups will not be deleted automatically
                    pattern: ^[1-9][0-9]*[dwmh]$
                    type: string
                  ignoreForBackupConfigDeletion:
                    default: false
                    description: |-
                      Whether to disable S3 storage cleanup on BackupConfig deletion.
                      Useful when managing storage retention by S3 lifecycle policies.
                      When true, the operator will skip storage cleanup when BackupConfig is deleted.
                    type: boolean
                  ignoreForBackupDeletion:
                    default: false
                    description: |-
                      Whether to disable S3 storage cleanup on individual Backup resource deletion.
                      Useful when managing storage retention by S3 lifecycle policies.
                      When true, the operator will skip storage cleanup when individual Backup resources are deleted.
                    type: boolean
                  ignoreForManualBackups:
                    default: false
                    description: |-
                      Whether to ignore manually created backups in retention policy

                      IMPORTANT: Automatically created backups should have OwnerReference with
                      ScheduledBackup or Cluster resource to be treated as auto backups!
                      (.spec.backupOwnerReference: "self" or "cluster" in ScheduledBackup resource)
                    type: boolean
                  minBackupsToKeep:
                    default: 5
                    description: |-
                      Minimal number of full backups to keep, this will keep backups
                      even if backup should be deleted due to DeleteBackupsAfter policy
                      Default is 5 backups
                    maximum: 99
                    minimum: 0
                    type: integer
                type: object
              storage:
                description: Backups storage configuration
                properties:
                  s3:
                    description: S3StorageConfig defines S3-specific configuration
                      for object storage
                    properties:
                      accessKeyId:
                        description: SecretKeySelector selects a key of a Secret.
                        properties:
                          key:
                            description: The key of the secret to select from.  Must
                              be a valid secret key.
                            type: string
                          name:
                            default: ""
                            description: |-
                              Name of the referent.
                              This field is effectively required, but due to backwards compatibility is
                              allowed to be empty. Instances of this type with an empty value here are
                              almost certainly wrong.
                              More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                            type: string
                          optional:
                            description: Specify whether the Secret or its key must
                              be defined
                            type: boolean
                        required:
                        - key
                        type: object
                        x-kubernetes-map-type: atomic
                      accessKeySecret:
                        description: SecretKeySelector selects a key of a Secret.
                        properties:
                          key:
                            description: The key of the secret to select from.  Must
                              be a valid secret key.
                            type: string
                          name:
                            default: ""
                            description: |-
                              Name of the referent.
                              This field is effectively required, but due to backwards compatibility is
                              allowed to be empty. Instances of this type with an empty value here are
                              almost certainly wrong.
                              More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                            type: string
                          optional:
                            description: Specify whether the Secret or its key must
                              be defined
                            type: boolean
                        required:
                        - key
                        type: object
                        x-kubernetes-map-type: atomic
                      customCA:
                        description: |-
                          Custom CA certificate reference for S3 endpoint
                          Can be specified in either ConfigMap or Secret
                        properties:
                          key:
                            description: Key in the ConfigMap or Secret containing
                              the CA certificate
                            type: string
                          kind:
                            description: |-
                              Kind of the resource containing the CA certificate
                              Can be either "ConfigMap" or "Secret"
                            enum:
                            - ConfigMap
                            - Secret
                            type: string
                          name:
                            description: Name of the ConfigMap or Secret containing
                              the CA certificate
                            type: string
                        required:
                        - key
                        - kind
                        - name
                        type: object
                      endpointUrl:
                        description: |-
                          S3 endpoint url
                          Mutually exclusive with EndpointURLFrom
                        type: string
                      endpointUrlFrom:
                        description: |-
                          Reference to get endpoint URL value from Secret or ConfigMap
                          Mutually exclusive with EndpointURL
                        properties:
                          configMapKeyRef:
                            description: Reference to a key in a ConfigMap
                            properties:
                              key:
                                description: The key to select.
                                type: string
                              name:
                                default: ""
                                description: |-
                                  Name of the referent.
                                  This field is effectively required, but due to backwards compatibility is
                                  allowed to be empty. Instances of this type with an empty value here are
                                  almost certainly wrong.
                                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                type: string
                              optional:
                                description: Specify whether the ConfigMap or its
                                  key must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                          secretKeyRef:
                            description: Reference to a key in a Secret
                            properties:
                              key:
                                description: The key of the secret to select from.  Must
                                  be a valid secret key.
                                type: string
                              name:
                                default: ""
                                description: |-
                                  Name of the referent.
                                  This field is effectively required, but due to backwards compatibility is
                                  allowed to be empty. Instances of this type with an empty value here are
                                  almost certainly wrong.
                                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                type: string
                              optional:
                                description: Specify whether the Secret or its key
                                  must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                        type: object
                      forcePathStyle:
                        description: |-
                          To enable path-style addressing (i.e., http://s3.amazonaws.com/BUCKET/KEY)
                          when connecting to an S3-compatible service that lack of support for
                          sub-domain style bucket URLs (i.e., http://BUCKET.s3.amazonaws.com/KEY)
                        type: boolean
                      prefix:
                        description: |-
                          e.g. s3://bucket/path/to/folder
                          Mutually exclusive with PrefixFrom
                        type: string
                      prefixFrom:
                        description: |-
                          Reference to get prefix value from Secret or ConfigMap
                          Mutually exclusive with Prefix
                        properties:
                          configMapKeyRef:
                            description: Reference to a key in a ConfigMap
                            properties:
                              key:
                                description: The key to select.
                                type: string
                              name:
                                default: ""
                                description: |-
                                  Name of the referent.
                                  This field is effectively required, but due to backwards compatibility is
                                  allowed to be empty. Instances of this type with an empty value here are
                                  almost certainly wrong.
                                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                type: string
                              optional:
                                description: Specify whether the ConfigMap or its
                                  key must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                          secretKeyRef:
                            description: Reference to a key in a Secret
                            properties:
                              key:
                                description: The key of the secret to select from.  Must
                                  be a valid secret key.
                                type: string
                              name:
                                default: ""
                                description: |-
                                  Name of the referent.
                                  This field is effectively required, but due to backwards compatibility is
                                  allowed to be empty. Instances of this type with an empty value here are
                                  almost certainly wrong.
                                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                type: string
                              optional:
                                description: Specify whether the Secret or its key
                                  must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                        type: object
                      region:
                        description: |-
                          S3 Region
                          Mutually exclusive with RegionFrom
                        type: string
                      regionFrom:
                        description: |-
                          Reference to get region value from Secret or ConfigMap
                          Mutually exclusive with Region
                        properties:
                          configMapKeyRef:
                            description: Reference to a key in a ConfigMap
                            properties:
                              key:
                                description: The key to select.
                                type: string
                              name:
                                default: ""
                                description: |-
                                  Name of the referent.
                                  This field is effectively required, but due to backwards compatibility is
                                  allowed to be empty. Instances of this type with an empty value here are
                                  almost certainly wrong.
                                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                type: string
                              optional:
                                description: Specify whether the ConfigMap or its
                                  key must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                          secretKeyRef:
                            description: Reference to a key in a Secret
                            properties:
                              key:
                                description: The key of the secret to select from.  Must
                                  be a valid secret key.
                                type: string
                              name:
                                default: ""
                                description: |-
                                  Name of the referent.
                                  This field is effectively required, but due to backwards compatibility is
                                  allowed to be empty. Instances of this type with an empty value here are
                                  almost certainly wrong.
                                  More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                type: string
                              optional:
                                description: Specify whether the Secret or its key
                                  must be defined
                                type: boolean
                            required:
                            - key
                            type: object
                            x-kubernetes-map-type: atomic
                        type: object
                      storageClass:
                        description: |-
                          S3 storage class used for backup files.
                          Default is "STANDARD". Other supported values include
                          "STANDARD_IA" for Infrequent Access and
                          "REDUCED_REDUNDANCY" for Reduced Redundancy.
                        type: string
                    type: object
                  type:
                    type: string
                required:
                - type
                type: object
              tarDisableFsync:
                description: 'Disable calling fsync after writing files when extracting
                  tar files. Default: false.'
                type: boolean
              tarSizeThreshold:
                description: 'Threshold in bytes is size of one backup bundle. Default:
                  1073741823.'
                format: int64
                type: integer
              uploadConcurrency:
                description: How many concurrency streams to use during backup uploading.
                  Default value is evaluated at runtime
                type: integer
              uploadDiskConcurrency:
                description: How many concurrency streams are reading disk during
                  backup uploading. Default value is evaluated at runtime
                type: integer
              uploadDiskRateLimitBytesPerSecond:
                description: Disk read rate limit during backup creation in bytes
                  per second. Default value is evaluated at runtime
                type: integer
              uploadNetworkRateLimitBytesPerSecond:
                description: Network upload rate limit during backup uploading in
                  bytes per second. Default value is evaluated at runtime
                type: integer
              walg:
                description: WAL-G runtime configuration overrides
                properties:
                  aliveCheckInterval:
                    description: WAL-G alive check interval value, e.g. "30s". Default
                      value is evaluated at runtime.
                    type: string
                  compressionMethod:
                    description: |-
                      Compression method used by WAL-G, e.g. "lz4", "brotli" or "zstd".
                      Default value is evaluated at runtime.
                    type: string
                  deltaMaxSteps:
                    description: Determines how many delta backups can be between
                      full backups. Default value is evaluated at runtime.
                    type: integer
                  diskRateLimitBytesPerSecond:
                    description: Disk read rate limit during backup creation in bytes
                      per second. Default value is evaluated at runtime.
                    type: integer
                  downloadConcurrency:
                    description: How many goroutines to use during backup && wal downloading.
                      Default value is evaluated at runtime.
                    type: integer
                  downloadFileRetries:
                    description: How many times failed file will be retried during
                      backup / wal download. Default value is evaluated at runtime.
                    type: integer
                  failoverStoragesCacheLifetime:
                    description: WAL-G failover storages cache lifetime value, e.g.
                      "0m". Default value is evaluated at runtime.
                    type: string
                  failoverStoragesCheck:
                    description: Whether WAL-G should check failover storages. Default
                      value is evaluated at runtime.
                    type: boolean
                  failoverStoragesCheckSize:
                    description: WAL-G failover storages check size value, e.g. "1KB".
                      Default value is evaluated at runtime.
                    type: string
                  goMaxProcs:
                    description: GOMAXPROCS value used by WAL-G. Default value is
                      evaluated at runtime.
                    type: integer
                  networkRateLimitBytesPerSecond:
                    description: Network upload rate limit during backup uploading
                      in bytes per second. Default value is evaluated at runtime.
                    type: integer
                  preventWalOverwrite:
                    description: Whether WAL-G should prevent WAL overwrite. Default
                      value is evaluated at runtime.
                    type: boolean
                  tarDisableFsync:
                    description: Disable calling fsync after writing files when extracting
                      tar files. Default value is evaluated at runtime.
                    type: boolean
                  tarSizeThreshold:
                    description: Threshold in bytes is size of one backup bundle.
                      Default value is evaluated at runtime.
                    format: int64
                    type: integer
                  totalBgUploadedLimit:
                    description: Limit of files uploaded in background by WAL-G. Default
                      value is evaluated at runtime.
                    type: integer
                  uploadConcurrency:
                    description: How many concurrency streams to use during backup
                      uploading. Default value is evaluated at runtime.
                    type: integer
                  uploadDiskConcurrency:
                    description: How many concurrency streams are reading disk during
                      backup uploading. Default value is evaluated at runtime.
                    type: integer
                type: object
            required:
            - storage
            type: object
          status:
            description: BackupConfigStatus defines the observed state of BackupConfig.
            properties:
              conditions:
                description: Conditions represent the latest available observations
                  of the BackupConfig state
                items:
                  description: Condition contains details for one aspect of the current
                    state of this API Resource.
                  properties:
                    lastTransitionTime:
                      description: |-
                        lastTransitionTime is the last time the condition transitioned from one status to another.
                        This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
                      format: date-time
                      type: string
                    message:
                      description: |-
                        message is a human readable message indicating details about the transition.
                        This may be an empty string.
                      maxLength: 32768
                      type: string
                    observedGeneration:
                      description: |-
                        observedGeneration represents the .metadata.generation that the condition was set based upon.
                        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
                        with respect to the current state of the instance.
                      format: int64
                      minimum: 0
                      type: integer
                    reason:
                      description: |-
                        reason contains a programmatic identifier indicating the reason for the condition's last transition.
                        Producers of specific condition types may define expected values and meanings for this field,
                        and whether the values are considered a guaranteed API.
                        The value should be a CamelCase string.
                        This field may not be empty.
                      maxLength: 1024
                      minLength: 1
                      pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
                      type: string
                    status:
                      description: status of the condition, one of True, False, Unknown.
                      enum:
                      - "True"
                      - "False"
                      - Unknown
                      type: string
                    type:
                      description: type of condition in CamelCase or in foo.example.com/CamelCase.
                      maxLength: 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])$
                      type: string
                  required:
                  - lastTransitionTime
                  - message
                  - reason
                  - status
                  - type
                  type: object
                type: array
                x-kubernetes-list-map-keys:
                - type
                x-kubernetes-list-type: map
              consumedStorage:
                description: Consumed storage space breakdown by category (total,
                  WAL)
                properties:
                  backups:
                    description: Human-readable representation of base backups consumed
                      storage space (e.g. "1.50 GiB", "256.00 MiB")
                    type: string
                  backupsBytes:
                    description: Storage space consumed by base backups in bytes
                    format: int64
                    type: integer
                  total:
                    description: Human-readable representation of total consumed storage
                      space (e.g. "1.50 GiB", "256.00 MiB")
                    type: string
                  totalBytes:
                    description: Total storage space consumed by backups and WAL files
                      in bytes
                    format: int64
                    type: integer
                  wal:
                    description: Human-readable representation of WAL consumed storage
                      space (e.g. "1.50 GiB", "256.00 MiB")
                    type: string
                  walBytes:
                    description: Storage space consumed by WAL files in bytes
                    format: int64
                    type: integer
                type: object
              firstRecoverabilityPoint:
                description: |-
                  First recoverability point, the earliest point in time to which
                  the database can be restored using available backups and WAL files
                format: date-time
                type: string
              lastFailedBackup:
                description: Timestamp of the last failed backup
                format: date-time
                type: string
              lastSuccessfulBackup:
                description: Timestamp of the last successful backup
                format: date-time
                type: string
              phase:
                description: Overall status of the BackupConfig
                enum:
                - Healthy
                - Degraded
                - Failed
                - Unknown
                type: string
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}