apiVersion
string

operations.kubeblocks.io/v1alpha1

kind
string

OpsDefinition

metadata

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

spec

status

apiVersion
string

operations.kubeblocks.io/v1alpha1

kind
string

OpsRequest

metadata

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

spec

status

objectKey

Represents the name of the task.

namespace

Represents the namespace where the task is deployed.

status

Indicates the current status of the task, including “Processing”, “Failed”, “Succeed”.

targetPodName

The name of the Pod that the task is associated with or operates on.

retries

The count of retry attempts made for this task.

"Failed"

"Processing"

"Succeed"

backupName

Specifies the name of the Backup custom resource.

backupPolicyName

Indicates the name of the BackupPolicy applied to perform this Backup.

backupMethod

Specifies the name of BackupMethod. The specified BackupMethod must be defined in the BackupPolicy.

deletionPolicy

Determines whether the backup contents stored in backup repository should be deleted when the Backup custom resource 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.

retentionPeriod

Determines the duration for which the Backup custom resources should be retained.

The controller will automatically remove all Backup objects that are older than the specified RetentionPeriod. For example, RetentionPeriod of 30d will keep only the Backup objects 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. If not set, the Backup objects will be kept forever.

If the deletionPolicy is set to ‘Delete’, then the associated backup data will also be deleted along with the Backup object. Otherwise, only the Backup custom resource will be deleted.

parentBackupName

If the specified BackupMethod is incremental, parentBackupName is required.

parameters

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

ref

Refers to a reference backup that needs to be restored.

initialDelaySeconds

Specifies the number of seconds to wait after the resource has been patched before initiating completion probes. The default value is 5 seconds, with a minimum value of 1.

timeoutSeconds

Specifies the number of seconds after which the probe times out. The default value is 60 seconds, with a minimum value of 1.

periodSeconds

Specifies the frequency (in seconds) at which the probe should be performed. The default value is 5 seconds, with a minimum value of 1.

matchExpressions

Executes expressions regularly, based on the value of PeriodSeconds, to determine if the action has been completed.

componentDefinitionName

Specifies the name of the ComponentDefinition. The name 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.

accountName

Specifies the account name associated with the Component. If set, the corresponding account username and password are injected into containers’ environment variables KB_ACCOUNT_USERNAME and KB_ACCOUNT_PASSWORD.

serviceName

Specifies the name of the Service. If set, the service name is injected as the KB_COMP_SVC_NAME environment variable in the containers, and each service port is mapped to a corresponding environment variable named KB_COMP_SVC_PORT_$(portName). The portName is transformed by replacing ‘-’ with ‘_’ and converting to uppercase.

componentName

Specifies the name of the Component as defined in the cluster.spec

opsDefinitionName

Specifies the name of the OpsDefinition.

serviceAccountName

Specifies the name of the ServiceAccount to be used for executing the custom operation.

maxConcurrentComponents

Specifies the maximum number of components to be operated on concurrently to mitigate performance impact on clusters with multiple components.

It accepts an absolute number (e.g., 5) or a percentage of components to execute in parallel (e.g., “10%”). Percentages are rounded up to the nearest whole number of components. For example, if “10%” results in less than one, it rounds up to 1.

When unspecified, all components are processed simultaneously by default.

Note: This feature is not implemented yet.

components

Specifies the components and their parameters for executing custom actions as defined in OpsDefinition. Requires at least one component.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

parameters

Specifies the parameters that match the schema specified in the opsDefinition.spec.parametersSchema.

targetContainerName

Specifies the container name in the target Pod. If not specified, the first container will be used by default.

envName

Defines the name of the environment variable. This name can originate from an ‘env’ entry or be a data key from an ‘envFrom’ source.

componentName

Specifies the name of the Component.

switch

Indicates whether the services will be exposed. ‘Enable’ exposes the services. while ‘Disable’ removes the exposed Service.

services

Specifies a list of OpsService. When an OpsService is exposed, a corresponding ClusterService will be added to cluster.spec.services. On the other hand, when an OpsService is unexposed, the corresponding ClusterService will be removed from cluster.spec.services.

