apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

ActionSet

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

Backup

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

BackupPolicy

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

BackupRepo

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

BackupSchedule

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

Restore

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

apiVersion
string

dataprotection.kubeblocks.io/v1alpha1

kind
string

StorageProvider

metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

status

"Mount"

AccessMethodMount suggests that the storage is mounted locally which allows for remote files to be accessed akin to local ones.

"Tool"

AccessMethodTool indicates the utilization of a command-line tool for accessing the storage.

"Continue"

ActionErrorModeContinue signifies that an error from an action is acceptable and can be ignored.

"Fail"

ActionErrorModeFail signifies that an error from an action is problematic and should be treated as a failure.

"Completed"

ActionPhaseCompleted means the action has run successfully without errors.

"Failed"

ActionPhaseFailed means the action ran but encountered an error that

"New"

ActionPhaseNew means the action has been created but not yet processed by the BackupController.

"Running"

ActionPhaseRunning means the action is currently executing.

openAPIV3Schema

Defines the schema for parameters using the OpenAPI v3. The supported property types include:

• string
• number
• integer
• array: Note that only items of string type are supported.

backupType

Specifies the backup type. Supported values include:

• Full for a full backup.

• Incremental back up data that have changed since the last backup (either full or incremental).

• Differential back up data that has changed since the last full backup.

• Continuous back up transaction logs continuously, such as MySQL binlog, PostgreSQL WAL, etc.

• Selective back up data more precisely, use custom parameters, such as specific databases or tables.

Continuous backup is essential for implementing Point-in-Time Recovery (PITR).

parametersSchema

Specifies the schema of parameters in backups and restores before their usage.

env

Specifies a list of environment variables to be set in the container.

envFrom

Specifies a list of sources to populate environment variables in the container. The keys within a source must be a C_IDENTIFIER. Any invalid keys will be reported as an event when the container starts. If a key exists in multiple sources, the value from the last source will take precedence. Any values defined by an Env with a duplicate key will take precedence.

This field cannot be updated.

backup

Specifies the backup action.

restore

Specifies the restore action.

phase

Indicates the phase of the ActionSet. This can be either ‘Available’ or ‘Unavailable’.

message

Provides a human-readable explanation detailing the reason for the current phase of the ActionSet.

observedGeneration

Represents the generation number that has been observed by the controller.

exec

Specifies that the action should be executed using the pod’s exec API within a container.

job

Specifies that the action should be executed by a Kubernetes Job.

name

The name of the action.

targetPodName

Records the target pod name which has been backed up.

phase

The current phase of the action.

startTimestamp

Records the time an action was started.

completionTimestamp

Records the time an action was completed.

failureReason

An error that caused the action to fail.

actionType

The type of the action.

availableReplicas

Available replicas for statefulSet action.

objectRef

The object reference for the action.

totalSize

The total size of backed up data size. A string with capacity units in the format of “1Gi”, “1Mi”, “1Ki”. If no capacity unit is specified, it is assumed to be in bytes.

timeRange

Records the time range of backed up data, for PITR, this is the time range of recoverable data.

volumeSnapshots

Records the volume snapshot status for the action.

"Job"

""

"StatefulSet"

backupData

Represents the action to be performed for backing up data.

preBackup

Represents a set of actions that should be executed before the backup process begins.

postBackup

Represents a set of actions that should be executed after the backup process has completed.

preDelete

Represents a custom deletion action that can be executed before the built-in deletion action. Note: The preDelete action job will ignore the env/envFrom.

withParameters

Specifies the parameters used by the backup action

JobActionSpec

(Members of JobActionSpec are embedded into this type.)

syncProgress

Determines if the backup progress should be synchronized and the interval for synchronization in seconds.

"Delete"

"Retain"

name

The name of backup method.

compatibleMethod

The name of the compatible full backup method, used by incremental backups.

snapshotVolumes

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.

actionSetName

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.

targetVolumes

Specifies which volumes from the target should be mounted in the backup workload.

env

Specifies the environment variables for the backup workload.

runtimeSettings

Specifies runtime settings for the backup workload container.

target

Specifies the target information to back up, it will override the target in backup policy.

