support extraPreProvKernelParams in deprovisioning

This commit:
 - Makes the deprovisioning process able to update the extra kernel parameter
 field of the ironic node's driver_info before the actual deprovisioning would
 start.

This feature can come handy when the user needs different kernel options during
e.g. automated node cleaning compared to inspection.

Signed-off-by: Adam Rozman <adam.rozman@est.tech>

Author: Rozzii

internal/controller/metal3.io/baremetalhost_controller.go

@@ -1397,9 +1397,12 @@ func (r *BareMetalHostReconciler) actionDeprovisioning(prov provisioner.Provisio
 		}
 	}
 
+	DeprovisionData := provisioner.DeprovisionData{
+		PreprovisioningExtraKernelParams: r.retrievePreprovisioningExtraKernelParamsSpec(info, prov),
+	}
 	info.log.Info("deprovisioning")
 
-	provResult, err := prov.Deprovision(info.host.Status.ErrorType == metal3api.ProvisioningError)
+	provResult, err := prov.Deprovision(DeprovisionData, info.host.Status.ErrorType == metal3api.ProvisioningError)
 	if err != nil {
 		return actionError{fmt.Errorf("failed to deprovision: %w", err)}
 	}

internal/controller/metal3.io/host_state_machine_test.go

@@ -1374,7 +1374,7 @@ func (m *mockProvisioner) Provision(_ provisioner.ProvisionData, _ bool) (result
 	return m.getNextResultByMethod("Provision"), err
 }
 