Note: If componentName is not specified, the ports and selector fields must be provided in each OpsService definition.

"Disable"

"Enable"

"Fail"

FailurePolicyFail means that an error will be reported.

"Ignore"

FailurePolicyIgnore means that an error will be ignored but logged.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

shards

Specifies the desired number of shards for the component. This parameter is mutually exclusive with other parameters.

scaleOut

Specifies the replica changes for scaling out components and instance templates, and brings offline instances back online. Can be used in conjunction with the “scaleIn” operation. Note: Any configuration that deletes instances is considered invalid.

scaleIn

Specifies the replica changes for scaling in components and instance templates, and takes specified instances offline. Can be used in conjunction with the “scaleOut” operation. Note: Any configuration that creates instances is considered invalid.

name

Pod name of the instance.

targetNodeName

The instance will rebuild on the specified node. If not set, it will rebuild on a random node.

name

Specifies the name of the instance template.

replicaChanges

Specifies the replica changes for the instance template.

name

Refer to the instance template name of the component or sharding.

ResourceRequirements

(Members of ResourceRequirements are embedded into this type.)

Defines the computational resource size for vertical scaling.

name

Refer to the instance template name of the component or sharding.

volumeClaimTemplates

volumeClaimTemplates specifies the storage size and volumeClaimTemplate name.

op

Specifies the type of JSON patch operation. It supports the following values: ‘add’, ‘remove’, ‘replace’.

path

Specifies the json patch path.

value

Specifies the value to be used in the JSON patch operation.

replicas

Records the replicas of the Component prior to any changes.

shards

Records the shards of the Component prior to any changes.

ResourceRequirements

(Members of ResourceRequirements are embedded into this type.)

Records the resources of the Component prior to any changes.

volumeClaimTemplates

Records volumes’ storage size of the Component prior to any changes.

services

Records the ClusterComponentService list of the Component prior to any changes.

instances

Records the InstanceTemplate list of the Component prior to any changes.

offlineInstances

Records the offline instances of the Component prior to any changes.

serviceVersion

Records the version of the Service expected to be provisioned by this Component prior to any changes.

componentDefinitionName

Records the name of the ComponentDefinition prior to any changes.

components

Records the configuration of each Component prior to any changes.

failure

Specifies a failure condition for an action using a Go template expression. Should evaluate to either true or false. The current resource object is parsed into the Go template. for example, you can use ‘{{ eq .spec.replicas 1 }}’.

success

Specifies a success condition for an action using a Go template expression. Should evaluate to either true or false. The current resource object is parsed into the Go template. for example, using ‘{{ eq .spec.replicas 1 }}’

name

Specifies the name of the OpsAction.

failurePolicy

Specifies the failure policy of the OpsAction. Valid values are:

• “Fail”: Marks the entire OpsRequest as failed if the action fails.

• “Ignore”: The OpsRequest continues processing despite the failure of the action.

parameters

Specifies the parameters for the OpsAction. Their usage varies based on the action type:

• For ‘workload’ or ‘exec’ actions, parameters are injected as environment variables.

• For ‘resourceModifier’ actions, parameter can be referenced using $() in fields resourceModifier.completionProbe.matchExpressions and resourceModifier.jsonPatches[*].value.

workload

Specifies the configuration for a ‘workload’ action. This action leads to the creation of a K8s workload, such as a Pod or Job, to execute specified tasks.

exec

Specifies the configuration for a ‘exec’ action. It creates a Pod and invokes a ‘kubectl exec’ to run command inside a specified container with the target Pod.

resourceModifier

Specifies the configuration for a ‘resourceModifier’ action. This action allows for modifications to existing K8s objects.

Note: This feature has not been implemented yet.

preConditions

Specifies the preconditions that must be met to run the actions for the operation. if set, it will check the condition before the Component runs this operation. Example:

preConditions:

rule:
expression: '{{ eq .component.status.phase "Running" }}'
message: Component is not in Running status.

podInfoExtractors

Specifies a list of PodInfoExtractor, each designed to select a specific Pod and extract selected runtime info from its PodSpec. The extracted information, such as environment variables, volumes and tolerations, are then injected into Jobs or Pods that execute the OpsActions defined in actions.