targets

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.

name

The name of backup method.

compatibleMethod

The name of the compatible full backup method, used by incremental backups.

snapshotVolumes

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.

actionSetName

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.

targetVolumes

Specifies which volumes from the target should be mounted in the backup workload.

env

Specifies the environment variables for the backup workload.

runtimeSettings

Specifies runtime settings for the backup workload container.

target

If set, specifies the method for selecting the replica to be backed up using the criteria defined here. If this field is not set, the selection method specified in backupPolicy.target is used.

This field provides a way to override the global backupPolicy.target setting for specific BackupMethod.

"Completed"

BackupPhaseCompleted means the backup has run successfully without errors.

"Deleting"

BackupPhaseDeleting means the backup and all its associated data are being deleted.

"Failed"

BackupPhaseFailed means the backup ran but encountered an error that prevented it from completing successfully.

"New"

BackupPhaseNew means the backup has been created but not yet processed by the BackupController.

"Running"

BackupPhaseRunning means the backup is currently executing.

"Available"

"Failed"

""

BackupPolicyRetentionPolicyNone indicates that no backup retention policy is set.

"retainLatestBackup"

BackupPolicyRetentionPolicyRetainLatestBackup indicates that the latest backup is retained.

backupRepoName

Specifies the name of BackupRepo where the backup data will be stored. If not set, data will be stored in the default backup repository.

pathPrefix

Specifies the directory inside the backup repository to store the backup. This path is relative to the path of the backup repository.

backoffLimit

Specifies the number of retries before marking the backup as failed.

target

Specifies the target information to back up, such as the target pod, the cluster connection credential.

targets

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

backupMethods

Defines the backup methods.

useKopia

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.

encryptionConfig

Specifies the parameters for encrypting backup data. Encryption will be disabled if the field is not set.

retentionPolicy

Specifies the backup retention policy. This has a precedence over backup.spec.retentionPeriod.

phase

Phase - in list of [Available,Unavailable]

message

A human-readable message indicating details about why the BackupPolicy is in this phase.

observedGeneration

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.

metadata

The metadata for the BackupPolicyTemplate object, including name, namespace, labels, and annotations.

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

Defines the desired state of the BackupPolicyTemplate.

status

Populated by the system, it represents the current information about the BackupPolicyTemplate.

serviceKind

Defines the type of well-known service protocol that the BackupPolicyTemplate provides, and it is optional. Some examples of well-known service protocols include:

• “MySQL”: Indicates that the Component provides a MySQL database service.

• “PostgreSQL”: Indicates that the Component offers a PostgreSQL database service.

• “Redis”: Signifies that the Component functions as a Redis key-value store.

• “ETCD”: Denotes that the Component serves as an ETCD distributed key-value store

compDefs

CompDefs specifies names for the component definitions associated with this BackupPolicyTemplate. Each name in the list can represent an exact name, a name prefix, or a regular expression pattern.

For example:

• “mysql-8.0.30-v1alpha1”: Matches the exact name “mysql-8.0.30-v1alpha1”

• “mysql-8.0.30”: Matches all names starting with “mysql-8.0.30”

• ”^mysql-8.0.\d{1,2}$“: Matches all names starting with “mysql-8.0.” followed by one or two digits.

target

Defines the selection criteria of instance to be backed up, and the connection credential to be used during the backup process.

schedules

Defines the execution plans for backup tasks, specifying when and how backups should occur, and the retention period of backup files.

backupMethods

Defines an array of BackupMethods to be used.

backoffLimit

Specifies the maximum number of retry attempts for a backup before it is considered a failure.

retentionPolicy

Defines the backup retention policy to be used.

observedGeneration

Represents the most recent generation observed for this BackupPolicyTemplate.

phase

Specifies the current phase of the BackupPolicyTemplate. Valid values are empty, Available, Unavailable. When Available, the BackupPolicyTemplate is ready and can be referenced by related objects.

message

Provides additional information about the current phase.

name

Specifies the backup name.

namespace

Specifies the backup namespace.

sourceTargetName

Specifies the source target for restoration, identified by its name.

"Deleting"

