feat: add deregister capabilities (#75)

Signed-off-by: Armando Ruocco <[email protected]> Signed-off-by: Leonardo Cecchi <[email protected]> Co-authored-by: Leonardo Cecchi <[email protected]>
cloudnative-pg · Aug 6, 2024 · 9ea12e7 · 9ea12e7
1 parent 00dc9ef
commit 9ea12e7
Show file tree

Hide file tree

Showing 7 changed files with 394 additions and 154 deletions.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -6,37 +6,25 @@ BackupCapabilitiesResult
 BackupCapability
 BackupRequest
 BackupResult
-bignum
-bool
-boolean
 ByteString
 CloudNativePG
-cncf
-cnpg
-csi
-customizable
-customizations
-edb
+DEREGISTER
+Deregister
+DeregisterRequest
+DeregisterResponse
 FalseClass
-fixnum
 GetCapabilities
 GetPluginCapabilities
 GetPluginCapabilitiesRequest
 GetPluginCapabilitiesResponse
 GetPluginMetadata
 GetPluginMetadataRequest
 GetPluginMetadataResponse
-gRPC
-html
-https
-ietf
-json
 JSONPatch
 kube
 kubernetes
 lifecycle
 LifecycleHook
-lsn
 ManifestEntry
 MetadataEntry
 MutateCluster
@@ -58,15 +46,12 @@ OperatorValidateClusterChangeResult
 OperatorValidateClusterCreateRequest
 OperatorValidateClusterCreateResult
 ParametersEntry
-pluggable
 PluginCapability
-pluginName
-postgres
 Pre
 ProbeRequest
 ProbeResponse
-proto
-reconciler
+RPC
+RPCs
 ReconcilerHooks
 ReconcilerHooksCapabilitiesRequest
 ReconcilerHooksCapabilitiesResult
@@ -86,22 +71,11 @@ SetClusterStatusResponse
 SetFirstRequired
 SetFirstRequiredRequest
 SetFirstRequiredResult
-sfixed
-sint
-slonik
-str
-tablespace
 TrueClass
-uint
-ulong
-unicode
-url
-utf
 ValidateClusterChange
 ValidateClusterCreate
 ValidateCreate
 ValidationError
-wal
 WALArchiveRequest
 WALArchiveResult
 WALCapabilitiesRequest
@@ -112,4 +86,43 @@ WALRestoreResult
 WALService
 WALStatusRequest
 WALStatusResult
+alphanumerics
+bignum
+bool
+boolean
+cncf
+cnpg
+csi
+customizable
+customizations
+edb
+fixnum
+gRPC
+html
+https
+ietf
+json
+kubernetes
+lifecycle
+lsn
+pluggable
+pluginName
+postgres
+proto
+reconciler
+reconcilers
+requeue
+rfc
+rpc
+sfixed
+sint
+slonik
+str
+tablespace
+uint
+ulong
+unicode
+url
+utf
+wal
 webhook
diff --git a/docs/docs.md b/docs/docs.md
@@ -33,6 +33,8 @@
     - [Identity](#cnpgi-identity-v1-Identity)
 
 - [operator.proto](#operator-proto)
+    - [DeregisterRequest](#cnpgi-operator-v1-DeregisterRequest)
+    - [DeregisterResponse](#cnpgi-operator-v1-DeregisterResponse)
     - [OperatorCapabilitiesRequest](#cnpgi-operator-v1-OperatorCapabilitiesRequest)
     - [OperatorCapabilitiesResult](#cnpgi-operator-v1-OperatorCapabilitiesResult)
     - [OperatorCapability](#cnpgi-operator-v1-OperatorCapability)
@@ -452,6 +454,31 @@ Intentionally empty.
 
 
 
+<a name="cnpgi-operator-v1-DeregisterRequest"></a>
+
+### DeregisterRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| definition | [bytes](#bytes) |  | This field is REQUIRED. Value of this field is the JSON serialization of the Cluster that should receive the default values |
+
+
+
+
+
+
+<a name="cnpgi-operator-v1-DeregisterResponse"></a>
+
+### DeregisterResponse
+
+
+
+
+
+
+
 <a name="cnpgi-operator-v1-OperatorCapabilitiesRequest"></a>
 
 ### OperatorCapabilitiesRequest
@@ -659,6 +686,7 @@ Intentionally empty.
 | TYPE_VALIDATE_CLUSTER_CHANGE | 2 | TYPE_VALIDATE_CLUSTER_CHANGE indicates that the Plugin is able to reply to the ValidateClusterChange RPC request |
 | TYPE_MUTATE_CLUSTER | 3 | TYPE_MUTATE_CLUSTER indicates that the Plugin is able to reply to the MutateCluster RPC request |
 | TYPE_SET_CLUSTER_STATUS | 5 | TYPE_SET_CLUSTER_STATUS indicates that the Plugin is able to set cluster status |
+| TYPE_DEREGISTER | 6 | TYPE_DEREGISTER indicates that the Plugin is able to execute the cleanup logic once it is removed from the cluster definition |
 
 
 
@@ -678,6 +706,7 @@ Intentionally empty.
 | ValidateClusterChange | [OperatorValidateClusterChangeRequest](#cnpgi-operator-v1-OperatorValidateClusterChangeRequest) | [OperatorValidateClusterChangeResult](#cnpgi-operator-v1-OperatorValidateClusterChangeResult) | ValidateClusterChange improves the behavior of the validating webhook of is called on updates of the Cluster resources |
 | MutateCluster | [OperatorMutateClusterRequest](#cnpgi-operator-v1-OperatorMutateClusterRequest) | [OperatorMutateClusterResult](#cnpgi-operator-v1-OperatorMutateClusterResult) | MutateCluster fills in the defaults inside a Cluster resource |
 | SetClusterStatus | [SetClusterStatusRequest](#cnpgi-operator-v1-SetClusterStatusRequest) | [SetClusterStatusResponse](#cnpgi-operator-v1-SetClusterStatusResponse) | SetClusterStatus is invoked at the end of the reconciliation loop and it is used to set the plugin status inside the .status.plugins[pluginName] map key |
+| Deregister | [DeregisterRequest](#cnpgi-operator-v1-DeregisterRequest) | [DeregisterResponse](#cnpgi-operator-v1-DeregisterResponse) | Deregister is invoked when the plugin is removed from the cluster definition. It is expected that the plugin executes its cleanup logic when this method is invoked. |
 
 
 
@@ -793,6 +822,7 @@ The operator type corresponds to the Kubernetes API method
 | TYPE_UPDATE | 2 |  |
 | TYPE_CREATE | 3 |  |
 | TYPE_DELETE | 4 |  |
+| TYPE_DEREGISTER | 5 |  |
 
 
 

diff --git a/pkg/lifecycle/operator_lifecycle.pb.go b/pkg/lifecycle/operator_lifecycle.pb.go