componentInfos

Specifies a list of ComponentDefinition for Components associated with this OpsDefinition. It also includes connection credentials (address and account) for each Component.

parametersSchema

Specifies the schema for validating the data types and value ranges of parameters in OpsActions before their usage.

actions

Specifies a list of OpsAction where each customized action is executed sequentially.

observedGeneration

Represents the most recent generation observed of this OpsDefinition.

phase

Represents the current state of the OpsDefinition. Valid values are “”, “Available”, “Unavailable”. When it equals to “Available”, the OpsDefinition is ready and can be used in a “Custom” OpsRequest.

message

Provides additional information about the current phase.

name

Specifies the name of the environment variable to be injected into Pods executing OpsActions. It must conform to the C_IDENTIFIER format, which includes only alphanumeric characters and underscores, and cannot begin with a digit.

valueFrom

Specifies the source of the environment variable’s value.

podInfoExtractorName

Specifies a PodInfoExtractor defined in the opsDefinition.spec.podInfoExtractors.

backoffLimit

Specifies the number of retries allowed before marking the action as failed.

command

The command to be executed via ‘kubectl exec –’.

containerName

The name of the container in the target pod where the command should be executed. This corresponds to the -c {containerName} option in kubectl exec.

If not set, the first container is used.

"Aborted"

"Cancelled"

"Cancelling"

"Creating"

"Failed"

"Pending"

"Running"

"Succeed"

name

name OpsRequest name

type

opsRequest type

inQueue

indicates whether the current opsRequest is in the queue

queueBySelf

indicates that the operation is queued for execution within its own-type scope.

FromClusterPhases

ToClusterPhase

phase

Records the current phase of the Component, mirroring cluster.status.components[componentName].phase.

lastFailedTime

Records the timestamp when the Component last transitioned to a “Failed” phase.

preCheck

Records the result of the preConditions check of the opsRequest, which determines subsequent steps.

progressDetails

Describes the progress details of objects or actions associated with the Component.

reason

Provides an explanation for the Component being in its current state.

message

Provides a human-readable message indicating details about this operation.

clusterName

Specifies the name of the Cluster resource that this operation is targeting.

cancel

Indicates whether the current operation should be canceled and terminated gracefully if it’s in the “Pending”, “Creating”, or “Running” state.

This field applies only to “VerticalScaling” and “HorizontalScaling” opsRequests.

Note: Setting cancel to true is irreversible; further modifications to this field are ineffective.

force

Instructs the system to bypass pre-checks (including cluster state checks and customized pre-conditions hooks) and immediately execute the opsRequest, except for the opsRequest of ‘Start’ type, which will still undergo pre-checks even if force is true.

This is useful for concurrent execution of ‘VerticalScaling’ and ‘HorizontalScaling’ opsRequests. By setting force to true, you can bypass the default checks and demand these opsRequests to run simultaneously.

Note: Once set, the force field is immutable and cannot be updated.

enqueueOnForce

Indicates whether opsRequest should continue to queue when ‘force’ is set to true.

type

Specifies the type of this operation. Supported types include “Start”, “Stop”, “Restart”, “Switchover”, “VerticalScaling”, “HorizontalScaling”, “VolumeExpansion”, “Reconfiguring”, “Upgrade”, “Backup”, “Restore”, “Expose”, “RebuildInstance”, “Custom”.

Note: This field is immutable once set.

ttlSecondsAfterSucceed

Specifies the duration in seconds that an OpsRequest will remain in the system after successfully completing (when opsRequest.status.phase is “Succeed”) before automatic deletion.

ttlSecondsAfterUnsuccessfulCompletion

Specifies the duration in seconds that an OpsRequest will remain in the system after completion for any phase other than “Succeed” (e.g., “Failed”, “Cancelled”, “Aborted”) before automatic deletion.

preConditionDeadlineSeconds

Specifies the maximum time in seconds that the OpsRequest will wait for its pre-conditions to be met before it aborts the operation. If set to 0 (default), pre-conditions must be satisfied immediately for the OpsRequest to proceed.