BackupRepoDeleting indicates the backup repository is being deleted.

"Failed"

BackupRepoFailed indicates the pre-check has been failed.

"PreChecking"

BackupRepoPreChecking indicates the backup repository is being pre-checked.

"Ready"

BackupRepoReady indicates the backup repository is ready for use.

storageProviderRef

Specifies the name of the StorageProvider used by this backup repository.

accessMethod

Specifies the access method of the backup repository.

volumeCapacity

Specifies the capacity of the PVC created by this backup repository.

pvReclaimPolicy

Specifies reclaim policy of the PV created by this backup repository.

config

Stores the non-secret configuration parameters for the StorageProvider.

credential

References to the secret that holds the credentials for the StorageProvider.

pathPrefix

Specifies the prefix of the path for storing backup data.

phase

Represents the current phase of reconciliation for the backup repository. Permissible values are PreChecking, Failed, Ready, Deleting.

conditions

Provides a detailed description of the current state of the backup repository.

observedGeneration

Represents the latest generation of the resource that the controller has observed.

generatedCSIDriverSecret

Refers to the generated secret for the StorageProvider.

generatedStorageClassName

Represents the name of the generated storage class.

backupPVCName

Represents the name of the PVC that stores backup data.

toolConfigSecretName

Represents the name of the secret that contains the configuration for the tool.

isDefault

Indicates if this backup repository is the default one.

"Available"

BackupSchedulePhaseAvailable indicates the backup schedule is available.

"Failed"

BackupSchedulePhaseFailed indicates the backup schedule has failed.

backupPolicyName

Specifies the backupPolicy to be applied for the schedules.

startingDeadlineMinutes

Defines the deadline in minutes for starting the backup workload if it misses its scheduled time for any reason.

schedules

Defines the list of backup schedules.

phase

Describes the phase of the BackupSchedule.

observedGeneration

Represents the most recent generation observed for this BackupSchedule. It refers to the BackupSchedule’s generation, which is updated on mutation by the API Server.

failureReason

Represents an error that caused the backup to fail.

schedules

Describes the status of each schedule.

backupPolicyName

Specifies the backup policy to be applied for this backup.

backupMethod

Specifies the backup method name that is defined in the backup policy.

deletionPolicy

Determines whether the backup contents stored in the backup repository should be deleted when the backup custom resource(CR) is deleted. Supported values are Retain and Delete.

• Retain means that the backup content and its physical snapshot on backup repository are kept.

• Delete means that the backup content and its physical snapshot on backup repository are deleted.

the backup CR but retaining the backup contents in backup repository. The current implementation only prevent accidental deletion of backup data.

retentionPeriod

Determines a duration up to which the backup should be kept. Controller will remove all backups that are older than the RetentionPeriod. If not set, the backup will be kept forever. For example, RetentionPeriod of 30d will keep only the backups of last 30 days. Sample duration format:

• years: 2y

• months: 6mo

• days: 30d

• hours: 12h

• minutes: 30m

You can also combine the above durations. For example: 30d12h30m.

parentBackupName

Determines the parent backup name for incremental or differential backup.

parameters

Specifies a list of name-value pairs representing parameters and their corresponding values. Parameters match the schema specified in the actionset.spec.parametersSchema

formatVersion

Specifies the backup format version, which includes major, minor, and patch versions.

phase

Indicates the current state of the backup operation.

expiration

Indicates when this backup becomes eligible for garbage collection. A ‘null’ value implies that the backup will not be cleaned up unless manually deleted.

startTimestamp

Records the time when the backup operation was started. The server’s time is used for this timestamp.

completionTimestamp

Records the time when the backup operation was completed. This timestamp is recorded even if the backup operation fails. The server’s time is used for this timestamp.

duration

Records the duration of the backup operation. When converted to a string, the format is “1h2m0.5s”.

totalSize

Records the total size of the data backed up. The size is represented as a string with capacity units in the format of “1Gi”, “1Mi”, “1Ki”. If no capacity unit is specified, it is assumed to be in bytes.

failureReason

Any error that caused the backup operation to fail.

backupRepoName

The name of the backup repository.

path

The directory within the backup repository where the backup data is stored. This is an absolute path within the backup repository.

