Set external_http_url on the node when BMC is IPv6

When the BMC address is IPv6, we need to set the `external_http_url`
value on the node so that the node can access the provisioning image.

Author: honza

docs/configuration.md

@@ -44,6 +44,10 @@ but overflows could happen in case of slow provisioners and / or higher number o
 concurrent reconciles. For such reasons, it is highly recommended to keep
 BMO_CONCURRENCY value lower than the requested PROVISIONING_LIMIT. Default is 20.
 
+`IRONIC_EXTERNAL_URL_V6` -- This is the URL where Ironic will find the image for
+nodes that use IPv6. In dual stack environments, this can be used to tell Ironic which IP
+version it should set on the BMC.
+
 Kustomization Configuration
 ---------------------------
 

pkg/provisioner/ironic/factory.go

@@ -3,6 +3,7 @@ package ironic
 import (
 	"errors"
 	"fmt"
+	"net/url"
 	"os"
 	"strconv"
 	"strings"
@@ -153,6 +154,17 @@ func loadConfigFromEnv(havePreprovImgBuilder bool) (ironicConfig, error) {
 		c.liveISOForcePersistentBootDevice = forcePersistentBootDevice
 	}
 
+	c.externalURL = os.Getenv("IRONIC_EXTERNAL_URL_V6")
+
+	// Let's see if externalURL looks like a URL
+	if c.externalURL != "" {
+		_, externalURLParseErr := url.Parse(c.externalURL)
+
+		if externalURLParseErr != nil {
+			return c, externalURLParseErr
+		}
+	}
+
 	return c, nil
 }
 

pkg/provisioner/ironic/ironic.go

@@ -2,6 +2,7 @@ package ironic
 
 import (
 	"fmt"
+	"net"
 	"strings"
 	"time"
 
@@ -75,6 +76,7 @@ type ironicConfig struct {
 	deployISOURL                     string
 	liveISOForcePersistentBootDevice string
 	maxBusyHosts                     int
+	externalURL                      string
 }
 
 // Provisioner implements the provisioning.Provisioner interface
@@ -352,6 +354,7 @@ func (p *ironicProvisioner) ValidateManagementAccess(data provisioner.Management
 	}
 
 	driverInfo := bmcAccess.DriverInfo(p.bmcCreds)
+	driverInfo = setExternalURL(p, driverInfo)
 	deployImageInfo := setDeployImage(driverInfo, p.config, bmcAccess, data.PreprovisioningImage)
 
 	// If we have not found a node yet, we need to create one
@@ -580,6 +583,48 @@ func (p *ironicProvisioner) PreprovisioningImageFormats() ([]metal3v1alpha1.Imag
 	return formats, nil
 }
 
+func setExternalURL(p *ironicProvisioner, driverInfo map[string]interface{}) map[string]interface{} {
+	if _, ok := driverInfo["external_http_url"]; ok {
+		driverInfo["external_http_url"] = nil
+	}
+
+	if p.config.externalURL == "" {
+		return driverInfo
+	}
+
+	parsedURL, err := bmc.GetParsedURL(p.bmcAddress)
+	if err != nil {
+		p.log.Info("Failed to parse BMC address", "bmcAddress", p.bmcAddress, "err", err)
+		return driverInfo
+	}
+
+	ip := net.ParseIP(parsedURL.Hostname())
+	if ip == nil {
+		// Maybe it's a hostname?
+		ips, err := net.LookupIP(p.bmcAddress)
+		if err != nil {
+			p.log.Info("Failed to look up the IP address for BMC hostname", "hostname", p.bmcAddress)
+			return driverInfo
+		}
+
+		if len(ips) == 0 {
+			p.log.Info("Zero IP addresses for BMC hostname", "hostname", p.bmcAddress)
+			return driverInfo
+		}
+
+		ip = ips[0]
+	}
+
+	// In the case of IPv4, we don't have to do anything.
+	if ip.To4() != nil {
+		return driverInfo
+	}
+
+	driverInfo["external_http_url"] = p.config.externalURL
+
+	return driverInfo
+}
+
 func setDeployImage(driverInfo map[string]interface{}, config ironicConfig, accessDetails bmc.AccessDetails, hostImage *provisioner.PreprovisioningImage) optionsData {
 	deployImageInfo := optionsData{
 		deployKernelKey:  nil,

pkg/provisioner/ironic/validatemanagementaccess_test.go

@@ -1148,3 +1148,98 @@ func TestSetDeployImage(t *testing.T) {
 		})
 	}
 }