timeoutSeconds

Specifies the maximum duration (in seconds) that an opsRequest is allowed to run. If the opsRequest runs longer than this duration, its phase will be marked as Aborted. If this value is not set or set to 0, the timeout will be ignored and the opsRequest will run indefinitely.

SpecificOpsRequest

(Members of SpecificOpsRequest are embedded into this type.)

Exactly one of its members must be set.

clusterGeneration

Records the cluster generation after the OpsRequest action has been handled.

phase

Represents the phase of the OpsRequest. Possible values include “Pending”, “Creating”, “Running”, “Cancelling”, “Cancelled”, “Failed”, “Succeed”.

progress

Represents the progress of the OpsRequest.

lastConfiguration

Records the configuration prior to any changes.

components

Records the status information of Components changed due to the OpsRequest.

extras

A collection of additional key-value pairs that provide supplementary information for the OpsRequest.

startTimestamp

Records the time when the OpsRequest started processing.

completionTimestamp

Records the time when the OpsRequest was completed.

cancelTimestamp

Records the time when the OpsRequest was cancelled.

conditions

Describes the detailed status of the OpsRequest. Possible condition types include “Cancelled”, “WaitForProgressing”, “Validated”, “Succeed”, “Failed”, “Restarting”, “VerticalScaling”, “HorizontalScaling”, “VolumeExpanding”, “Reconfigure”, “Switchover”, “Stopping”, “Starting”, “VersionUpgrading”, “Exposing”, “Backup”, “InstancesRebuilding”, “CustomOperation”.

storage

Specifies the desired storage size for the volume.

name

Specify the name of the volumeClaimTemplate in the Component. The specified name must match one of the volumeClaimTemplates defined in the clusterComponentSpec.volumeClaimTemplates field.

resource

Specifies the K8s object that is to be updated.

jsonPatches

Specifies a list of patches for modifying the object.

completionProbe

Specifies a method to determine if the action has been completed.

Note: This feature has not been implemented yet.

name

Specifies the name of the Service. This name is used to set clusterService.name.

Note: This field cannot be updated.

annotations

Contains cloud provider related parameters if ServiceType is LoadBalancer.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer.

ports

Specifies Port definitions that are to be exposed by a ClusterService.

If not specified, the Port definitions from non-NodePort and non-LoadBalancer type ComponentService defined in the ComponentDefinition (componentDefinition.spec.services) will be used. If no matching ComponentService is found, the expose operation will fail.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports

roleSelector

Specifies a role to target with the service. If specified, the service will only be exposed to pods with the matching role.

Note: If the component has roles, at least one of ‘roleSelector’ or ‘podSelector’ must be specified. If both are specified, a pod must match both conditions to be selected.

podSelector

Routes service traffic to pods with matching label keys and values. If specified, the service will only be exposed to pods matching the selector.

Note: If the component has roles, at least one of ‘roleSelector’ or ‘podSelector’ must be specified. If both are specified, a pod must match both conditions to be selected.

serviceType

Determines how the Service is exposed. Defaults to ‘ClusterIP’. Valid options are ClusterIP, NodePort, and LoadBalancer.

• ClusterIP: allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, they are determined by manual construction of an Endpoints object or EndpointSlice objects.

• NodePort: builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP.

• LoadBalancer: builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP.

Note: although K8s Service type allows the ‘ExternalName’ type, it is not a valid option for the expose operation.

For more info, see: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types.

ipFamilies

A list of IP families (e.g., IPv4, IPv6) assigned to this Service.

Usually assigned automatically based on the cluster configuration and the ipFamilyPolicy field. If specified manually, the requested IP family must be available in the cluster and allowed by the ipFamilyPolicy. If the requested IP family is not available or not allowed, the Service creation will fail.

Valid values:

• “IPv4”

• “IPv6”

This field may hold a maximum of two entries (dual-stack families, in either order).

Common combinations of ipFamilies and ipFamilyPolicy are:

• ipFamilies=[] + ipFamilyPolicy=“PreferDualStack” : The Service prefers dual-stack but can fall back to single-stack if the cluster does not support dual-stack. The IP family is automatically assigned based on the cluster configuration.