kopiaRepoPath

Records the path of the Kopia repository.

persistentVolumeClaimName

Records the name of the persistent volume claim used to store the backup data.

timeRange

Records the time range of the data backed up. For Point-in-Time Recovery (PITR), this is the time range of recoverable data.

target

Records the target information for this backup.

targets

Records the targets information for this backup.

backupMethod

Records the backup method information for this backup. Refer to BackupMethod for more details.

encryptionConfig

Records the encryption config for this backup.

actions

Records the actions status for this backup.

volumeSnapshots

Records the volume snapshot status for the action.

parentBackupName

Records the parent backup name for incremental or differential backup. When the parent backup is deleted, the backup will also be deleted.

baseBackupName

Records the base full backup name for incremental backup or differential backup. When the base backup is deleted, the backup will also be deleted.

extras

Records any additional information for the backup.

BackupTarget

(Members of BackupTarget are embedded into this type.)

selectedTargetPods

Records the selected pods by the target info during backup.

name

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.

podSelector

Used to find the target pod. The volumes of the target pod will be backed up.

connectionCredential

Specifies the connection credential to connect to the target database cluster.

resources

Specifies the kubernetes resources to back up.

serviceAccountName

Specifies the service account to run the backup workload.

containerPort

Specifies the container port in the target pod. If not specified, the first container and its first port will be used.

timeZone

time zone, supports only zone offset, with a value range of “-12:59 ~ +13:00”.

start

Records the start time of the backup, in Coordinated Universal Time (UTC).

end

Records the end time of the backup, in Coordinated Universal Time (UTC).

"Continuous"

"Differential"

"Full"

"Incremental"

"Selective"

image

Specifies the image of the backup container.

command

Defines the commands to back up the volume data.

secretName

Refers to the Secret object that contains the connection credential.

usernameKey

Specifies the map key of the user in the connection credential secret.

passwordKey

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.

hostKey

Specifies the map key of the host in the connection credential secret.

portKey

Specifies the map key of the port in the connection credential secret.

containerName

Specifies the name of container with the port.

portName

Specifies the port name.

"OneToMany"

"OneToOne"

algorithm

Specifies the encryption algorithm. Currently supported algorithms are:

• AES-128-CFB

• AES-192-CFB

• AES-256-CFB

passPhraseSecretKeyRef

Selects the key of a secret in the current namespace, the value of the secret is used as the encryption key.

name

Specifies the environment variable key.

value

Specifies the environment variable value.

valueFrom

Specifies the source used to determine the value of the environment variable. Cannot be used if value is not empty.

target

Defines the pods that need to be executed for the exec action. Execution will occur on all pods that meet the conditions.

container

Specifies the container within the pod where the command should be executed. If not specified, the first container in the pod is used by default.

command

Defines the command and arguments to be executed.

onError

Indicates how to behave if an error is encountered during the execution of this action.

timeout

Specifies the maximum duration to wait for the hook to complete before considering the execution a failure.

podSelector

Executes kubectl in all selected pods.

groupResource

labelSelector

Selects the specified resource for recovery by label.

requiredPolicyForAllPodSelection

Specifies the restore policy, which is required when the pod selection strategy for the source target is ‘All’. This field is ignored if the pod selection strategy is ‘Any’. optional

target

Defines the pods that needs to be executed for the job action.

BaseJobActionSpec

(Members of BaseJobActionSpec are embedded into this type.)

runOnTargetPodNode

Determines whether to run the job workload on the target pod node. If the backup container needs to mount the target pod’s volumes, this field should be set to true. Otherwise, the target pod’s volumes will be ignored.

onError

Indicates how to behave if an error is encountered during the execution of this action.

podSelector

Selects one of the pods, identified by labels, to build the job spec. This includes mounting required volumes and injecting built-in environment variables of the selected pod.

volumeMounts

Defines which volumes of the selected pod need to be mounted on the restoring pod.

selector

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.

included

included is a slice of namespaced-scoped resource type names to include in the kubernetes resources. The default value is empty.

excluded

excluded is a slice of namespaced-scoped resource type names to exclude in the kubernetes resources. The default value is empty.