-func (m *mockProvisioner) Deprovision(_ bool) (result provisioner.Result, err error) {
+func (m *mockProvisioner) Deprovision(_ provisioner.DeprovisionData, _ bool) (result provisioner.Result, err error) {
 	return m.getNextResultByMethod("Deprovision"), err
 }
 

pkg/provisioner/demo/demo.go

@@ -269,7 +269,7 @@ func (p *demoProvisioner) Provision(_ provisioner.ProvisionData, _ bool) (result
 // Deprovision removes the host from the image. It may be called
 // multiple times, and should return true for its dirty flag until the
 // deprovisioning operation is completed.
-func (p *demoProvisioner) Deprovision(_ bool) (result provisioner.Result, err error) {
+func (p *demoProvisioner) Deprovision(_ provisioner.DeprovisionData, _ bool) (result provisioner.Result, err error) {
 	p.log.Info("deprovisioning host")
 	return result, nil
 }

pkg/provisioner/fixture/fixture.go

@@ -286,7 +286,7 @@ func (p *fixtureProvisioner) Provision(data provisioner.ProvisionData, _ bool) (
 // Deprovision removes the host from the image. It may be called
 // multiple times, and should return true for its dirty flag until the
 // deprovisioning operation is completed.
-func (p *fixtureProvisioner) Deprovision(_ bool) (result provisioner.Result, err error) {
+func (p *fixtureProvisioner) Deprovision(_ provisioner.DeprovisionData, _ bool) (result provisioner.Result, err error) {
 	p.log.Info("ensuring host is deprovisioned")
 
 	result.RequeueAfter = deprovisionRequeueDelay

pkg/provisioner/ironic/ironic.go

@@ -735,6 +735,16 @@ func (p *ironicProvisioner) getPrepareOptsForNode(ironicNode *nodes.Node, data p
 	return updater
 }
 
+func (p *ironicProvisioner) getDeprovisionOptsForNode(ironicNode *nodes.Node, data provisioner.DeprovisionData) *clients.NodeUpdater {
+	updater := clients.UpdateOptsBuilder(p.log)
+	driverOpts := clients.UpdateOptsData{
+		"kernel_append_params": fmtPreprovExtraKernParams(data.PreprovisioningExtraKernelParams),
+	}
+	updater.SetDriverInfoOpts(driverOpts, ironicNode)
+
+	return updater
+}
+
 func (p *ironicProvisioner) getServicingOptsForNode(ironicNode *nodes.Node, data provisioner.ServicingData) *clients.NodeUpdater {
 	updater := clients.UpdateOptsBuilder(p.log)
 	driverOpts := clients.UpdateOptsData{
@@ -1418,14 +1428,21 @@ func (p *ironicProvisioner) setMaintenanceFlag(ironicNode *nodes.Node, value boo
 // Deprovision removes the host from the image. It may be called
 // multiple times, and should return true for its dirty flag until the
 // deprovisioning operation is completed.
-func (p *ironicProvisioner) Deprovision(restartOnFailure bool) (result provisioner.Result, err error) {
+func (p *ironicProvisioner) Deprovision(data provisioner.DeprovisionData, restartOnFailure bool) (result provisioner.Result, err error) {
 	p.log.Info("deprovisioning")
 
 	ironicNode, err := p.getNode()
 	if err != nil {
 		return transientError(err)
 	}
 
+	// Updating the kernel_append_params field of the Ironic node's
+	// API drive_info endpoint
+	_, updateSuccess, result, err := p.tryUpdateNode(ironicNode, p.getDeprovisionOptsForNode(ironicNode, data))
+	if !updateSuccess {
+		return result, err
+	}
+
 	p.log.Info("deprovisioning host",
 		"ID", ironicNode.UUID,
 		"lastError", ironicNode.LastError,

pkg/provisioner/ironic/provision_test.go

@@ -291,7 +291,7 @@ func TestDeprovision(t *testing.T) {
 		},
 		{
 			name: "deleting state",
-			ironic: testserver.NewIronic(t).Node(nodes.Node{
+			ironic: testserver.NewIronic(t).WithDefaultResponses().Node(nodes.Node{
 				ProvisionState: string(nodes.Deleting),
 				UUID:           nodeUUID,
 			}),
@@ -300,7 +300,7 @@ func TestDeprovision(t *testing.T) {
 		},
 		{
 			name: "cleaning state",
-			ironic: testserver.NewIronic(t).Node(nodes.Node{
+			ironic: testserver.NewIronic(t).WithDefaultResponses().Node(nodes.Node{
 				ProvisionState: string(nodes.Cleaning),
 				UUID:           nodeUUID,
 			}),
@@ -309,7 +309,7 @@ func TestDeprovision(t *testing.T) {
 		},
 		{
 			name: "cleanWait state",
-			ironic: testserver.NewIronic(t).Node(nodes.Node{
+			ironic: testserver.NewIronic(t).WithDefaultResponses().Node(nodes.Node{
 				ProvisionState: string(nodes.CleanWait),
 				UUID:           nodeUUID,
 			}),
@@ -351,7 +351,7 @@ func TestDeprovision(t *testing.T) {
 				t.Fatalf("could not create provisioner: %s", err)
 			}
 
-			result, err := prov.Deprovision(false)
+			result, err := prov.Deprovision(provisioner.DeprovisionData{}, false)
 
 			assert.Equal(t, tc.expectedDirty, result.Dirty)
 			assert.Equal(t, tc.expectedErrorMessage, result.ErrorMessage != "")

pkg/provisioner/provisioner.go

@@ -90,6 +90,10 @@ type AdoptData struct {
 	State metal3api.ProvisioningState
 }
 
+type DeprovisionData struct {
+	PreprovisioningExtraKernelParams string
+}
+
 type InspectData struct {
 	BootMode                         metal3api.BootMode
 	PreprovisioningExtraKernelParams string
@@ -179,7 +183,7 @@ type Provisioner interface {
 	// Deprovision removes the host from the image. It may be called
 	// multiple times, and should return true for its dirty flag until
 	// the deprovisioning operation is completed.
-	Deprovision(restartOnFailure bool) (result Result, err error)
+	Deprovision(data DeprovisionData, restartOnFailure bool) (result Result, err error)
 
 	// Delete removes the host from the provisioning system. It may be
 	// called multiple times, and should return true for its dirty