• ipFamilies=[“IPV4”,“IPV6”] + ipFamilyPolicy=“RequiredDualStack” : The Service requires dual-stack and will only be created if the cluster supports both IPv4 and IPv6. The primary IP family is IPV4.

• ipFamilies=[“IPV6”,“IPV4”] + ipFamilyPolicy=“RequiredDualStack” : The Service requires dual-stack and will only be created if the cluster supports both IPv4 and IPv6. The primary IP family is IPV6.

• ipFamilies=[“IPV4”] + ipFamilyPolicy=“SingleStack” : The Service uses a single-stack with IPv4 only.

• ipFamilies=[“IPV6”] + ipFamilyPolicy=“SingleStack” : The Service uses a single-stack with IPv6 only.

ipFamilyPolicy

Specifies whether the Service should use a single IP family (SingleStack) or two IP families (DualStack).

Possible values:

• ‘SingleStack’ (default) : The Service uses a single IP family. If no value is provided, IPFamilyPolicy defaults to SingleStack.

• ‘PreferDualStack’ : The Service prefers to use two IP families on dual-stack configured clusters or a single IP family on single-stack clusters.

• ‘RequiredDualStack’ : The Service requires two IP families on dual-stack configured clusters. If the cluster is not configured for dual-stack, the Service creation fails.

"Backup"

"Custom"

RebuildInstance rebuilding an instance is very useful when a node is offline or an instance is unrecoverable.

"Expose"

StartType the start operation will start the pods which is deleted in stop operation.

"HorizontalScaling"

"RebuildInstance"

"Reconfiguring"

"Restart"

"Restore"

"Start"

StopType the stop operation will delete all pods in a cluster concurrently.

"Stop"

RestartType the restart operation is a special case of the rolling update operation.

"Switchover"

"Upgrade"

"VerticalScaling"

"VolumeExpansion"

envRef

Specifies a reference to a specific environment variable within a container. Used to specify the source of the variable, which can be either “env” or “envFrom”.

fieldPath

Represents the JSONPath expression pointing to the specific data within the JSON structure of the target Pod. It is used to extract precise data locations for operations on the Pod.

type

Defines the workload type of the action. Valid values include “Job” and “Pod”.

• “Job”: Creates a Job to execute the action.

• “Pod”: Creates a Pod to execute the action. Note: unlike Jobs, manually deleting a Pod does not affect the backoffLimit.

podInfoExtractorName

Specifies a PodInfoExtractor defined in the opsDefinition.spec.podInfoExtractors.

backoffLimit

Specifies the number of retries allowed before marking the action as failed.

podSpec

Specifies the PodSpec of the ‘workload’ action.

"Job"

"Pod"

name

Specifies the identifier of the parameter as defined in the OpsDefinition.

value

Holds the data associated with the parameter. If the parameter type is an array, the format should be “v1,v2,v3”.

valueFrom

Source for the parameter’s value. Cannot be used if value is not empty.

key

Represents the name of the parameter that is to be updated.

value

Represents the parameter values that are to be updated. If set to nil, the parameter defined by the Key field will be removed from the configuration file.

configMapKeyRef

Selects a key of a ConfigMap.

secretKeyRef

Selects a key of a Secret.

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.

"Available"

AvailablePhase indicates that the object is in an available state.

"Unavailable"

UnavailablePhase indicates that the object is in an unavailable state.

name

Specifies the name of the PodInfoExtractor.

env

Specifies a list of environment variables to be extracted from a selected Pod, and injected into the containers executing each OpsAction.

podSelector

Used to select the target Pod from which environment variables and volumes are extracted from its PodSpec.

volumeMounts

Specifies a list of volumes, along with their respective mount points, that are to be extracted from a selected Pod, and mounted onto the containers executing each OpsAction. This allows the containers to access shared or persistent data necessary for the operation.

"All"

"Any"

role

Specifies the role of the target Pod.

multiPodSelectionPolicy

Defines the policy for selecting the target pod when multiple pods match the podSelector. It can be either ‘Any’ (select any one pod that matches the podSelector) or ‘All’ (select all pods that match the podSelector).

