Merge pull request #2756 from dtantsur/require-2024.1

⚠️ Remove support for Ironic before 2024.1

Author: metal3-io-bot

pkg/provisioner/ironic/clients/client.go

@@ -91,7 +91,7 @@ func IronicClient(ironicEndpoint string, auth AuthConfig, tls TLSConfig) (client
 		return
 	}
 
-	client.Microversion = baseline
+	client.Microversion = baselineVersionString
 
 	err = updateHTTPClient(client, tls)
 	return

pkg/provisioner/ironic/clients/features.go

@@ -19,17 +19,19 @@ type AvailableFeatures struct {
 // conservative when updating this value since doing so unconditionally breaks
 // operators of older Ironic, even if the feature we need is optional.
 // Update docs/configuration.md when updating the version.
-// Version 1.81 allows retrival of Node inventory.
-const baseline = "1.81"
+// Version 1.89 allows attaching and detaching virtual media.
+const baseline = 89
+
+var baselineVersionString = fmt.Sprintf("1.%d", baseline)
 
 func GetAvailableFeatures(ctx context.Context, client *gophercloud.ServiceClient) (features AvailableFeatures, err error) {
 	mvs, err := utils.GetSupportedMicroversions(ctx, client)
 	if err != nil {
 		return
 	}
 
-	if mvs.MaxMajor != 1 || mvs.MaxMinor < 81 {
-		err = fmt.Errorf("ironic API 1.81 or newer is required, got %d.%d", mvs.MaxMajor, mvs.MaxMinor)
+	if mvs.MaxMajor != 1 || mvs.MaxMinor < baseline {
+		err = fmt.Errorf("ironic API 1.%d or newer is required, got %d.%d", baseline, mvs.MaxMajor, mvs.MaxMinor)
 		return
 	}
 
@@ -42,20 +44,8 @@ func (af AvailableFeatures) Log(logger logr.Logger) {
 	logger.Info("supported Ironic API features",
 		"maxVersion", fmt.Sprintf("1.%d", af.MaxVersion),
 		"chosenVersion", af.ChooseMicroversion(),
-		"firmwareUpdates", af.HasFirmwareUpdates(),
-		"dataImage", af.HasDataImage())
-}
-
-func (af AvailableFeatures) HasFirmwareUpdates() bool {
-	return af.MaxVersion >= 86 //nolint:mnd
-}
-
-func (af AvailableFeatures) HasServicing() bool {
-	return af.MaxVersion >= 87 //nolint:mnd
-}
-
-func (af AvailableFeatures) HasDataImage() bool {
-	return af.MaxVersion >= 89 //nolint:mnd
+		"virtualMediaGET", af.HasVirtualMediaGetAPI(),
+		"disablePowerOff", af.HasDisablePowerOff())
 }
 
 func (af AvailableFeatures) HasVirtualMediaGetAPI() bool {
@@ -75,17 +65,5 @@ func (af AvailableFeatures) ChooseMicroversion() string {
 		return "1.93"
 	}
 
-	if af.HasDataImage() {
-		return "1.89"
-	}
-
-	if af.HasServicing() {
-		return "1.87"
-	}
-
-	if af.HasFirmwareUpdates() {
-		return "1.86"
-	}
-
-	return baseline
+	return baselineVersionString
 }

pkg/provisioner/ironic/clients/features_test.go

@@ -16,11 +16,11 @@ func TestAvailableFeatures_ChooseMicroversion(t *testing.T) {
 		want    string
 	}{
 		{
-			name: fmt.Sprintf("MaxVersion < %d return microversion %s", 89, baseline),
+			name: fmt.Sprintf("MaxVersion < %d return microversion %s", 89, baselineVersionString),
 			feature: fields{
 				MaxVersion: 50,
 			},
-			want: baseline,
+			want: baselineVersionString,
 		},
 		{
 			name: fmt.Sprintf("MaxVersion = %d return %s", 89, microVersion),
@@ -48,47 +48,3 @@ func TestAvailableFeatures_ChooseMicroversion(t *testing.T) {
 		})
 	}
 }
-
-func TestAvailableFeatures_HasFirmwareUpdates(t *testing.T) {
-	maxVersion := 86
-	type fields struct {
-		MaxVersion int
-	}
-	tests := []struct {
-		name    string
-		feature fields
-		want    bool
-	}{
-		{
-			name: fmt.Sprintf("Firmware < %d", maxVersion),
-			feature: fields{
-				MaxVersion: 50,
-			},
-			want: false,
-		},
-		{
-			name: fmt.Sprintf("Firmware = %d", maxVersion),
-			feature: fields{
-				MaxVersion: 86,
-			},
-			want: true,
-		},
-		{
-			name: fmt.Sprintf("Firmware > %d", maxVersion),
-			feature: fields{
-				MaxVersion: 100,
-			},
-			want: true,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			af := AvailableFeatures{
-				MaxVersion: tt.feature.MaxVersion,
-			}
-			if got := af.HasFirmwareUpdates(); got != tt.want {
-				t.Errorf("HasFirmwareUpdates() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}

pkg/provisioner/ironic/ironic.go

@@ -756,10 +756,6 @@ func (p *ironicProvisioner) GetFirmwareComponents() ([]metal3api.FirmwareCompone
 		return nil, fmt.Errorf("could not get node to retrieve firmware components: %w", err)
 	}
 
-	if !p.availableFeatures.HasFirmwareUpdates() {
-		return nil, errors.New("current ironic version does not support firmware updates")
-	}
-
 	// We support bmc, bios, and multiple NICs components. Starting with 3 slots.
 	componentsInfo := make([]metal3api.FirmwareComponentStatus, 0, 3) //nolint:mnd
 
@@ -1833,12 +1829,6 @@ func (p *ironicProvisioner) GetDataImageStatus() (isImageAttached bool, err erro
 }
 
 func (p *ironicProvisioner) AttachDataImage(url string) (err error) {
-	// Check if Ironic API version supports DataImage API
-	// Needs version >= 1.89
-	if !p.availableFeatures.HasDataImage() {
-		return fmt.Errorf("ironic version=%d doesn't support DataImage API, needs version>=1.89", p.availableFeatures.MaxVersion)
-	}
-
 	err = nodes.AttachVirtualMedia(p.ctx, p.client, p.nodeID, nodes.AttachVirtualMediaOpts{
 		DeviceType: nodes.VirtualMediaCD,
 		ImageURL:   url,
@@ -1851,12 +1841,6 @@ func (p *ironicProvisioner) AttachDataImage(url string) (err error) {
 }
 
 func (p *ironicProvisioner) DetachDataImage() (err error) {
-	// Check if Ironic API version supports DataImage API
-	// Needs version >= 1.89
-	if !p.availableFeatures.HasDataImage() {
-		return fmt.Errorf("ironic version=%d doesn't support DataImage API, needs version>=1.89", p.availableFeatures.MaxVersion)
-	}
-
 	err = nodes.DetachVirtualMedia(p.ctx, p.client, p.nodeID, nodes.DetachVirtualMediaOpts{
 		DeviceTypes: []nodes.VirtualMediaDeviceType{nodes.VirtualMediaCD},
 	}).ExtractErr()

pkg/provisioner/ironic/register.go

@@ -244,6 +244,7 @@ func (p *ironicProvisioner) enrollNode(data provisioner.ManagementAccessData, bm
 		BootInterface:       bmcAccess.BootInterface(),
 		Name:                ironicNodeName(p.objectMeta),
 		DriverInfo:          driverInfo,
+		FirmwareInterface:   bmcAccess.FirmwareInterface(),
 		DeployInterface:     p.deployInterface(data),
 		InspectInterface:    defaultInspectInterface,
 		ManagementInterface: bmcAccess.ManagementInterface(),
@@ -257,10 +258,6 @@ func (p *ironicProvisioner) enrollNode(data provisioner.ManagementAccessData, bm
 		},
 	}
 
-	if p.availableFeatures.HasFirmwareUpdates() {
-		nodeCreateOpts.FirmwareInterface = bmcAccess.FirmwareInterface()
-	}
-
 	ironicNode, err = nodes.Create(p.ctx, p.client, nodeCreateOpts).Extract()
 	if err == nil {
 		p.publisher("Registered", "Registered new host")

pkg/provisioner/ironic/servicing.go

@@ -77,11 +77,6 @@ func (p *ironicProvisioner) startServicing(bmcAccess bmc.AccessDetails, ironicNo
 }
 
 func (p *ironicProvisioner) Service(data provisioner.ServicingData, unprepared, restartOnFailure bool) (result provisioner.Result, started bool, err error) {
-	if !p.availableFeatures.HasServicing() {
-		result, err = operationFailed(fmt.Sprintf("servicing not supported: requires API version 1.87, available is 1.%d", p.availableFeatures.MaxVersion))
-		return result, started, err
-	}
-
 	bmcAccess, err := p.bmcAccess()
 	if err != nil {
 		result, err = transientError(err)