added device attributes and location details as bd labels

Signed-off-by: Abhishek Agarwal <[email protected]>

Author: Abhishek Agarwal

cmd/ndm_daemonset/controller/blockdevice.go

@@ -85,7 +85,8 @@ func (di *DeviceInfo) getObjectMeta() metav1.ObjectMeta {
 		Annotations: make(map[string]string),
 		Name:        di.UUID,
 	}
-	objectMeta.Labels[KubernetesHostNameLabel] = di.NodeAttributes[HostNameKey]
+	//objectMeta.Labels[KubernetesHostNameLabel] = di.NodeAttributes[HostNameKey]
+	objectMeta.Labels = di.NodeAttributes
 	objectMeta.Labels[NDMDeviceTypeKey] = NDMDefaultDeviceType
 	objectMeta.Labels[NDMManagedKey] = TrueString
 	// adding custom labels

cmd/ndm_daemonset/controller/controller.go

@@ -103,6 +103,8 @@ type Controller struct {
 	config *rest.Config // config is the generated config using kubeconfig/incluster config
 	// Namespace is the namespace in which NDM is installed
 	Namespace string
+	//
+	LabelList string
 	// Clientset is the client used to interface with API server
 	Clientset client.Client
 	NDMConfig *NodeDiskManagerConfig // NDMConfig contains custom config for ndm
@@ -132,6 +134,13 @@ func NewController() (*Controller, error) {
 	}
 	controller.Namespace = ns
 
+	// get the namespace in which NDM is installed
+	labelList, err := getLabelList()
+	if err != nil {
+		return controller, err
+	}
+	controller.LabelList = labelList
+
 	mgr, err := manager.New(controller.config, manager.Options{Namespace: controller.Namespace, MetricsBindAddress: "0"})
 	if err != nil {
 		return controller, err
@@ -188,15 +197,15 @@ func (c *Controller) setNodeAttributes() error {
 	c.NodeAttributes[NodeNameKey] = nodeName
 
 	// set the hostname label
-	if err = c.setHostName(); err != nil {
+	if err = c.setNodeLabels(); err != nil {
 		return fmt.Errorf("unable to set node attributes:%v", err)
 	}
 	return nil
 }
 
-// setHostName set NodeAttribute field in Controller struct
+// setNodeLabels set NodeAttribute field in Controller struct
 // from the labels in node object
-func (c *Controller) setHostName() error {
+func (c *Controller) setNodeLabels() error {
 	nodeName := c.NodeAttributes[NodeNameKey]
 	// get the node object and fetch the hostname label from the
 	// node object
@@ -213,6 +222,14 @@ func (c *Controller) setHostName() error {
 	} else {
 		c.NodeAttributes[HostNameKey] = hostName
 	}
+
+	// Fill the blockdevice labels with all the topological labels of the node
+	// to which it is attached to
+	for key, value := range node.Labels {
+		if value != "" {
+			c.NodeAttributes[key] = value
+		}
+	}
 	return nil
 }
 
@@ -235,6 +252,17 @@ func getNamespace() (string, error) {
 	return ns, nil
 }
 
+
+// getLabelList get list of labels to be added to the blockdevice from env,
+// else it returns error
+func getLabelList() (string, error) {
+	labelList, ok := os.LookupEnv("LABEL_LIST")
+	if !ok {
+		return "", errors.New("error getting the list of labels")
+	}
+	return labelList, nil
+}
+
 // WaitForBlockDeviceCRD will block till the CRDs are loaded
 // into Kubernetes
 func (c *Controller) WaitForBlockDeviceCRD() {

cmd/ndm_daemonset/probe/addhandler.go

@@ -18,6 +18,7 @@ package probe
 
 import (
 	"fmt"
+	"strings"
 
 	apis "github.com/openebs/node-disk-manager/api/v1alpha1"
 	"github.com/openebs/node-disk-manager/blockdevice"
@@ -34,6 +35,20 @@ const (
 	gptUUIDScheme                   = "gpt"
 	internalFSUUIDAnnotation        = "internal.openebs.io/fsuuid"
 	internalPartitionUUIDAnnotation = "internal.openebs.io/partition-uuid"
+
+	LabelTypeVendor = "vendor"
+	LabelTypeModel = "model"
+	LabelTypeDriveType = "drive-type"
+	LabelTypeFilesystem = "fs"
+
+	// NDMVendorKey specifies the block device vendor
+	NDMVendorKey = "ndm.io/vendor"
+	// NDMModelKey specifies block device model
+	NDMModelKey = "ndm.io/model"
+	// NDMDriveType specifies the block device type (SSD/HDD/NVMe...)
+	NDMDriveType = "ndm.io/drive-type"
+	// NDMFilesystemType specifies the file system present on the block device
+	NDMFilesystemType = "ndm.io/filesystem-type"
 )
 
 // addBlockDeviceToHierarchyCache adds the given block device to the hierarchy of devices.
@@ -247,6 +262,32 @@ func (pe *ProbeEvent) addBlockDevice(bd blockdevice.BlockDevice, bdAPIList *apis
 	return nil
 }
 
+// addBlockDeviceLabels adds labels to the blockdevice resource
+func (pe *ProbeEvent) addBlockDeviceLabels(bd blockdevice.BlockDevice) {
+	// get the list of labels to be added
+	labelList := pe.Controller.LabelList
+	if labelList != "" {
+		labels := make([]string, 0)
+		labels = strings.Split(labelList, ",")
+		for _, label := range labels {
+			if len(label) == 0 {
+				switch label {
+				case LabelTypeVendor:
+					bd.Labels[NDMVendorKey] =  bd.DeviceAttributes.Vendor
+				case LabelTypeModel:
+					bd.Labels[NDMModelKey] = bd.DeviceAttributes.Model
+				case LabelTypeDriveType:
+					bd.Labels[NDMDriveType] = bd.DeviceAttributes.DriveType
+				case LabelTypeFilesystem:
+					bd.Labels[NDMFilesystemType] = bd.FSInfo.FileSystem
+				default:
+					// do nothing
+				}
+			}
+		}
+	}
+}
+
 // createBlockDeviceResourceIfNoHolders creates/updates a blockdevice resource if it does not have any
 // holder devices
 func (pe *ProbeEvent) createBlockDeviceResourceIfNoHolders(bd blockdevice.BlockDevice, bdAPIList *apis.BlockDeviceList) error {

cmd/ndm_daemonset/probe/changehandler.go

@@ -33,6 +33,9 @@ func (pe *ProbeEvent) changeBlockDevice(bd *blockdevice.BlockDevice, requestedPr
 		}
 		bd.UUID = uuid
 	}
+	// add labels to block device that may be helpful for filtering the block device
+	// based on some/generic attributes like drive-type, model, vendor etc.
+	pe.addBlockDeviceLabels(*bd)
 	pe.addBlockDeviceToHierarchyCache(*bd)
 	if !pe.Controller.ApplyFilter(bd) {
 		return nil

cmd/ndm_daemonset/probe/eventhandler.go

@@ -62,6 +62,10 @@ func (pe *ProbeEvent) addBlockDeviceEvent(msg controller.EventMessage) {
 		klog.Infof("Processing details for %s", device.DevPath)
 		pe.Controller.FillBlockDeviceDetails(device, msg.RequestedProbes...)
 
+		// add labels to block device that may be helpful for filtering the block device
+		// based on some/generic attributes like drive-type, model, vendor etc.
+		pe.addBlockDeviceLabels(*device)
+
 		// add all devices to the hierarchy cache, irrespective of whether they will be
 		// filtered at a later stage. This is done so that a complete disk hierarchy is available
 		// at all times by NDM. It also helps in device processing when complex filter configurations