time

Refers to the specific time point for restoration, with UTC as the time zone.

ref

Refers to a reference source cluster that needs to be restored.

pass

Indicates whether the preCheck operation passed or failed.

message

Provides explanations related to the preCheck result in a human-readable format.

rule

Specifies the conditions that must be met for the operation to execute.

"Failed"

"Pending"

"Processing"

"Succeed"

group

Specifies the group to which the current object belongs to.

objectKey

objectKey uniquely identifies the object, which can be any K8s object, like a Pod, Job, Component, or PVC. Either objectKey or actionName must be provided.

actionName

Indicates the name of an OpsAction, as defined in opsDefinition.spec.actions[*].name. Either objectKey or actionName must be provided.

actionTasks

Lists the tasks, such as Jobs or Pods, that carry out the action.

status

Represents the current processing state of the object, including “Processing”, “Pending”, “Failed”, “Succeed”

message

Provides a human-readable explanation of the object’s condition.

startTime

Records the start time of object processing.

endTime

Records the completion time of object processing.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

instances

Specifies the instances (Pods) that need to be rebuilt, typically operating as standbys.

inPlace

When it is set to true, the instance will be rebuilt in-place. If false, a new pod will be created. Once the new pod is ready to serve, the instance that require rebuilding will be taken offline.

backupName

Indicates the name of the Backup custom resource from which to recover the instance. Defaults to an empty PersistentVolume if unspecified.

Note:

• Only full physical backups are supported for multi-replica Components (e.g., ‘xtrabackup’ for MySQL).
• Logical backups (e.g., ‘mysqldump’ for MySQL) are unsupported in the current version.

sourceBackupTargetName

When multiple source targets exist of the backup, you must specify the source target to restore.

restoreEnv

Defines container environment variables for the restore process. merged with the ones specified in the Backup and ActionSet resources.

Merge priority: Restore env > Backup env > ActionSet env.

Purpose: Some databases require different configurations when being restored as a standby compared to being restored as a primary. For example, when restoring MySQL as a replica, you need to set skip_slave_start="ON" for 5.7 or skip_replica_start="ON" for 8.0. Allowing environment variables to be passed in makes it more convenient to control these behavioral differences during the restore process.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

parameters

Specifies a list of key-value pairs representing parameters and their corresponding values within a single configuration file. This field is used to override or set the values of parameters without modifying the entire configuration file.

name

Refers to the specific name of the resource.

namespace

Refers to the specific namespace of the resource.

replicaChanges

Specifies the replica changes for the component.

instances

Modifies the desired replicas count for existing InstanceTemplate. if the inst

backupName

Specifies the name of the Backup custom resource.

backupNamespace

Specifies the namespace of the backup custom resource. If not specified, the namespace of the opsRequest will be used.

restorePointInTime

Specifies the point in time to which the restore should be performed. Supported time formats:

• RFC3339 format, e.g. “2023-11-25T18:52:53Z”

• A human-readable date-time format, e.g. “Jul 25,2023 18:52:53 UTC+0800”

env

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

volumeRestorePolicy

Specifies the policy for restoring volume claims of a Component’s Pods. It determines whether the volume claims should be restored sequentially (one by one) or in parallel (all at once). Support values:

• “Serial”

• “Parallel”

deferPostReadyUntilClusterRunning

Controls the timing of PostReady actions during the recovery process.

If false (default), PostReady actions execute when the Component reaches the “Running” state. If true, PostReady actions are delayed until the entire Cluster is “Running,” ensuring the cluster’s overall stability before proceeding.

This setting is useful for coordinating PostReady operations across the Cluster for optimal cluster conditions.

parameters

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

expression

Specifies a Go template expression that determines how the operation can be executed. The return value must be either true or false. Available built-in objects that can be referenced in the expression include:

• params: Input parameters.

• cluster: The referenced Cluster object.

• component: The referenced Component object.

message

Specifies the error or status message reported if the expression does not evaluate to true.

ReplicaChanger

(Members of ReplicaChanger are embedded into this type.)

