chore: remove lorry and built-in action handler (#7964)

.github/utils/utils.sh

@@ -514,9 +514,6 @@ get_trigger_mode() {
             apis/*)
                 add_trigger_mode "[apis][test]"
             ;;
-            pkg/lorry/ctl/*)
-                add_trigger_mode "[lorry][test]"
-            ;;
             *)
                 add_trigger_mode "[test]"
             ;;

.github/workflows/cicd-push.yml

@@ -270,7 +270,7 @@ jobs:
   apis-doc:
     needs: [ trigger-mode ]
     runs-on: ubuntu-latest
-    if: ${{ contains(needs.trigger-mode.outputs.trigger-mode, '[apis]') || contains(needs.trigger-mode.outputs.trigger-mode, '[lorry]') }}
+    if: ${{ contains(needs.trigger-mode.outputs.trigger-mode, '[apis]') }}
     steps:
       - uses: actions/checkout@v4
       - name: install lib

Makefile

@@ -255,11 +255,6 @@ endif
 goimports: goimportstool ## Run goimports against code.
 	$(GOIMPORTS) -local github.com/apecloud/kubeblocks -w $$(git ls-files|grep "\.go$$" | grep -v $(GENERATED_CLIENT_PKG) | grep -v $(GENERATED_DEEP_COPY_FILE))
 
-
-.PHONY: lorryctl-doc
-lorryctl-doc: generate test-go-generate ## generate CLI command reference manual.
-	$(GO) run ./hack/docgen/lorryctl/main.go ./docs/user_docs/lorryctl
-
 .PHONY: api-doc
 api-doc:  ## generate API reference manual.
 	$(GO) run ./hack/docgen/api/main.go -api-dir github.com/apecloud/kubeblocks/apis -config ./hack/docgen/api/gen-api-doc-config.json -template-dir ./hack/docgen/api/template -out-dir ./docs/developer_docs/api-reference/

apis/apps/v1alpha1/clusterdefinition_types.go

@@ -224,44 +224,6 @@ type LogConfig struct {
 	FilePathPattern string `json:"filePathPattern"`
 }
 
-// TODO(v1.0): remove this after lorry
-
-// VolumeProtectionSpec is deprecated since v0.9, replaced with ComponentVolume.HighWatermark.
-type VolumeProtectionSpec struct {
-	// The high watermark threshold for volume space usage.
-	// If there is any specified volumes who's space usage is over the threshold, the pre-defined "LOCK" action
-	// will be triggered to degrade the service to protect volume from space exhaustion, such as to set the instance
-	// as read-only. And after that, if all volumes' space usage drops under the threshold later, the pre-defined
-	// "UNLOCK" action will be performed to recover the service normally.
-	//
-	// +kubebuilder:validation:Maximum=100
-	// +kubebuilder:validation:Minimum=0
-	// +kubebuilder:default=90
-	// +optional
-	HighWatermark int `json:"highWatermark,omitempty"`
-
-	// The Volumes to be protected.
-	//
-	// +optional
-	Volumes []ProtectedVolume `json:"volumes,omitempty"`
-}
-
-// ProtectedVolume is deprecated since v0.9, replaced with ComponentVolume.HighWatermark.
-type ProtectedVolume struct {
-	// The Name of the volume to protect.
-	//
-	// +optional
-	Name string `json:"name,omitempty"`
-
-	// Defines the high watermark threshold for the volume, it will override the component level threshold.
-	// If the value is invalid, it will be ignored and the component level threshold will be used.
-	//
-	// +kubebuilder:validation:Maximum=100
-	// +kubebuilder:validation:Minimum=0
-	// +optional
-	HighWatermark *int `json:"highWatermark,omitempty"`
-}
-
 // ServiceRefDeclaration represents a reference to a service that can be either provided by a KubeBlocks Cluster
 // or an external service.
 // It acts as a placeholder for the actual service reference, which is determined later when a Cluster is created.

apis/apps/v1alpha1/componentdefinition_types.go

@@ -697,8 +697,6 @@ const (
 )
 
 // ExecAction describes an Action that executes a command inside a container.
-// Which may run as a K8s job or be executed inside the Lorry sidecar container, depending on the implementation.
-// Future implementations will standardize execution within Lorry.
 type ExecAction struct {
 	// Specifies the container image to be used for running the Action.
 	//
@@ -826,8 +824,6 @@ const (
 // Actions can be executed in different ways:
 //
 //   - ExecAction: Executes a command inside a container.
-//     which may run as a K8s job or be executed inside the Lorry sidecar container, depending on the implementation.
-//     Future implementations will standardize execution within Lorry.
 //     A set of predefined environment variables are available and can be leveraged within the `exec.command`
 //     to access context information such as details about pods, components, the overall cluster state,
 //     or database connection credentials.
@@ -898,11 +894,6 @@ type Action struct {
 type Probe struct {
 	Action `json:",inline"`
 
-	// TODO: remove this later.
-	//
-	// +optional
-	BuiltinHandler *BuiltinActionHandlerType `json:"builtinHandler,omitempty"`
-
 	// Specifies the number of seconds to wait after the container has started before the RoleProbe
 	// begins to detect the container's role.
 	//
@@ -928,96 +919,6 @@ type Probe struct {
 	FailureThreshold int32 `json:"failureThreshold,omitempty"`
 }
 
-// BuiltinActionHandlerType defines build-in action handlers provided by Lorry, including:
-//
-// - `mysql`
-// - `wesql`
-// - `oceanbase`
-// - `redis`
-// - `mongodb`
-// - `etcd`
-// - `postgresql`
-// - `official-postgresql`
-// - `apecloud-postgresql`
-// - `polardbx`
-// - `custom`
-// - `unknown`
-type BuiltinActionHandlerType string
-
-const (
-	MySQLBuiltinActionHandler              BuiltinActionHandlerType = "mysql"
-	WeSQLBuiltinActionHandler              BuiltinActionHandlerType = "wesql"
-	OceanbaseBuiltinActionHandler          BuiltinActionHandlerType = "oceanbase"
-	RedisBuiltinActionHandler              BuiltinActionHandlerType = "redis"
-	MongoDBBuiltinActionHandler            BuiltinActionHandlerType = "mongodb"
-	ETCDBuiltinActionHandler               BuiltinActionHandlerType = "etcd"
-	PostgresqlBuiltinActionHandler         BuiltinActionHandlerType = "postgresql"
-	OfficialPostgresqlBuiltinActionHandler BuiltinActionHandlerType = "official-postgresql"
-	ApeCloudPostgresqlBuiltinActionHandler BuiltinActionHandlerType = "apecloud-postgresql"
-	PolarDBXBuiltinActionHandler           BuiltinActionHandlerType = "polardbx"
-	CustomActionHandler                    BuiltinActionHandlerType = "custom"
-	UnknownBuiltinActionHandler            BuiltinActionHandlerType = "unknown"
-)
-
-// LifecycleActionHandler describes the implementation of a specific lifecycle action.
-//
-// Each action is deemed successful if it returns an exit code of 0 for command executions,
-// or an HTTP 200 status for HTTP(s) actions.
-// Any other exit code or HTTP status is considered an indication of failure.
-type LifecycleActionHandler struct {
-	// Specifies the name of the predefined action handler to be invoked for lifecycle actions.
-	//
-	// Lorry, as a sidecar agent co-located with the database container in the same Pod,
-	// includes a suite of built-in action implementations that are tailored to different database engines.
-	// These are known as "builtin" handlers, includes: `mysql`, `redis`, `mongodb`, `etcd`,
-	// `postgresql`, `official-postgresql`, `apecloud-postgresql`, `wesql`, `oceanbase`, `polardbx`.
-	//
-	// If the `builtinHandler` field is specified, it instructs Lorry to utilize its internal built-in action handler
-	// to execute the specified lifecycle actions.
-	//
-	// The `builtinHandler` field is of type `BuiltinActionHandlerType`,
-	// which represents the name of the built-in handler.
-	// The `builtinHandler` specified within the same `ComponentLifecycleActions` should be consistent across all
-	// actions.
-	// This means that if you specify a built-in handler for one action, you should use the same handler
-	// for all other actions throughout the entire `ComponentLifecycleActions` collection.
-	//
-	// If you need to define lifecycle actions for database engines not covered by the existing built-in support,
-	// or when the pre-existing built-in handlers do not meet your specific needs,
-	// you can use the `customHandler` field to define your own action implementation.
-	//
-	// Deprecation Notice:
-	//
-	// - In the future, the `builtinHandler` field will be deprecated in favor of using the `customHandler` field
-	//   for configuring all lifecycle actions.
-	// - Instead of using a name to indicate the built-in action implementations in Lorry,
-	//   the recommended approach will be to explicitly invoke the desired action implementation through
-	//   a gRPC interface exposed by the sidecar agent.
-	// - Developers will have the flexibility to either use the built-in action implementations provided by Lorry
-	//   or develop their own sidecar agent to implement custom actions and expose them via gRPC interfaces.
-	// - This change will allow for greater customization and extensibility of lifecycle actions,
-	//   as developers can create their own "builtin" implementations tailored to their specific requirements.
-	//
-	// +optional
-	BuiltinHandler *BuiltinActionHandlerType `json:"builtinHandler,omitempty"`
-
-	// Specifies a user-defined hook or procedure that is called to perform the specific lifecycle action.
-	// It offers a flexible and expandable approach for customizing the behavior of a Component by leveraging
-	// tailored actions.
-	//
-	// An Action can be implemented as either an ExecAction or an HTTPAction, with future versions planning
-	// to support GRPCAction,
-	// thereby accommodating unique logic for different database systems within the Action's framework.
-	//
-	// In future iterations, all built-in handlers are expected to transition to GRPCAction.
-	// This change means that Lorry or other sidecar agents will expose the implementation of actions
-	// through a GRPC interface for external invocation.
-	// Then the controller will interact with these actions via GRPCAction calls.
-	//
-	// +optional
-	CustomHandler *Action `json:"customHandler,omitempty"`
-}
-
 // ComponentLifecycleActions defines a collection of Actions for customizing the behavior of a Component.
 type ComponentLifecycleActions struct {
 	// Specifies the hook to be executed after a component's creation.
@@ -1055,7 +956,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	PostProvision *LifecycleActionHandler `json:"postProvision,omitempty"`
+	PostProvision *Action `json:"postProvision,omitempty"`
 
 	// Specifies the hook to be executed prior to terminating a component.
 	//
@@ -1098,11 +999,11 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	PreTerminate *LifecycleActionHandler `json:"preTerminate,omitempty"`
+	PreTerminate *Action `json:"preTerminate,omitempty"`
 
 	// Defines the procedure which is invoked regularly to assess the role of replicas.
 	//
-	// This action is periodically triggered by Lorry at the specified interval to determine the role of each replica.
+	// This action is periodically triggered at the specified interval to determine the role of each replica.
 	// Upon successful execution, the action's output designates the role of the replica,
 	// which should match one of the predefined role names within `componentDefinition.spec.roles`.
 	// The output is then compared with the previous successful execution result.
@@ -1176,7 +1077,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	MemberJoin *LifecycleActionHandler `json:"memberJoin,omitempty"`
+	MemberJoin *Action `json:"memberJoin,omitempty"`
 
 	// Defines the procedure to remove a replica from the replication group.
 	//
@@ -1209,7 +1110,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	MemberLeave *LifecycleActionHandler `json:"memberLeave,omitempty"`
+	MemberLeave *Action `json:"memberLeave,omitempty"`
 
 	// Defines the procedure to switch a replica into the read-only state.
 	//
@@ -1226,7 +1127,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	Readonly *LifecycleActionHandler `json:"readonly,omitempty"`
+	Readonly *Action `json:"readonly,omitempty"`
 
 	// Defines the procedure to transition a replica from the read-only state back to the read-write state.
 	//
@@ -1245,7 +1146,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	Readwrite *LifecycleActionHandler `json:"readwrite,omitempty"`
+	Readwrite *Action `json:"readwrite,omitempty"`
 
 	// Defines the procedure for exporting the data from a replica.
 	//
@@ -1264,7 +1165,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	DataDump *LifecycleActionHandler `json:"dataDump,omitempty"`
+	DataDump *Action `json:"dataDump,omitempty"`
 
 	// Defines the procedure for importing data into a replica.
 	//
@@ -1282,7 +1183,7 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	DataLoad *LifecycleActionHandler `json:"dataLoad,omitempty"`
+	DataLoad *Action `json:"dataLoad,omitempty"`
 
 	// Defines the procedure that update a replica with new configuration.
 	//
@@ -1291,7 +1192,7 @@ type ComponentLifecycleActions struct {
 	// This Action is reserved for future versions.
 	//
 	// +optional
-	Reconfigure *LifecycleActionHandler `json:"reconfigure,omitempty"`
+	Reconfigure *Action `json:"reconfigure,omitempty"`
 
 	// Defines the procedure to generate a new database account.
 	//
@@ -1302,5 +1203,5 @@ type ComponentLifecycleActions struct {
 	// Note: This field is immutable once it has been set.
 	//
 	// +optional
-	AccountProvision *LifecycleActionHandler `json:"accountProvision,omitempty"`
+	AccountProvision *Action `json:"accountProvision,omitempty"`
 }