"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.

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.

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

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

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.

Specifies the backup action.

Specifies the restore action.

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

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

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

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

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

The name of the action.

Records the target pod name which has been backed up.

The current phase of the action.

Records the time an action was started.

Records the time an action was completed.

An error that caused the action to fail.

The type of the action.

Available replicas for statefulSet action.

The object reference for the action.

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.

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

Records the volume snapshot status for the action.

"Job"

""

"StatefulSet"

Represents the action to be performed for backing up data.

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

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

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.

(Members of `JobActionSpec` are embedded into this type.)

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

"Delete"

"Retain"

The name of backup method.

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

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.

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.

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

Specifies the environment variables for the backup workload.

Specifies runtime settings for the backup workload container.

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

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.

"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"

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

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

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

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

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

Defines the backup methods.

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.

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

Phase - in list of [Available,Unavailable]

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

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.

Specifies the backup name.

Specifies the backup namespace.

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.

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

Specifies the access method of the backup repository.

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

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

Stores the non-secret configuration parameters for the `StorageProvider`.

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

Specifies the prefix of the path for storing backup data.

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

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

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

Refers to the generated secret for the `StorageProvider`.

Represents the name of the generated storage class.

Represents the name of the PVC that stores backup data.

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

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.

Specifies the backupPolicy to be applied for the `schedules`.

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

Defines the list of backup schedules.

Describes the phase of the BackupSchedule.

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.

Represents an error that caused the backup to fail.

Describes the status of each schedule.

Specifies the backup policy to be applied for this backup.

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

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.

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.

Determines the parent backup name for incremental or differential backup.

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

Indicates the current state of the backup operation.

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

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

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.

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

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.

Any error that caused the backup operation to fail.

The name of the backup repository.

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

Records the path of the Kopia repository.

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

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

Records the target information for this backup.

Records the targets information for this backup.

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

Records the encryption config for this backup.

Records the actions status for this backup.

Records the volume snapshot status for the action.

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

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

Records any additional information for the backup.

(Members of `BackupTarget` are embedded into this type.)

Records the selected pods by the target info during backup.

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.

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

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

Specifies the kubernetes resources to back up.

Specifies the service account to run the backup workload.

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

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

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

"Continuous"

"Differential"

"Full"

"Incremental"

Specifies the image of the backup container.

Defines the commands to back up the volume data.

Refers to the Secret object that contains the connection credential.

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

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.

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

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

"OneToMany"

"OneToOne"

Specifies the encryption algorithm. Currently supported algorithms are:

• AES-128-CFB
• AES-192-CFB
• AES-256-CFB

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

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

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.

Defines the command and arguments to be executed.

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

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

Executes kubectl in all selected pods.

Selects the specified resource for recovery by label.

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

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

(Members of `BaseJobActionSpec` are embedded into this type.)

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.

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

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.

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

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 is a slice of namespaced-scoped resource type names to include in the kubernetes resources. The default value is empty.

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

Defines the parameters in OpenAPI V3.

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.

(Members of `LabelSelector` are embedded into this type.)

labelsSelector is the label selector to filter the target pods.

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

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.

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

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.

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.

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.

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.

Specifies the scheduling spec for the restoring pod.

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

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

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

Specifies the action to take.

Refers to the container image.

Refers to the container command.

Specifies the configuration for a job action.

Specifies the configuration for an exec action.

Defines the credential template used to create a connection credential.

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.

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.

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

Specifies the action required to prepare data for restoration.

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

Determines if a base backup is required during restoration.

"Completed"

"Failed"

"Processing"

Restores the specified resources.

"AsDataSource"

"Completed"

"Failed"

"Running"

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.

Specifies the point in time for restoring.

Restores the specified resources of Kubernetes.

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

Specifies the service account name needed for recovery pod.

Configuration for the action of “postReady” phase.

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`.

Specifies the required resources of restore job’s container.

Specifies the number of retries before marking the restore failed.

"postReady"

"prepareData"

Represents the current phase of the restore.

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

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

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

Records all restore actions performed.

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

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

Describes which backup’s restore action belongs to.

Describes the execution object of the restore action.

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

The status of this action.

The start time of the restore job.

The completion time of the restore job.

Records the actions for the prepareData phase.

Records the actions for the postReady phase.

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

Defines the desired characteristics of a persistent volume claim.

(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.

Contains a list of volume claims.

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)`.

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

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

"Failed"

"Running"

Specifies whether the backup schedule is enabled or not.

Specifies the backup method name that is defined in backupPolicy.

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

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

Describes the phase of the schedule.

Represents an error that caused the backup to fail.

Records the last time the backup was scheduled.

Records the last time the backup was successfully completed.

Specifies the tolerations for the restoring pod.

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/

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.

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

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/

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

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.

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.

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.

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.

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.

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.

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.

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

Describes the current state of the `StorageProvider`.

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.

Defines the interval in seconds for synchronizing the backup progress.

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

Specifies the mount for the volumes specified in `volumes` section.

"Parallel"

"Serial"

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.

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

The name of the volume snapshot.

The name of the volume snapshot content.

The name of the volume.

The size of the volume snapshot.

Associates this volumeSnapshot with its corresponding target.