name

Represents the name of the parameter.

value

Represents the parameter values.

openAPIV3Schema

Defines the parameters in OpenAPI V3.

credentialFields

Defines which parameters are credential fields, which need to be handled specifically. For instance, these should be stored in a Secret instead of a ConfigMap.

"Available"

"Unavailable"

"All"

PodSelectionStrategyAll selects all pods that match the labelsSelector.

"Any"

PodSelectionStrategyAny selects any one pod that match the labelsSelector.

LabelSelector

(Members of LabelSelector are embedded into this type.)

labelsSelector is the label selector to filter the target pods.

fallbackLabelSelector

fallbackLabelSelector is used to filter available pods when the labelSelector fails. This only takes effect when the strategy field below is set to Any.

strategy

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.

useParentSelectedPods

UseParentSelectedPods indicates whether to use the pods selected by the parent for backup. If set to true, the backup will use the same pods selected by the parent. And only takes effect when the ‘strategy’ is set to ‘Any’.

requiredPolicyForAllPodSelection

Specifies the restore policy, which is required when the pod selection strategy for the source target is ‘All’. This field is ignored if the pod selection strategy is ‘Any’. optional

dataSourceRef

Specifies the configuration when using persistentVolumeClaim.spec.dataSourceRef method for restoring. Describes the source volume of the backup targetVolumes and the mount path in the restoring container.

volumeClaims

Defines the persistent Volume claims that need to be restored and mounted together into the restore job. These persistent Volume claims will be created if they do not exist.

volumeClaimsTemplate

Defines a template to build persistent Volume claims that need to be restored. These claims will be created in an orderly manner based on the number of replicas or reused if they already exist.

volumeClaimRestorePolicy

Defines restore policy for persistent volume claim. Supported policies are as follows:

• Parallel: parallel recovery of persistent volume claim.

• Serial: restore the persistent volume claim in sequence, and wait until the previous persistent volume claim is restored before restoring a new one.

schedulingSpec

Specifies the scheduling spec for the restoring pod.

initialDelaySeconds

Specifies the number of seconds after the container has started before the probe is initiated.

timeoutSeconds

Specifies the number of seconds after which the probe times out. The default value is 30 seconds, and the minimum value is 1.

periodSeconds

Specifies how often (in seconds) to perform the probe. The default value is 5 seconds, and the minimum value is 1.

exec

Specifies the action to take.

image

Refers to the container image.

command

Refers to the container command.

jobAction

Specifies the configuration for a job action.

execAction

Specifies the configuration for an exec action.

connectionCredential

Defines the credential template used to create a connection credential.

readinessProbe

Defines a periodic probe of the service readiness. The controller will perform postReadyHooks of BackupScript.spec.restore after the service readiness when readinessProbe is configured.

dataRestorePolicy

Specifies the data restore policy. Options include:

• OneToMany: Enables restoration of all volumes from a single data copy of the original target instance. The ‘sourceOfOneToMany’ field must be set when using this policy.
• OneToOne: Restricts data restoration such that each data piece can only be restored to a single target instance. This is the default policy. When the number of target instances specified for restoration surpasses the count of original backup target instances.

sourceOfOneToMany

Specifies the name of the source target pod. This field is mandatory when the DataRestorePolicy is configured to ‘OneToMany’.

prepareData

Specifies the action required to prepare data for restoration.

postReady

Specifies the actions that should be executed after the data has been prepared and is ready for restoration.

baseBackupRequired

Determines if a base backup is required during restoration.

withParameters

Specifies the parameters used by the restore action

"Completed"

"Failed"

"Processing"

included

Restores the specified resources.

"AsDataSource"

"Completed"

"Failed"

"Running"

backup

Specifies the backup to be restored. The restore behavior is based on the backup type:

1. Full: will be restored the full backup directly.

2. Incremental: will be restored sequentially from the most recent full backup of this incremental backup.

3. Differential: will be restored sequentially from the parent backup of the differential backup.

4. Continuous: will find the most recent full backup at this time point and the continuous backups after it to restore.

restoreTime

Specifies the point in time for restoring.

resources

