feat: allow custom clean up commands for ssh provisioner (#1100)

Signed-off-by: apedriza <[email protected]>

Author: apedriza

api/infrastructure/v1beta1/remote_machine_types.go

@@ -73,6 +73,10 @@ type RemoteMachineSpec struct {
 	// +kubebuilder:validation:Optional
 	SSHKeyRef SecretRef `json:"sshKeyRef,omitempty"`
 
+	// CustomCleanUpCommands allow the user to run custom command for the clean up process of the machine.
+	// +kubebuilder:validation:Optional
+	CustomCleanUpCommands []string `json:"customCleanUpCommands,omitempty"`
+
 	// ProvisionJob describes the kubernetes Job to use to provision the machine.
 	ProvisionJob *ProvisionJob `json:"provisionJob,omitempty"`
 }
@@ -148,6 +152,10 @@ type PooledMachineSpec struct {
 	// +kubebuilder:validation:Optional
 	UseSudo bool `json:"useSudo,omitempty"`
 
+	// CustomCleanUpCommands allow the user to run custom command for the clean up process of the machine.
+	// +kubebuilder:validation:Optional
+	CustomCleanUpCommands []string `json:"customCleanUpCommands,omitempty"`
+
 	// SSHKeyRef is a reference to a secret that contains the SSH private key.
 	// The key must be placed on the secret using the key "value".
 	// +kubebuilder:validation:Required

api/infrastructure/v1beta1/zz_generated.deepcopy.go

@@ -46,6 +46,12 @@ spec:
                     description: Address is the IP address or DNS name of the remote
                       machine.
                     type: string
+                  customCleanUpCommands:
+                    description: CustomCleanUpCommands allow the user to run custom
+                      command for the clean up process of the machine.
+                    items:
+                      type: string
+                    type: array
                   port:
                     default: 22
                     description: Port is the SSH port of the remote machine.

config/clusterapi/infrastructure/bases/infrastructure.cluster.x-k8s.io_pooledremotemachines.yaml

@@ -44,6 +44,12 @@ spec:
               address:
                 description: Address is the IP address or DNS name of the remote machine.
                 type: string
+              customCleanUpCommands:
+                description: CustomCleanUpCommands allow the user to run custom command
+                  for the clean up process of the machine.
+                items:
+                  type: string
+                type: array
               pool:
                 description: Pool is the name of the pool where the machine belongs
                   to.

config/clusterapi/infrastructure/bases/infrastructure.cluster.x-k8s.io_remotemachines.yaml

@@ -46,6 +46,12 @@ spec:
                     description: Address is the IP address or DNS name of the remote
                       machine.
                     type: string
+                  customCleanUpCommands:
+                    description: CustomCleanUpCommands allow the user to run custom
+                      command for the clean up process of the machine.
+                    items:
+                      type: string
+                    type: array
                   port:
                     default: 22
                     description: Port is the SSH port of the remote machine.

config/crd/bases/infrastructure/infrastructure.cluster.x-k8s.io_pooledremotemachines.yaml

@@ -44,6 +44,12 @@ spec:
               address:
                 description: Address is the IP address or DNS name of the remote machine.
                 type: string
+              customCleanUpCommands:
+                description: CustomCleanUpCommands allow the user to run custom command
+                  for the clean up process of the machine.
+                items:
+                  type: string
+                type: array
               pool:
                 description: Pool is the name of the pool where the machine belongs
                   to.

config/crd/bases/infrastructure/infrastructure.cluster.x-k8s.io_remotemachines.yaml

@@ -140,6 +140,13 @@ Resource Types:
 The key must be placed on the secret using the key "value".<br/>
         </td>
         <td>true</td>
+      </tr><tr>
+        <td><b>customCleanUpCommands</b></td>
+        <td>[]string</td>
+        <td>
+          CustomCleanUpCommands allow the user to run custom command for the clean up process of the machine.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>port</b></td>
         <td>integer</td>
@@ -744,6 +751,13 @@ RemoteMachineSpec defines the desired state of RemoteMachine
           Address is the IP address or DNS name of the remote machine.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>customCleanUpCommands</b></td>
+        <td>[]string</td>
+        <td>
+          CustomCleanUpCommands allow the user to run custom command for the clean up process of the machine.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>pool</b></td>
         <td>string</td>

docs/resource-reference/infrastructure.cluster.x-k8s.io-v1beta1.md

@@ -340,6 +340,7 @@ func (r *RemoteMachineController) reservePooledMachine(ctx context.Context, rm *
 	rm.Spec.User = foundPooledMachine.Spec.Machine.User
 	rm.Spec.SSHKeyRef = foundPooledMachine.Spec.Machine.SSHKeyRef
 	rm.Spec.UseSudo = foundPooledMachine.Spec.Machine.UseSudo
+	rm.Spec.CustomCleanUpCommands = foundPooledMachine.Spec.Machine.CustomCleanUpCommands
 
 	return nil
 }

internal/controller/infrastructure/remote_machine_controller.go

@@ -123,10 +123,6 @@ func (p *SSHProvisioner) Provision(ctx context.Context) error {
 // 3. Removes node from etcd
 // 4. Runs k0s reset
 func (p *SSHProvisioner) Cleanup(ctx context.Context, mode RemoteMachineMode) error {
-	if mode == ModeNonK0s {
-		return nil
-	}
-
 	authM, err := rigssh.ParseSSHPrivateKey(p.sshKey, nil)
 	if err != nil {
 		return fmt.Errorf("failed to parse ssh key: %w", err)
@@ -155,6 +151,24 @@ func (p *SSHProvisioner) Cleanup(ctx context.Context, mode RemoteMachineMode) er
 		rigClient = rigClient.Sudo()
 	}
 
+	// When k0s is not the bootstrap provider, the user can set custom commands for the clean up process.
+	if mode == ModeNonK0s {
+		if p.machine.Spec.CustomCleanUpCommands != nil {
+			p.log.Info("Cleaning up remote machine...")
+			for _, cmd := range p.machine.Spec.CustomCleanUpCommands {
+				output, err := rigClient.ExecOutput(cmd)
+				if err != nil {
+					p.log.Error(err, "failed to run command", "command", cmd, "output", output)
+				} else {
+					p.log.Info("executed command", "command", cmd, "output", output)
+				}
+			}
+		}
+
+		return nil
+	}
+
+	// k0s bootstrap provider used.
 	var cmds []string
 	if mode == ModeController {
 		cmds = append(cmds, "k0s etcd leave")
@@ -179,6 +193,7 @@ func (p *SSHProvisioner) Cleanup(ctx context.Context, mode RemoteMachineMode) er
 		cmds = append(cmds, "k0s reset --kubelet-root-dir "+kubeletRootDir)
 	}
 
+	p.log.Info("Cleaning up remote machine...")
 	for _, cmd := range cmds {
 		output, err := rigClient.ExecOutput(cmd)
 		if err != nil {