dataprotection.kubeblocks.io_backuppolicies.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.14.0
  labels:
    app.kubernetes.io/name: kubeblocks
  name: backuppolicies.dataprotection.kubeblocks.io
spec:
  group: dataprotection.kubeblocks.io
  names:
    categories:
    - kubeblocks
    kind: BackupPolicy
    listKind: BackupPolicyList
    plural: backuppolicies
    shortNames:
    - bp
    singular: backuppolicy
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
    - jsonPath: .spec.backupRepoName
      name: BACKUP-REPO
      type: string
    - jsonPath: .status.phase
      name: STATUS
      type: string
    - jsonPath: .metadata.creationTimestamp
      name: AGE
      type: date
    name: v1alpha1
    schema:
      openAPIV3Schema:
        description: BackupPolicy is the Schema for the backuppolicies 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: BackupPolicySpec defines the desired state of BackupPolicy
            properties:
              backoffLimit:
                default: 2
                description: Specifies the number of retries before marking the backup
                  as failed.
                format: int32
                maximum: 10
                minimum: 0
                type: integer
              backupMethods:
                description: Defines the backup methods.
                items:
                  description: BackupMethod defines the backup method.
                  properties:
                    actionSetName:
                      description: |-
                        Refers to the ActionSet object that defines the backup actions.
                        For volume snapshot backup, the actionSet is not required, the controller
                        will use the CSI volume snapshotter to create the snapshot.
                      type: string
                    compatibleMethod:
                      description: The name of the compatible full backup method,
                        used by incremental backups.
                      pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                      type: string
                    env:
                      description: Specifies the environment variables for the backup
                        workload.
                      items:
                        description: EnvVar represents an environment variable present
                          in a Container.
                        properties:
                          name:
                            description: Name of the environment variable. Must be
                              a C_IDENTIFIER.
                            type: string
                          value:
                            description: |-
                              Variable references $(VAR_NAME) are expanded
                              using the previously defined environment variables in the container and
                              any service environment variables. If a variable cannot be resolved,
                              the reference in the input string will be unchanged. Double $$ are reduced
                              to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
                              "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
                              Escaped references will never be expanded, regardless of whether the variable
                              exists or not.
                              Defaults to "".
                            type: string
                          valueFrom:
                            description: Source for the environment variable's value.
                              Cannot be used if value is not empty.
                            properties:
                              configMapKeyRef:
                                description: Selects a key of a ConfigMap.
                                properties:
                                  key:
                                    description: The key to select.
                                    type: string
                                  name:
                                    description: |-
                                      Name of the referent.
                                      More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                      TODO: Add other useful fields. apiVersion, kind, uid?
                                    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
                              fieldRef:
                                description: |-
                                  Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
                                  spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
                                properties:
                                  apiVersion:
                                    description: Version of the schema the FieldPath
                                      is written in terms of, defaults to "v1".
                                    type: string
                                  fieldPath:
                                    description: Path of the field to select in the
                                      specified API version.
                                    type: string
                                required:
                                - fieldPath
                                type: object
                                x-kubernetes-map-type: atomic
                              resourceFieldRef:
                                description: |-
                                  Selects a resource of the container: only resources limits and requests
                                  (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
                                properties:
                                  containerName:
                                    description: 'Container name: required for volumes,
                                      optional for env vars'
                                    type: string
                                  divisor:
                                    anyOf:
                                    - type: integer
                                    - type: string
                                    description: Specifies the output format of the
                                      exposed resources, defaults to "1"
                                    pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                                    x-kubernetes-int-or-string: true
                                  resource:
                                    description: 'Required: resource to select'
                                    type: string
                                required:
                                - resource
                                type: object
                                x-kubernetes-map-type: atomic
                              secretKeyRef:
                                description: Selects a key of a secret in the pod's
                                  namespace
                                properties:
                                  key:
                                    description: The key of the secret to select from.  Must
                                      be a valid secret key.
                                    type: string
                                  name:
                                    description: |-
                                      Name of the referent.
                                      More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                                      TODO: Add other useful fields. apiVersion, kind, uid?
                                    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
                        required:
                        - name
                        type: object
                      type: array
                    name:
                      description: The name of backup method.
                      pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                      type: string
                    runtimeSettings:
                      description: Specifies runtime settings for the backup workload
                        container.
                      properties:
                        resources:
                          description: |-
                            Specifies the resource required by container.
                            More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
                          properties:
                            claims:
                              description: |-
                                Claims lists the names of resources, defined in spec.resourceClaims,
                                that are used by this container.


                                This is an alpha field and requires enabling 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
                                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
                      type: object
                    snapshotVolumes:
                      default: false
                      description: |-
                        Specifies whether to take snapshots of persistent volumes. If true,
                        the ActionSetName is not required, the controller will use the CSI volume
                        snapshotter to create the snapshot.
                      type: boolean
                    target:
                      description: Specifies the target information to back up, it
                        will override the target in backup policy.
                      properties:
                        connectionCredential:
                          description: Specifies the connection credential to connect
                            to the target database cluster.
                          properties:
                            hostKey:
                              description: Specifies the map key of the host in the
                                connection credential secret.
                              type: string
                            passwordKey:
                              default: password
                              description: |-
                                Specifies the map key of the password in the connection credential secret.
                                This password will be saved in the backup annotation for full backup.
                                You can use the environment variable DP_ENCRYPTION_KEY to specify encryption key.
                              type: string
                            portKey:
                              description: Specifies the map key of the port in the
                                connection credential secret.
                              type: string
                            secretName:
                              description: Refers to the Secret object that contains
                                the connection credential.
                              pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                              type: string
                            usernameKey:
                              default: username
                              description: Specifies the map key of the user in the
                                connection credential secret.
                              type: string
                          required:
                          - secretName
                          type: object
                        containerPort:
                          description: |-
                            Specifies the container port in the target pod.
                            If not specified, the first container and its first port will be used.
                          properties:
                            containerName:
                              description: Specifies the name of container with the
                                port.
                              type: string
                            portName:
                              description: Specifies the port name.
                              type: string
                          type: object
                        name:
                          description: |-
                            Specifies a mandatory and unique identifier for each target when using the "targets" field.
                            The backup data for the current target is stored in a uniquely named subdirectory.
                          type: string
                        podSelector:
                          description: Used to find the target pod. The volumes of
                            the target pod will be backed up.
                          properties:
                            fallbackLabelSelector:
                              description: |-
                                fallbackLabelSelector is used to filter available pods when the labelSelector fails.
                                This only takes effect when the `strategy` field below is set to `Any`.
                              properties:
                                matchExpressions:
                                  description: matchExpressions is a list of label
                                    selector requirements. The requirements are ANDed.
                                  items:
                                    description: |-
                                      A label selector requirement is a selector that contains values, a key, and an operator that
                                      relates the key and values.
                                    properties:
                                      key:
                                        description: key is the label key that the
                                          selector applies to.
                                        type: string
                                      operator:
                                        description: |-
                                          operator represents a key's relationship to a set of values.
                                          Valid operators are In, NotIn, Exists and DoesNotExist.
                                        type: string
                                      values:
                                        description: |-
                                          values is an array of string values. If the operator is In or NotIn,
                                          the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                          the values array must be empty. This array is replaced during a strategic
                                          merge patch.
                                        items:
                                          type: string
                                        type: array
                                    required:
                                    - key
                                    - operator
                                    type: object
                                  type: array
                                matchLabels:
                                  additionalProperties:
                                    type: string
                                  description: |-
                                    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                    map is equivalent to an element of matchExpressions, whose key field is "key", the
                                    operator is "In", and the values array contains only "value". The requirements are ANDed.
                                  type: object
                              type: object
                              x-kubernetes-map-type: atomic
                            matchExpressions:
                              description: matchExpressions is a list of label selector
                                requirements. The requirements are ANDed.
                              items:
                                description: |-
                                  A label selector requirement is a selector that contains values, a key, and an operator that
                                  relates the key and values.
                                properties:
                                  key:
                                    description: key is the label key that the selector
                                      applies to.
                                    type: string
                                  operator:
                                    description: |-
                                      operator represents a key's relationship to a set of values.
                                      Valid operators are In, NotIn, Exists and DoesNotExist.
                                    type: string
                                  values:
                                    description: |-
                                      values is an array of string values. If the operator is In or NotIn,
                                      the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                      the values array must be empty. This array is replaced during a strategic
                                      merge patch.
                                    items:
                                      type: string
                                    type: array
                                required:
                                - key
                                - operator
                                type: object
                              type: array
                            matchLabels:
                              additionalProperties:
                                type: string
                              description: |-
                                matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                map is equivalent to an element of matchExpressions, whose key field is "key", the
                                operator is "In", and the values array contains only "value". The requirements are ANDed.
                              type: object
                            strategy:
                              default: Any
                              description: |-
                                Specifies the strategy to select the target pod when multiple pods are selected.
                                Valid values are:


                                - `Any`: select any one pod that match the labelsSelector.
                                - `All`: select all pods that match the labelsSelector. The backup data for the current pod
                                will be stored in a subdirectory named after the pod.
                              enum:
                              - Any
                              - All
                              type: string
                          type: object
                          x-kubernetes-map-type: atomic
                        resources:
                          description: Specifies the kubernetes resources to back
                            up.
                          properties:
                            excluded:
                              description: |-
                                excluded is a slice of namespaced-scoped resource type names to exclude in
                                the kubernetes resources.
                                The default value is empty.
                              items:
                                type: string
                              type: array
                            included:
                              description: |-
                                included is a slice of namespaced-scoped resource type names to include in
                                the kubernetes resources.
                                The default value is empty.
                              items:
                                type: string
                              type: array
                            selector:
                              description: |-
                                A metav1.LabelSelector to filter the target kubernetes resources that need
                                to be backed up. If not set, will do not back up any kubernetes resources.
                              properties:
                                matchExpressions:
                                  description: matchExpressions is a list of label
                                    selector requirements. The requirements are ANDed.
                                  items:
                                    description: |-
                                      A label selector requirement is a selector that contains values, a key, and an operator that
                                      relates the key and values.
                                    properties:
                                      key:
                                        description: key is the label key that the
                                          selector applies to.
                                        type: string
                                      operator:
                                        description: |-
                                          operator represents a key's relationship to a set of values.
                                          Valid operators are In, NotIn, Exists and DoesNotExist.
                                        type: string
                                      values:
                                        description: |-
                                          values is an array of string values. If the operator is In or NotIn,
                                          the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                          the values array must be empty. This array is replaced during a strategic
                                          merge patch.
                                        items:
                                          type: string
                                        type: array
                                    required:
                                    - key
                                    - operator
                                    type: object
                                  type: array
                                matchLabels:
                                  additionalProperties:
                                    type: string
                                  description: |-
                                    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                    map is equivalent to an element of matchExpressions, whose key field is "key", the
                                    operator is "In", and the values array contains only "value". The requirements are ANDed.
                                  type: object
                              type: object
                              x-kubernetes-map-type: atomic
                          type: object
                        serviceAccountName:
                          description: Specifies the service account to run the backup
                            workload.
                          type: string
                      type: object
                    targetVolumes:
                      description: Specifies which volumes from the target should
                        be mounted in the backup workload.
                      properties:
                        volumeMounts:
                          description: Specifies the mount for the volumes specified
                            in `volumes` section.
                          items:
                            description: VolumeMount describes a mounting of a Volume
                              within a container.
                            properties:
                              mountPath:
                                description: |-
                                  Path within the container at which the volume should be mounted.  Must
                                  not contain ':'.
                                type: string
                              mountPropagation:
                                description: |-
                                  mountPropagation determines how mounts are propagated from the host
                                  to container and the other way around.
                                  When not set, MountPropagationNone is used.
                                  This field is beta in 1.10.
                                type: string
                              name:
                                description: This must match the Name of a Volume.
                                type: string
                              readOnly:
                                description: |-
                                  Mounted read-only if true, read-write otherwise (false or unspecified).
                                  Defaults to false.
                                type: boolean
                              subPath:
                                description: |-
                                  Path within the volume from which the container's volume should be mounted.
                                  Defaults to "" (volume's root).
                                type: string
                              subPathExpr:
                                description: |-
                                  Expanded path within the volume from which the container's volume should be mounted.
                                  Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
                                  Defaults to "" (volume's root).
                                  SubPathExpr and SubPath are mutually exclusive.
                                type: string
                            required:
                            - mountPath
                            - name
                            type: object
                          type: array
                        volumes:
                          description: |-
                            Specifies the list of volumes of targeted application that should be mounted
                            on the backup workload.
                          items:
                            type: string
                          type: array
                      type: object
                    targets:
                      description: |-
                        Specifies multiple target information for backup operations. This includes details
                        such as the target pod and cluster connection credentials. All specified targets
                        will be backed up collectively.
                      items:
                        properties:
                          connectionCredential:
                            description: Specifies the connection credential to connect
                              to the target database cluster.
                            properties:
                              hostKey:
                                description: Specifies the map key of the host in
                                  the connection credential secret.
                                type: string
                              passwordKey:
                                default: password
                                description: |-
                                  Specifies the map key of the password in the connection credential secret.
                                  This password will be saved in the backup annotation for full backup.
                                  You can use the environment variable DP_ENCRYPTION_KEY to specify encryption key.
                                type: string
                              portKey:
                                description: Specifies the map key of the port in
                                  the connection credential secret.
                                type: string
                              secretName:
                                description: Refers to the Secret object that contains
                                  the connection credential.
                                pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                                type: string
                              usernameKey:
                                default: username
                                description: Specifies the map key of the user in
                                  the connection credential secret.
                                type: string
                            required:
                            - secretName
                            type: object
                          containerPort:
                            description: |-
                              Specifies the container port in the target pod.
                              If not specified, the first container and its first port will be used.
                            properties:
                              containerName:
                                description: Specifies the name of container with
                                  the port.
                                type: string
                              portName:
                                description: Specifies the port name.
                                type: string
                            type: object
                          name:
                            description: |-
                              Specifies a mandatory and unique identifier for each target when using the "targets" field.
                              The backup data for the current target is stored in a uniquely named subdirectory.
                            type: string
                          podSelector:
                            description: Used to find the target pod. The volumes
                              of the target pod will be backed up.
                            properties:
                              fallbackLabelSelector:
                                description: |-
                                  fallbackLabelSelector is used to filter available pods when the labelSelector fails.
                                  This only takes effect when the `strategy` field below is set to `Any`.
                                properties:
                                  matchExpressions:
                                    description: matchExpressions is a list of label
                                      selector requirements. The requirements are
                                      ANDed.
                                    items:
                                      description: |-
                                        A label selector requirement is a selector that contains values, a key, and an operator that
                                        relates the key and values.
                                      properties:
                                        key:
                                          description: key is the label key that the
                                            selector applies to.
                                          type: string
                                        operator:
                                          description: |-
                                            operator represents a key's relationship to a set of values.
                                            Valid operators are In, NotIn, Exists and DoesNotExist.
                                          type: string
                                        values:
                                          description: |-
                                            values is an array of string values. If the operator is In or NotIn,
                                            the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                            the values array must be empty. This array is replaced during a strategic
                                            merge patch.
                                          items:
                                            type: string
                                          type: array
                                      required:
                                      - key
                                      - operator
                                      type: object
                                    type: array
                                  matchLabels:
                                    additionalProperties:
                                      type: string
                                    description: |-
                                      matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                      map is equivalent to an element of matchExpressions, whose key field is "key", the
                                      operator is "In", and the values array contains only "value". The requirements are ANDed.
                                    type: object
                                type: object
                                x-kubernetes-map-type: atomic
                              matchExpressions:
                                description: matchExpressions is a list of label selector
                                  requirements. The requirements are ANDed.
                                items:
                                  description: |-
                                    A label selector requirement is a selector that contains values, a key, and an operator that
                                    relates the key and values.
                                  properties:
                                    key:
                                      description: key is the label key that the selector
                                        applies to.
                                      type: string
                                    operator:
                                      description: |-
                                        operator represents a key's relationship to a set of values.
                                        Valid operators are In, NotIn, Exists and DoesNotExist.
                                      type: string
                                    values:
                                      description: |-
                                        values is an array of string values. If the operator is In or NotIn,
                                        the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                        the values array must be empty. This array is replaced during a strategic
                                        merge patch.
                                      items:
                                        type: string
                                      type: array
                                  required:
                                  - key
                                  - operator
                                  type: object
                                type: array
                              matchLabels:
                                additionalProperties:
                                  type: string
                                description: |-
                                  matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                  map is equivalent to an element of matchExpressions, whose key field is "key", the
                                  operator is "In", and the values array contains only "value". The requirements are ANDed.
                                type: object
                              strategy:
                                default: Any
                                description: |-
                                  Specifies the strategy to select the target pod when multiple pods are selected.
                                  Valid values are:


                                  - `Any`: select any one pod that match the labelsSelector.
                                  - `All`: select all pods that match the labelsSelector. The backup data for the current pod
                                  will be stored in a subdirectory named after the pod.
                                enum:
                                - Any
                                - All
                                type: string
                            type: object
                            x-kubernetes-map-type: atomic
                          resources:
                            description: Specifies the kubernetes resources to back
                              up.
                            properties:
                              excluded:
                                description: |-
                                  excluded is a slice of namespaced-scoped resource type names to exclude in
                                  the kubernetes resources.
                                  The default value is empty.
                                items:
                                  type: string
                                type: array
                              included:
                                description: |-
                                  included is a slice of namespaced-scoped resource type names to include in
                                  the kubernetes resources.
                                  The default value is empty.
                                items:
                                  type: string
                                type: array
                              selector:
                                description: |-
                                  A metav1.LabelSelector to filter the target kubernetes resources that need
                                  to be backed up. If not set, will do not back up any kubernetes resources.
                                properties:
                                  matchExpressions:
                                    description: matchExpressions is a list of label
                                      selector requirements. The requirements are
                                      ANDed.
                                    items:
                                      description: |-
                                        A label selector requirement is a selector that contains values, a key, and an operator that
                                        relates the key and values.
                                      properties:
                                        key:
                                          description: key is the label key that the
                                            selector applies to.
                                          type: string
                                        operator:
                                          description: |-
                                            operator represents a key's relationship to a set of values.
                                            Valid operators are In, NotIn, Exists and DoesNotExist.
                                          type: string
                                        values:
                                          description: |-
                                            values is an array of string values. If the operator is In or NotIn,
                                            the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                            the values array must be empty. This array is replaced during a strategic
                                            merge patch.
                                          items:
                                            type: string
                                          type: array
                                      required:
                                      - key
                                      - operator
                                      type: object
                                    type: array
                                  matchLabels:
                                    additionalProperties:
                                      type: string
                                    description: |-
                                      matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                      map is equivalent to an element of matchExpressions, whose key field is "key", the
                                      operator is "In", and the values array contains only "value". The requirements are ANDed.
                                    type: object
                                type: object
                                x-kubernetes-map-type: atomic
                            type: object
                          serviceAccountName:
                            description: Specifies the service account to run the
                              backup workload.
                            type: string
                        type: object
                      type: array
                  required:
                  - name
                  type: object
                type: array
              backupRepoName:
                description: |-
                  Specifies the name of BackupRepo where the backup data will be stored.
                  If not set, data will be stored in the default backup repository.
                pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                type: string
              encryptionConfig:
                description: |-
                  Specifies the parameters for encrypting backup data.
                  Encryption will be disabled if the field is not set.
                properties:
                  algorithm:
                    default: AES-256-CFB
                    description: |-
                      Specifies the encryption algorithm. Currently supported algorithms are:


                      - AES-128-CFB
                      - AES-192-CFB
                      - AES-256-CFB
                    enum:
                    - AES-128-CFB
                    - AES-192-CFB
                    - AES-256-CFB
                    type: string
                  passPhraseSecretKeyRef:
                    description: |-
                      Selects the key of a secret in the current namespace, the value of the secret
                      is used as the encryption key.
                    properties:
                      key:
                        description: The key of the secret to select from.  Must be
                          a valid secret key.
                        type: string
                      name:
                        description: |-
                          Name of the referent.
                          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                          TODO: Add other useful fields. apiVersion, kind, uid?
                        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
                required:
                - algorithm
                - passPhraseSecretKeyRef
                type: object
              pathPrefix:
                description: |-
                  Specifies the directory inside the backup repository to store the backup.
                  This path is relative to the path of the backup repository.
                type: string
              target:
                description: |-
                  Specifies the target information to back up, such as the target pod, the
                  cluster connection credential.
                properties:
                  connectionCredential:
                    description: Specifies the connection credential to connect to
                      the target database cluster.
                    properties:
                      hostKey:
                        description: Specifies the map key of the host in the connection
                          credential secret.
                        type: string
                      passwordKey:
                        default: password
                        description: |-
                          Specifies the map key of the password in the connection credential secret.
                          This password will be saved in the backup annotation for full backup.
                          You can use the environment variable DP_ENCRYPTION_KEY to specify encryption key.
                        type: string
                      portKey:
                        description: Specifies the map key of the port in the connection
                          credential secret.
                        type: string
                      secretName:
                        description: Refers to the Secret object that contains the
                          connection credential.
                        pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                        type: string
                      usernameKey:
                        default: username
                        description: Specifies the map key of the user in the connection
                          credential secret.
                        type: string
                    required:
                    - secretName
                    type: object
                  containerPort:
                    description: |-
                      Specifies the container port in the target pod.
                      If not specified, the first container and its first port will be used.
                    properties:
                      containerName:
                        description: Specifies the name of container with the port.
                        type: string
                      portName:
                        description: Specifies the port name.
                        type: string
                    type: object
                  name:
                    description: |-
                      Specifies a mandatory and unique identifier for each target when using the "targets" field.
                      The backup data for the current target is stored in a uniquely named subdirectory.
                    type: string
                  podSelector:
                    description: Used to find the target pod. The volumes of the target
                      pod will be backed up.
                    properties:
                      fallbackLabelSelector:
                        description: |-
                          fallbackLabelSelector is used to filter available pods when the labelSelector fails.
                          This only takes effect when the `strategy` field below is set to `Any`.
                        properties:
                          matchExpressions:
                            description: matchExpressions is a list of label selector
                              requirements. The requirements are ANDed.
                            items:
                              description: |-
                                A label selector requirement is a selector that contains values, a key, and an operator that
                                relates the key and values.
                              properties:
                                key:
                                  description: key is the label key that the selector
                                    applies to.
                                  type: string
                                operator:
                                  description: |-
                                    operator represents a key's relationship to a set of values.
                                    Valid operators are In, NotIn, Exists and DoesNotExist.
                                  type: string
                                values:
                                  description: |-
                                    values is an array of string values. If the operator is In or NotIn,
                                    the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                    the values array must be empty. This array is replaced during a strategic
                                    merge patch.
                                  items:
                                    type: string
                                  type: array
                              required:
                              - key
                              - operator
                              type: object
                            type: array
                          matchLabels:
                            additionalProperties:
                              type: string
                            description: |-
                              matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                              map is equivalent to an element of matchExpressions, whose key field is "key", the
                              operator is "In", and the values array contains only "value". The requirements are ANDed.
                            type: object
                        type: object
                        x-kubernetes-map-type: atomic
                      matchExpressions:
                        description: matchExpressions is a list of label selector
                          requirements. The requirements are ANDed.
                        items:
                          description: |-
                            A label selector requirement is a selector that contains values, a key, and an operator that
                            relates the key and values.
                          properties:
                            key:
                              description: key is the label key that the selector
                                applies to.
                              type: string
                            operator:
                              description: |-
                                operator represents a key's relationship to a set of values.
                                Valid operators are In, NotIn, Exists and DoesNotExist.
                              type: string
                            values:
                              description: |-
                                values is an array of string values. If the operator is In or NotIn,
                                the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                the values array must be empty. This array is replaced during a strategic
                                merge patch.
                              items:
                                type: string
                              type: array
                          required:
                          - key
                          - operator
                          type: object
                        type: array
                      matchLabels:
                        additionalProperties:
                          type: string
                        description: |-
                          matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                          map is equivalent to an element of matchExpressions, whose key field is "key", the
                          operator is "In", and the values array contains only "value". The requirements are ANDed.
                        type: object
                      strategy:
                        default: Any
                        description: |-
                          Specifies the strategy to select the target pod when multiple pods are selected.
                          Valid values are:


                          - `Any`: select any one pod that match the labelsSelector.
                          - `All`: select all pods that match the labelsSelector. The backup data for the current pod
                          will be stored in a subdirectory named after the pod.
                        enum:
                        - Any
                        - All
                        type: string
                    type: object
                    x-kubernetes-map-type: atomic
                  resources:
                    description: Specifies the kubernetes resources to back up.
                    properties:
                      excluded:
                        description: |-
                          excluded is a slice of namespaced-scoped resource type names to exclude in
                          the kubernetes resources.
                          The default value is empty.
                        items:
                          type: string
                        type: array
                      included:
                        description: |-
                          included is a slice of namespaced-scoped resource type names to include in
                          the kubernetes resources.
                          The default value is empty.
                        items:
                          type: string
                        type: array
                      selector:
                        description: |-
                          A metav1.LabelSelector to filter the target kubernetes resources that need
                          to be backed up. If not set, will do not back up any kubernetes resources.
                        properties:
                          matchExpressions:
                            description: matchExpressions is a list of label selector
                              requirements. The requirements are ANDed.
                            items:
                              description: |-
                                A label selector requirement is a selector that contains values, a key, and an operator that
                                relates the key and values.
                              properties:
                                key:
                                  description: key is the label key that the selector
                                    applies to.
                                  type: string
                                operator:
                                  description: |-
                                    operator represents a key's relationship to a set of values.
                                    Valid operators are In, NotIn, Exists and DoesNotExist.
                                  type: string
                                values:
                                  description: |-
                                    values is an array of string values. If the operator is In or NotIn,
                                    the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                    the values array must be empty. This array is replaced during a strategic
                                    merge patch.
                                  items:
                                    type: string
                                  type: array
                              required:
                              - key
                              - operator
                              type: object
                            type: array
                          matchLabels:
                            additionalProperties:
                              type: string
                            description: |-
                              matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                              map is equivalent to an element of matchExpressions, whose key field is "key", the
                              operator is "In", and the values array contains only "value". The requirements are ANDed.
                            type: object
                        type: object
                        x-kubernetes-map-type: atomic
                    type: object
                  serviceAccountName:
                    description: Specifies the service account to run the backup workload.
                    type: string
                type: object
              targets:
                description: |-
                  Specifies multiple target information for backup operations. This includes details
                  such as the target pod and cluster connection credentials. All specified targets
                  will be backed up collectively.
                  optional
                items:
                  properties:
                    connectionCredential:
                      description: Specifies the connection credential to connect
                        to the target database cluster.
                      properties:
                        hostKey:
                          description: Specifies the map key of the host in the connection
                            credential secret.
                          type: string
                        passwordKey:
                          default: password
                          description: |-
                            Specifies the map key of the password in the connection credential secret.
                            This password will be saved in the backup annotation for full backup.
                            You can use the environment variable DP_ENCRYPTION_KEY to specify encryption key.
                          type: string
                        portKey:
                          description: Specifies the map key of the port in the connection
                            credential secret.
                          type: string
                        secretName:
                          description: Refers to the Secret object that contains the
                            connection credential.
                          pattern: ^[a-z0-9]([a-z0-9\.\-]*[a-z0-9])?$
                          type: string
                        usernameKey:
                          default: username
                          description: Specifies the map key of the user in the connection
                            credential secret.
                          type: string
                      required:
                      - secretName
                      type: object
                    containerPort:
                      description: |-
                        Specifies the container port in the target pod.
                        If not specified, the first container and its first port will be used.
                      properties:
                        containerName:
                          description: Specifies the name of container with the port.
                          type: string
                        portName:
                          description: Specifies the port name.
                          type: string
                      type: object
                    name:
                      description: |-
                        Specifies a mandatory and unique identifier for each target when using the "targets" field.
                        The backup data for the current target is stored in a uniquely named subdirectory.
                      type: string
                    podSelector:
                      description: Used to find the target pod. The volumes of the
                        target pod will be backed up.
                      properties:
                        fallbackLabelSelector:
                          description: |-
                            fallbackLabelSelector is used to filter available pods when the labelSelector fails.
                            This only takes effect when the `strategy` field below is set to `Any`.
                          properties:
                            matchExpressions:
                              description: matchExpressions is a list of label selector
                                requirements. The requirements are ANDed.
                              items:
                                description: |-
                                  A label selector requirement is a selector that contains values, a key, and an operator that
                                  relates the key and values.
                                properties:
                                  key:
                                    description: key is the label key that the selector
                                      applies to.
                                    type: string
                                  operator:
                                    description: |-
                                      operator represents a key's relationship to a set of values.
                                      Valid operators are In, NotIn, Exists and DoesNotExist.
                                    type: string
                                  values:
                                    description: |-
                                      values is an array of string values. If the operator is In or NotIn,
                                      the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                      the values array must be empty. This array is replaced during a strategic
                                      merge patch.
                                    items:
                                      type: string
                                    type: array
                                required:
                                - key
                                - operator
                                type: object
                              type: array
                            matchLabels:
                              additionalProperties:
                                type: string
                              description: |-
                                matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                map is equivalent to an element of matchExpressions, whose key field is "key", the
                                operator is "In", and the values array contains only "value". The requirements are ANDed.
                              type: object
                          type: object
                          x-kubernetes-map-type: atomic
                        matchExpressions:
                          description: matchExpressions is a list of label selector
                            requirements. The requirements are ANDed.
                          items:
                            description: |-
                              A label selector requirement is a selector that contains values, a key, and an operator that
                              relates the key and values.
                            properties:
                              key:
                                description: key is the label key that the selector
                                  applies to.
                                type: string
                              operator:
                                description: |-
                                  operator represents a key's relationship to a set of values.
                                  Valid operators are In, NotIn, Exists and DoesNotExist.
                                type: string
                              values:
                                description: |-
                                  values is an array of string values. If the operator is In or NotIn,
                                  the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                  the values array must be empty. This array is replaced during a strategic
                                  merge patch.
                                items:
                                  type: string
                                type: array
                            required:
                            - key
                            - operator
                            type: object
                          type: array
                        matchLabels:
                          additionalProperties:
                            type: string
                          description: |-
                            matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                            map is equivalent to an element of matchExpressions, whose key field is "key", the
                            operator is "In", and the values array contains only "value". The requirements are ANDed.
                          type: object
                        strategy:
                          default: Any
                          description: |-
                            Specifies the strategy to select the target pod when multiple pods are selected.
                            Valid values are:


                            - `Any`: select any one pod that match the labelsSelector.
                            - `All`: select all pods that match the labelsSelector. The backup data for the current pod
                            will be stored in a subdirectory named after the pod.
                          enum:
                          - Any
                          - All
                          type: string
                      type: object
                      x-kubernetes-map-type: atomic
                    resources:
                      description: Specifies the kubernetes resources to back up.
                      properties:
                        excluded:
                          description: |-
                            excluded is a slice of namespaced-scoped resource type names to exclude in
                            the kubernetes resources.
                            The default value is empty.
                          items:
                            type: string
                          type: array
                        included:
                          description: |-
                            included is a slice of namespaced-scoped resource type names to include in
                            the kubernetes resources.
                            The default value is empty.
                          items:
                            type: string
                          type: array
                        selector:
                          description: |-
                            A metav1.LabelSelector to filter the target kubernetes resources that need
                            to be backed up. If not set, will do not back up any kubernetes resources.
                          properties:
                            matchExpressions:
                              description: matchExpressions is a list of label selector
                                requirements. The requirements are ANDed.
                              items:
                                description: |-
                                  A label selector requirement is a selector that contains values, a key, and an operator that
                                  relates the key and values.
                                properties:
                                  key:
                                    description: key is the label key that the selector
                                      applies to.
                                    type: string
                                  operator:
                                    description: |-
                                      operator represents a key's relationship to a set of values.
                                      Valid operators are In, NotIn, Exists and DoesNotExist.
                                    type: string
                                  values:
                                    description: |-
                                      values is an array of string values. If the operator is In or NotIn,
                                      the values array must be non-empty. If the operator is Exists or DoesNotExist,
                                      the values array must be empty. This array is replaced during a strategic
                                      merge patch.
                                    items:
                                      type: string
                                    type: array
                                required:
                                - key
                                - operator
                                type: object
                              type: array
                            matchLabels:
                              additionalProperties:
                                type: string
                              description: |-
                                matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
                                map is equivalent to an element of matchExpressions, whose key field is "key", the
                                operator is "In", and the values array contains only "value". The requirements are ANDed.
                              type: object
                          type: object
                          x-kubernetes-map-type: atomic
                      type: object
                    serviceAccountName:
                      description: Specifies the service account to run the backup
                        workload.
                      type: string
                  type: object
                type: array
              useKopia:
                default: false
                description: |-
                  Specifies whether backup data should be stored in a Kopia repository.


                  Data within the Kopia repository is both compressed and encrypted. Furthermore,
                  data deduplication is implemented across various backups of the same cluster.
                  This approach significantly reduces the actual storage usage, particularly
                  for clusters with a low update frequency.


                  NOTE: This feature should NOT be enabled when using KubeBlocks Community Edition, otherwise the backup will not be processed.
                type: boolean
            required:
            - backupMethods
            type: object
            x-kubernetes-validations:
            - message: either spec.target or spec.targets
              rule: (has(self.target) && !has(self.targets)) || (has(self.targets)
                && !has(self.target))
          status:
            description: BackupPolicyStatus defines the observed state of BackupPolicy
            properties:
              message:
                description: |-
                  A human-readable message indicating details about why the BackupPolicy
                  is in this phase.
                type: string
              observedGeneration:
                description: |-
                  ObservedGeneration is the most recent generation observed for this BackupPolicy.
                  It refers to the BackupPolicy's generation, which is updated on mutation by the API Server.
                format: int64
                type: integer
              phase:
                description: Phase - in list of [Available,Unavailable]
                enum:
                - Available
                - Unavailable
                type: string
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}