Restores the specified resources of Kubernetes.

prepareDataConfig

Configuration for the action of “prepareData” phase, including the persistent volume claims that need to be restored and scheduling strategy of temporary recovery pod.

serviceAccountName

Specifies the service account name needed for recovery pod.

readyConfig

Configuration for the action of “postReady” phase.

env

List of environment variables to set in the container for restore. These will be merged with the env of Backup and ActionSet.

The priority of merging is as follows: Restore env > Backup env > ActionSet env.

containerResources

Specifies the required resources of restore job’s container.

backoffLimit

Specifies the number of retries before marking the restore failed.

parameters

Specifies a list of name-value pairs representing parameters and their corresponding values. Parameters match the schema specified in the actionset.spec.parametersSchema

"postReady"

"prepareData"

phase

Represents the current phase of the restore.

startTimestamp

Records the date/time when the restore started being processed.

completionTimestamp

Records the date/time when the restore finished being processed.

duration

Records the duration of the restore execution. When converted to a string, the form is “1h2m0.5s”.

actions

Records all restore actions performed.

conditions

Describes the current state of the restore API Resource, like warning.

name

Describes the name of the restore action based on the current backup.

backupName

Describes which backup’s restore action belongs to.

objectKey

Describes the execution object of the restore action.

message

Provides a human-readable message indicating details about the object condition.

status

The status of this action.

startTime

The start time of the restore job.

endTime

The completion time of the restore job.

prepareData

Records the actions for the prepareData phase.

postReady

Records the actions for the postReady phase.

metadata

Specifies the standard metadata for the object. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Refer to the Kubernetes API documentation for the fields of the metadata field.

volumeClaimSpec

Defines the desired characteristics of a persistent volume claim.

VolumeConfig

(Members of VolumeConfig are embedded into this type.)

Describes the source volume of the backup target volumes and the mount path in the restoring container. At least one must exist for volumeSource and mountPath.

templates

Contains a list of volume claims.

replicas

Specifies the replicas of persistent volume claim that need to be created and restored. The format of the created claim name is $(template-name)-$(index).

startingIndex

Specifies the starting index for the created persistent volume claim according to the template. The minimum value is 0.

resources

Specifies the resource required by container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

"Failed"

"Running"

enabled

Specifies whether the backup schedule is enabled or not.

name

Specifies the name of the schedule. Names cannot be duplicated. If the name is empty, it will be considered the same as the value of the backupMethod below.

backupMethod

Specifies the backup method name that is defined in backupPolicy.

cronExpression

Specifies the cron expression for the schedule. The timezone is in UTC. see https://en.wikipedia.org/wiki/Cron.

retentionPeriod

Determines the duration for which the backup should be kept. KubeBlocks will remove all backups that are older than the RetentionPeriod. For example, RetentionPeriod of 30d will keep only the backups of last 30 days. Sample duration format:

• years: 2y

• months: 6mo

• days: 30d

• hours: 12h

• minutes: 30m

You can also combine the above durations. For example: 30d12h30m

parameters

Specifies a list of name-value pairs representing parameters and their corresponding values. Parameters match the schema specified in the actionset.spec.parametersSchema

phase

Describes the phase of the schedule.

failureReason

Represents an error that caused the backup to fail.

lastScheduleTime

Records the last time the backup was scheduled.

lastSuccessfulTime

Records the last time the backup was successfully completed.

tolerations

Specifies the tolerations for the restoring pod.

nodeSelector

Defines a selector which must be true for the pod to fit on a node. The selector must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

nodeName

Specifies a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

affinity

Contains a group of affinity scheduling rules. Refer to https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

topologySpreadConstraints

Describes how a group of pods ought to spread across topology domains. The scheduler will schedule pods in a way which abides by the constraints. Refer to https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/

schedulerName

Specifies the scheduler to dispatch the pod. If not specified, the pod will be dispatched by the default scheduler.

targetPodName

Specifies the name of the source target pod.

"NotReady"

StorageProviderNotReady indicates that the StorageProvider is not ready, usually because the specified CSI driver is not yet installed.

"Ready"

StorageProviderReady indicates that the StorageProvider is ready for use.

