Support RAID and BIOS configuration for Baremetal Server

pkg/apis/metal3/v1alpha1/baremetalhost_types.go

@@ -1,6 +1,7 @@
 package v1alpha1
 
 import (
+	"github.com/gophercloud/gophercloud/openstack/baremetal/v1/nodes"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
@@ -86,6 +87,10 @@ const (
 	// learn about the hardware components available there
 	StateInspecting ProvisioningState = "inspecting"
 
+	// StateCleaning means Ironic are running the referenced CleanSteps via
+	// manual cleaning for RAID and BIOS configuration
+	StateCleaning ProvisioningState = "cleaning"
+
 	// StatePowerManagementError means something went wrong trying to
 	// power the server on or off.
 	StatePowerManagementError ProvisioningState = "power management error"
@@ -104,6 +109,49 @@ type BMCDetails struct {
 	CredentialsName string `json:"credentialsName"`
 }
 
+type RAIDVolume struct {
+	// Size (Integer) of the logical disk to be created in GiB.  If unspecified, "MAX" will be used.
+	SizeGB *int `json:"sizeGB"`
+
+	// RAID level for the logical disk.
+	RAIDLevel string `json:"raidLevel" required:"true"`
+
+	// Name of the volume. Should be unique within the Node. If not specified, volume name will be auto-generated.
+	VolumeName string `json:"volumeName,omitempty"`
+
+	// Set to true if this logical disk can share physical disks with other logical disks.
+	SharePhysicalDisks *bool `json:"sharePhysicalDisks,omitempty"`
+
+	// If this is not specified, disk type will not be a criterion to find backing physical disks
+	DiskType string `json:"diskType,omitempty"`
+
+	// If this is not specified, interface type will not be a criterion to find backing physical disks.
+	InterfaceType string `json:"interfaceType,omitempty"`
+
+	// Integer, number of disks to use for the logical disk. Defaults to minimum number of disks required
+	// for the particular RAID level.
+	NumberOfPhysicalDisks int `json:"numberOfPhysicalDisks,omitempty"`
+
+	// The name of the controller as read by the RAID interface.
+	Controller string `json:"controller,omitempty"`
+
+	// A list of physical disks to use as read by the RAID interface.
+	PhysicalDisks []string `json:"physicalDisks,omitempty"`
+}
+
+// RAIDConfig contains the configuration that are required to config RAID in Bare Metal server
+type RAIDConfig struct {
+
+	// The logical disk that will be root volume
+	RootVolume *RAIDVolume `json:"rootVolume,omitempty"`
+
+	// The list of logical disks
+	Volumes []RAIDVolume `json:"volumes,omitempty"`
+}
+
+// BIOSConfig contains the configuration that are required to config BIOS in Bare Metal server
+type BIOSConfig map[string]interface{}
+
 // BareMetalHostSpec defines the desired state of BareMetalHost
 type BareMetalHostSpec struct {
 	// Important: Run "operator-sdk generate k8s" to regenerate code
@@ -118,6 +166,12 @@ type BareMetalHostSpec struct {
 	// How do we connect to the BMC?
 	BMC BMCDetails `json:"bmc,omitempty"`
 
+	// RAID configuration for bare metal server
+	RAID RAIDConfig `json:"raid,omitempty"`
+
+	// BIOS configurations for bare metal server
+	BIOS BIOSConfig `json:"bios,omitempty"`
+
 	// What is the name of the hardware profile for this host? It
 	// should only be necessary to set this when inspection cannot
 	// automatically determine the profile.
@@ -351,6 +405,9 @@ type BareMetalHostStatus struct {
 	// The hardware discovered to exist on the host.
 	HardwareDetails *HardwareDetails `json:"hardware,omitempty"`
 
+	// The executed CleanSteps on the host.
+	CleanSteps []nodes.CleanStep `json:"cleanSteps,omitempty"`
+
 	// Information tracked by the provisioner.
 	Provisioning ProvisionStatus `json:"provisioning"`
 
@@ -529,6 +586,18 @@ func (host *BareMetalHost) NeedsHardwareInspection() bool {
 	return host.Status.HardwareDetails == nil
 }
 
+// NeedManualCleaning looks at the state of the host to determine
+// if Clean Steps are needed to be run
+func (host *BareMetalHost) NeedsManualCleaning(cleanSteps []nodes.CleanStep) bool {
+	if host.Status.CleanSteps != nil {
+		return false
+	} else if len(cleanSteps) > 0 {
+		// Never run manual cleaning if RAID or BIOS is not configured
+		return true
+	}
+	return false
+}
+
 // NeedsProvisioning compares the settings with the provisioning
 // status and returns true when more work is needed or false
 // otherwise.

pkg/apis/metal3/v1alpha1/baremetalhost_types_test.go

@@ -1,6 +1,7 @@
 package v1alpha1
 
 import (
+	"github.com/gophercloud/gophercloud/openstack/baremetal/v1/nodes"
 	"testing"
 	"time"
 
@@ -151,6 +152,107 @@ func TestHostNeedsHardwareInspection(t *testing.T) {
 	}
 }
 
+func TestHostNeedsManualCleaning(t *testing.T) {
+	testCases := []struct {
+		Scenario   string
+		Host       BareMetalHost
+		CleanSteps [] nodes.CleanStep
+		Expected   bool
+	}{
+
+		{
+			Scenario: "without cleanSteps in host status and incoming cleanSteps",
+			Host: BareMetalHost{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "myhost",
+					Namespace: "myns",
+				},
+			},
+			CleanSteps: []nodes.CleanStep{
+				{
+					Interface: "fakeInterface",
+					Step: "fakeStep",
+					Args: map[string]interface{}{
+						"fakeKey": "fakeValue",
+					},
+				},
+			},
+			Expected: true,
+		},
+
+		{
+			Scenario: "with cleanSteps in host status and incoming cleanSteps",
+			Host: BareMetalHost{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "myhost",
+					Namespace: "myns",
+				},
+				Status: BareMetalHostStatus{
+					CleanSteps: []nodes.CleanStep{
+						{
+							Interface: "myInterface",
+							Step:      "myStep",
+						},
+					},
+				},
+			},
+			CleanSteps: []nodes.CleanStep{
+				{
+					Interface: "fakeInterface",
+					Step: "fakeStep",
+					Args: map[string]interface{}{
+						"fakeKey": "fakeValue",
+					},
+				},
+			},
+			Expected: false,
+		},
+
+		{
+			Scenario: "with cleanSteps in host status and no incoming cleanSteps",
+			Host: BareMetalHost{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "myhost",
+					Namespace: "myns",
+				},
+				Status: BareMetalHostStatus{
+					CleanSteps: []nodes.CleanStep{
+						{
+							Interface: "myInterface",
+							Step:      "myStep",
+						},
+					},
+				},
+			},
+			CleanSteps: []nodes.CleanStep{},
+			Expected: false,
+		},
+
+		{
+			Scenario: "without cleanSteps in host status and no incoming cleanSteps",
+			Host: BareMetalHost{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "myhost",
+					Namespace: "myns",
+				},
+			},
+			CleanSteps: []nodes.CleanStep{},
+			Expected: false,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.Scenario, func(t *testing.T) {
+			actual := tc.Host.NeedsManualCleaning(tc.CleanSteps)
+			if tc.Expected && !actual {
+				t.Error("expected to need manual cleaning")
+			}
+			if !tc.Expected && actual {
+				t.Error("did not expect to need manual cleaning")
+			}
+		})
+	}
+}
+
 func TestHostNeedsProvisioning(t *testing.T) {
 	testCases := []struct {
 		Scenario string

pkg/bmc/access.go

@@ -3,6 +3,7 @@ package bmc
 import (
 	"net"
 	"net/url"
+	"reflect"
 	"strings"
 
 	"github.com/pkg/errors"
@@ -34,6 +35,28 @@ type AccessDetails interface {
 
 	// Boot interface to set
 	BootInterface() string
+
+	// Return the map of supported BIOS configuration keys
+	GetBIOSConfigDetails() map[string]VendorBIOSConfigSpec
+}
+
+type VendorBIOSConfigSpec struct {
+	VendorKey string
+	ValueType reflect.Kind
+	SupportedValues []interface{}
+}
+
+func (v *VendorBIOSConfigSpec) IsSupportedConfigValue (value interface{}) (isSupport bool) {
+	if v.SupportedValues == nil {
+		return true
+	} else {
+		for _, supportedValue := range v.SupportedValues {
+			if value == supportedValue {
+				return true
+			}
+		}
+	}
+	return false
 }
 
 func getTypeHostPort(address string) (bmcType, host, port, path string, err error) {

pkg/bmc/access_test.go

@@ -1,6 +1,7 @@
 package bmc
 
 import (
+	"reflect"
 	"testing"
 
 	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
@@ -211,6 +212,16 @@ func TestIPMIBootInterface(t *testing.T) {
 	}
 }
 
+func TestIPMIBiosConfigDetails(t *testing.T) {
+	acc, err := NewAccessDetails("ipmi://192.168.122.1:6233")
+	if err != nil {
+		t.Fatalf("unexpected parse error: %v", err)
+	}
+	if acc.GetBIOSConfigDetails() != nil {
+		t.Fatal("expected BIOS configuration details to be nil")
+	}
+}
+
 func TestLibvirtNeedsMAC(t *testing.T) {
 	acc, err := NewAccessDetails("libvirt://192.168.122.1:6233/")
 	if err != nil {
@@ -242,6 +253,16 @@ func TestLibvirtBootInterface(t *testing.T) {
 	}
 }
 
+func TestLibvirtBiosConfigDetails(t *testing.T) {
+	acc, err := NewAccessDetails("libvirt://192.168.122.1:6233/")
+	if err != nil {
+		t.Fatalf("unexpected parse error: %v", err)
+	}
+	if acc.GetBIOSConfigDetails() != nil {
+		t.Fatal("expected BIOS configuration details to be nil")
+	}
+}
+
 func TestParseIDRACURL(t *testing.T) {
 	T, H, P, A, err := getTypeHostPort("idrac://192.168.122.1")
 	if err != nil {
@@ -469,6 +490,17 @@ func TestIDRACBootInterface(t *testing.T) {
 	}
 }
 
+func TestIRACBiosConfigDetails(t *testing.T) {
+	acc, err := NewAccessDetails("idrac://192.168.122.1")
+	if err != nil {
+		t.Fatalf("unexpected parse error: %v", err)
+	}
+	if acc.GetBIOSConfigDetails() != nil {
+		t.Fatal("expected BIOS configuration details to be nil")
+	}
+}
+
+
 func TestParseIRMCURL(t *testing.T) {
 	T, H, P, A, err := getTypeHostPort("irmc://192.168.122.1")
 	if err != nil {
@@ -613,6 +645,17 @@ func TestIRMCBootInterface(t *testing.T) {
 	}
 }
 
+func TestIRMCBiosConfigDetails(t *testing.T) {
+	acc, err := NewAccessDetails("irmc://192.168.122.1")
+	if err != nil {
+		t.Fatalf("unexpected parse error: %v", err)
+	}
+	if !reflect.DeepEqual(acc.GetBIOSConfigDetails(), iRMCBiosConfigDetails) {
+		t.Fatal("unexpected BIOS configuration details")
+	}
+}
+
+
 func TestUnknownType(t *testing.T) {
 	acc, err := NewAccessDetails("foo://192.168.122.1")
 	if err == nil || acc != nil {

pkg/bmc/idrac.go

@@ -54,3 +54,9 @@ func (a *iDracAccessDetails) DriverInfo(bmcCreds Credentials) map[string]interfa
 func (a *iDracAccessDetails) BootInterface() string {
 	return "ipxe"
 }
+
+// GetBIOSConfigDetails return the mapping of supported BIOS configuration keys between Metal3 and iDRAC.
+// If the user use the key that does not belong to this map, this key wil be marked as unsupported in iDRAC.
+func (a *iDracAccessDetails) GetBIOSConfigDetails() map[string]VendorBIOSConfigSpec {
+	return nil
+}

pkg/bmc/ipmi.go

@@ -49,3 +49,10 @@ func (a *ipmiAccessDetails) DriverInfo(bmcCreds Credentials) map[string]interfac
 func (a *ipmiAccessDetails) BootInterface() string {
 	return "ipxe"
 }
+
+// GetBIOSConfigDetails return the mapping of supported BIOS configuration keys between Metal3 and IPMI.
+// If the user use the key that does not belong to this map, this key wil be marked as unsupported in IPMI.
+func (a *ipmiAccessDetails) GetBIOSConfigDetails() map[string] VendorBIOSConfigSpec {
+	return nil
+}
+