+
+func TestSetExternalURL(t *testing.T) {
+	host := makeHost()
+	host.Spec.BMC.Address = "redfish-virtualmedia://[fe80::fc33:62ff:fe83:8a76]:6233"
+
+	ironic := testserver.NewIronic(t).Ready().
+		Node(nodes.Node{
+			Name: host.Namespace + nameSeparator + host.Name,
+			UUID: host.Status.Provisioning.ID,
+		}).NodeUpdate(nodes.Node{
+		UUID: host.Status.Provisioning.ID,
+	})
+
+	ironic.Start()
+	defer ironic.Stop()
+
+	auth := clients.AuthConfig{Type: clients.NoAuth}
+	prov, err := newProvisionerWithSettings(host, bmc.Credentials{}, nil,
+		ironic.Endpoint(), auth, testserver.NewInspector(t).Endpoint(), auth,
+	)
+
+	if err != nil {
+		t.Fatalf("could not create provisioner: %s", err)
+	}
+
+	prov.config.externalURL = "XXX"
+
+	driverInfo := make(map[string]interface{}, 0)
+	updatedDriverInfo := setExternalURL(prov, driverInfo)
+
+	assert.Equal(t, "XXX", updatedDriverInfo["external_http_url"])
+}
+
+func TestSetExternalURLIPv4(t *testing.T) {
+	host := makeHost()
+	host.Spec.BMC.Address = "redfish-virtualmedia://1.1.1.1:1111"
+
+	ironic := testserver.NewIronic(t).Ready().
+		Node(nodes.Node{
+			Name: host.Namespace + nameSeparator + host.Name,
+			UUID: host.Status.Provisioning.ID,
+		}).NodeUpdate(nodes.Node{
+		UUID: host.Status.Provisioning.ID,
+	})
+
+	ironic.Start()
+	defer ironic.Stop()
+
+	auth := clients.AuthConfig{Type: clients.NoAuth}
+	prov, err := newProvisionerWithSettings(host, bmc.Credentials{}, nil,
+		ironic.Endpoint(), auth, testserver.NewInspector(t).Endpoint(), auth,
+	)
+
+	if err != nil {
+		t.Fatalf("could not create provisioner: %s", err)
+	}
+
+	prov.config.externalURL = "XXX"
+
+	driverInfo := make(map[string]interface{}, 0)
+	updatedDriverInfo := setExternalURL(prov, driverInfo)
+
+	assert.Equal(t, nil, updatedDriverInfo["external_http_url"])
+}
+
+func TestSetExternalURLRemoving(t *testing.T) {
+	host := makeHost()
+	host.Spec.BMC.Address = "redfish-virtualmedia://1.1.1.1:1111"
+
+	ironic := testserver.NewIronic(t).Ready().
+		Node(nodes.Node{
+			Name: host.Namespace + nameSeparator + host.Name,
+			UUID: host.Status.Provisioning.ID,
+		}).NodeUpdate(nodes.Node{
+		UUID: host.Status.Provisioning.ID,
+	})
+
+	ironic.Start()
+	defer ironic.Stop()
+
+	auth := clients.AuthConfig{Type: clients.NoAuth}
+	prov, err := newProvisionerWithSettings(host, bmc.Credentials{}, nil,
+		ironic.Endpoint(), auth, testserver.NewInspector(t).Endpoint(), auth,
+	)
+
+	if err != nil {
+		t.Fatalf("could not create provisioner: %s", err)
+	}
+
+	driverInfo := make(map[string]interface{}, 0)
+	driverInfo["external_http_url"] = "non-empty"
+	updatedDriverInfo := setExternalURL(prov, driverInfo)
+
+	assert.Equal(t, nil, updatedDriverInfo["external_http_url"])
+}