csiDriverName

Specifies the name of the CSI driver used to access remote storage. This field can be empty, it indicates that the storage is not accessible via CSI.

csiDriverSecretTemplate

A Go template that used to render and generate k8s.io/api/core/v1.Secret resources for a specific CSI driver. For example, accessKey and secretKey needed by CSI-S3 are stored in this Secret resource.

storageClassTemplate

A Go template utilized to render and generate kubernetes.storage.k8s.io.v1.StorageClass resources. The `StorageClass’ created by this template is aimed at using the CSI driver.

persistentVolumeClaimTemplate

A Go template that renders and generates k8s.io/api/core/v1.PersistentVolumeClaim resources. This PVC can reference the StorageClass created from storageClassTemplate, allowing Pods to access remote storage by mounting the PVC.

datasafedConfigTemplate

A Go template used to render and generate k8s.io/api/core/v1.Secret. This Secret involves the configuration details required by the datasafed tool to access remote storage. For example, the Secret should contain endpoint, bucket, ‘region’, ‘accessKey’, ‘secretKey’, or something else for S3 storage. This field can be empty, it means this kind of storage is not accessible via the datasafed tool.

parametersSchema

Describes the parameters required for storage. The parameters defined here can be referenced in the above templates, and kbcli uses this definition for dynamic command-line parameter parsing.

phase

The phase of the StorageProvider. Valid phases are NotReady and Ready.

conditions

Describes the current state of the StorageProvider.

enabled

Determines if the backup progress should be synchronized. If set to true, a sidecar container will be instantiated to synchronize the backup progress with the Backup Custom Resource (CR) status.

intervalSeconds

Defines the interval in seconds for synchronizing the backup progress.

role

Specifies the role to select one or more replicas for backup.

• If no replica with the specified role exists, the backup task will fail. Special case: If there is only one replica in the cluster, it will be used for backup, even if its role differs from the specified one. For example, if you specify backing up on a secondary replica, but the cluster is single-node with only one primary replica, the primary will be used for backup. Future versions will address this special case using role priorities.

• If multiple replicas satisfy the specified role, the choice (Any or All) will be made according to the strategy field below.

fallbackRole

Specifies the fallback role to select one replica for backup, this only takes effect when the strategy field below is set to Any.

account

If backupPolicy.componentDefs is set, this field is required to specify the system account name. This account must match one listed in componentDefinition.spec.systemAccounts[*].name. The corresponding secret created by this account is used to connect to the database.

strategy

Specifies the PodSelectionStrategy to use when multiple pods are selected for the backup target. Valid values are:

• Any: Selects any one pod that matches the labelsSelector.

• All: Selects all pods that match the labelsSelector.

useParentSelectedPods

UseParentSelectedPods indicates whether to use the pods selected by the parent for backup. If set to true, the backup will use the same pods selected by the parent. And only takes effect when the ‘strategy’ is set to ‘Any’.

containerPort

Specifies the container port in the target pod. If not specified, the first container and its first port will be used.

volumes

Specifies the list of volumes of targeted application that should be mounted on the backup workload.

volumeMounts

Specifies the mount for the volumes specified in volumes section.

versionMapping

Determine the appropriate version of the backup tool image from service version.

serviceVersions

Represents an array of the service version that can be mapped to the appropriate value. Each name in the list can represent an exact name, a name prefix, or a regular expression pattern.

For example:

• “8.0.33”: Matches the exact name “8.0.33”

• “8.0”: Matches all names starting with “8.0”

• ”^8.0.\d{1,2}$“: Matches all names starting with “8.0.” followed by one or two digits.

mappedValue

Specifies a mapping value based on service version. Typically used to set up the tools image required for backup operations.

"Parallel"

"Serial"

volumeSource

Describes the volume that will be restored from the specified volume of the backup targetVolumes. This is required if the backup uses a volume snapshot.

mountPath

Specifies the path within the restoring container at which the volume should be mounted.

name

The name of the volume snapshot.

contentName

The name of the volume snapshot content.

volumeName

The name of the volume.

size

The size of the volume snapshot.

targetName

Associates this volumeSnapshot with its corresponding target.