Modifies the replicas of the component and instance templates.

onlineInstancesToOffline

Specifies the instance names that need to be taken offline.

ReplicaChanger

(Members of ReplicaChanger are embedded into this type.)

Modifies the replicas of the component and instance templates.

newInstances

Defines the configuration for new instances added during scaling, including resource requirements, labels, annotations, etc. New instances are created based on the provided instance templates.

offlineInstancesToOnline

Specifies the instances in the offline list to bring back online.

upgrade

Specifies the desired new version of the Cluster.

Note: This field is immutable once set.

horizontalScaling

Lists HorizontalScaling objects, each specifying scaling requirements for a Component, including desired replica changes, configurations for new instances, modifications for existing instances, and take offline/online the specified instances.

volumeExpansion

Lists VolumeExpansion objects, each specifying a component and its corresponding volumeClaimTemplates that requires storage expansion.

start

Lists Components to be started. If empty, all components will be started.

stop

Lists Components to be stopped. If empty, all components will be stopped.

restart

Lists Components to be restarted.

switchover

Lists Switchover objects, each specifying a Component to perform the switchover operation.

verticalScaling

Lists VerticalScaling objects, each specifying a component and its desired compute resources for vertical scaling.

reconfigures

Lists Reconfigure objects, each specifying a Component and its configuration updates.

expose

Lists Expose objects, each specifying a Component and its services to be exposed.

backup

Specifies the parameters to back up a Cluster.

restore

Specifies the parameters to restore a Cluster. Note that this restore operation will roll back cluster services.

rebuildFrom

Specifies the parameters to rebuild some instances. Rebuilding an instance involves restoring its data from a backup or another database replica. The instances being rebuilt usually serve as standby in the cluster. Hence, rebuilding instances is often also referred to as “standby reconstruction”.

custom

Specifies a custom operation defined by OpsDefinition.

componentName

Specifies the name of the Component as defined in the cluster.spec.

componentObjectName

Specifies the name of the Component object.

instanceName

Specifies the instance whose role will be transferred. A typical usage is to transfer the leader role in a consensus system.

candidateName

If CandidateName is specified, the role will be transferred to this instance. The name must match one of the pods in the component. Refer to ComponentDefinition’s Swtichover lifecycle action for more details.

apiGroup

Specifies the group for the resource being referenced. If not specified, the referenced Kind must belong to the core API group. For all third-party types, this is mandatory.

kind

Specifies the type of resource being referenced.

name

Indicates the name of the resource being referenced.

addedKeys

Maps newly added configuration files to their content.

deletedKeys

Lists the name of configuration files that have been deleted.

updatedKeys

Maps the name of configuration files to their updated content, detailing the changes made.

components

Lists components to be upgrade based on desired ComponentDefinition and ServiceVersion. From the perspective of cluster API, the reasonable combinations should be:

1. (comp-def, service-ver) - upgrade to the specified service version and component definition, the user takes the responsibility to ensure that they are compatible.
2. (“”, service-ver) - upgrade to the specified service version, let the operator choose the latest compatible component definition.
3. (comp-def, “”) - upgrade to the specified component definition, let the operator choose the latest compatible service version.
4. (“”, “”) - upgrade to the latest service version and component definition, the operator will ensure the compatibility between the selected versions.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

componentDefinitionName

Specifies the name of the ComponentDefinition, only exact matches are supported.

serviceVersion

Specifies the version of the Service expected to be provisioned by this Component. Referring to the ServiceVersion defined by the ComponentDefinition and ComponentVersion. And ServiceVersion in ClusterComponentSpec is optional, when no version is specified, use the latest available version in ComponentVersion.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

ResourceRequirements

(Members of ResourceRequirements are embedded into this type.)

Defines the desired compute resources of the Component’s instances.

instances

Specifies the desired compute resources of the instance template that need to vertical scale.

ComponentOps

(Members of ComponentOps are embedded into this type.)

Specifies the name of the Component.

volumeClaimTemplates

Specifies a list of OpsRequestVolumeClaimTemplate objects, defining the volumeClaimTemplates that are used to expand the storage and the desired storage size for each one.