refactor: move solo5 prefix from block identifiers to annotation key

Ref: #315
Signed-off-by: viju <avijusanjai@gmail.com>

Author: pocopepe

pkg/unikontainers/config.go

@@ -45,7 +45,7 @@ const (
 	annotBlock         = "com.urunc.unikernel.block"
 	annotBlockMntPoint = "com.urunc.unikernel.blkMntPoint"
 	annotMountRootfs   = "com.urunc.unikernel.mountRootfs"
-	annotSolo5BlkDev   = "com.urunc.unikernel.blkDev"
+	annotBlkDev        = "com.urunc.unikernel.solo5BlkDev"
 )
 
 // A UnikernelConfig struct holds the info provided by bima image on how to execute our unikernel
@@ -59,7 +59,7 @@ type UnikernelConfig struct {
 	Block            string `json:"com.urunc.unikernel.block,omitempty"`
 	BlkMntPoint      string `json:"com.urunc.unikernel.blkMntPoint,omitempty"`
 	MountRootfs      string `json:"com.urunc.unikernel.mountRootfs"`
-	Solo5BlkDev      string `json:"com.urunc.unikernel.blkDev,omitempty"`
+	BlkDev           string `json:"com.urunc.unikernel.solo5BlkDev,omitempty"`
 }
 
 // validate checks if the mandatory configuration fields are present.
@@ -121,7 +121,7 @@ func getConfigFromSpec(spec *specs.Spec) *UnikernelConfig {
 	block := spec.Annotations[annotBlock]
 	blkMntPoint := spec.Annotations[annotBlockMntPoint]
 	MountRootfs := spec.Annotations[annotMountRootfs]
-	solo5BlkDev := spec.Annotations[annotSolo5BlkDev]
+	blkDev := spec.Annotations[annotBlkDev]
 	uniklog.WithFields(logrus.Fields{
 		"unikernelType":    tryDecode(unikernelType),
 		"unikernelVersion": tryDecode(unikernelVersion),
@@ -132,7 +132,7 @@ func getConfigFromSpec(spec *specs.Spec) *UnikernelConfig {
 		"block":            tryDecode(block),
 		"blkMntPoint":      tryDecode(blkMntPoint),
 		"mountRootfs":      tryDecode(MountRootfs),
-		"solo5BlkDev":      tryDecode(solo5BlkDev),
+		"blkDev":           tryDecode(blkDev),
 	}).WithField("source", "spec").Debug("urunc annotations")
 
 	return &UnikernelConfig{
@@ -145,7 +145,7 @@ func getConfigFromSpec(spec *specs.Spec) *UnikernelConfig {
 		Block:            block,
 		BlkMntPoint:      blkMntPoint,
 		MountRootfs:      MountRootfs,
-		Solo5BlkDev:      solo5BlkDev,
+		BlkDev:           blkDev,
 	}
 }
 
@@ -185,7 +185,7 @@ func getConfigFromJSON(jsonFilePath string) (*UnikernelConfig, error) {
 		"block":            tryDecode(conf.Block),
 		"blkMntPoint":      tryDecode(conf.BlkMntPoint),
 		"mountRootfs":      tryDecode(conf.MountRootfs),
-		"solo5BlkDev":      tryDecode(conf.Solo5BlkDev),
+		"blkDev":           tryDecode(conf.BlkDev),
 	}).WithField("source", uruncJSONFilename).Debug("urunc annotations")
 
 	return &conf, nil
@@ -256,11 +256,11 @@ func (c *UnikernelConfig) decode() error {
 	}
 	c.MountRootfs = string(decoded)
 
-	decoded, err = base64.StdEncoding.DecodeString(c.Solo5BlkDev)
+	decoded, err = base64.StdEncoding.DecodeString(c.BlkDev)
 	if err != nil {
 		return fmt.Errorf("failed to decode blkDev: %v", err)
 	}
-	c.Solo5BlkDev = string(decoded)
+	c.BlkDev = string(decoded)
 
 	return nil
 }
@@ -295,8 +295,8 @@ func (c *UnikernelConfig) Map() map[string]string {
 	if c.MountRootfs != "" {
 		myMap[annotMountRootfs] = c.MountRootfs
 	}
-	if c.Solo5BlkDev != "" {
-		myMap[annotSolo5BlkDev] = c.Solo5BlkDev
+	if c.BlkDev != "" {
+		myMap[annotBlkDev] = c.BlkDev
 	}
 
 	return myMap

pkg/unikontainers/config_test.go

@@ -38,7 +38,7 @@ func TestGetConfigFromSpec(t *testing.T) {
 				annotBlock:         "block1",
 				annotBlockMntPoint: "point1",
 				annotMountRootfs:   "true",
-				annotSolo5BlkDev:   "mydisk",
+				annotBlkDev:        "mydisk",
 			},
 		}
 
@@ -51,7 +51,7 @@ func TestGetConfigFromSpec(t *testing.T) {
 			Block:           "block1",
 			BlkMntPoint:     "point1",
 			MountRootfs:     "true",
-			Solo5BlkDev:     "mydisk",
+			BlkDev:          "mydisk",
 		}
 
 		config := getConfigFromSpec(spec)
@@ -241,7 +241,7 @@ func TestMap(t *testing.T) {
 			Block:           "block_value",
 			BlkMntPoint:     "point_value",
 			MountRootfs:     "false",
-			Solo5BlkDev:     "blkdev_value",
+			BlkDev:          "blkdev_value",
 		}
 		expectedMap := map[string]string{
 			annotCmdLine:       "cmd_value",
@@ -252,7 +252,7 @@ func TestMap(t *testing.T) {
 			annotBlock:         "block_value",
 			annotBlockMntPoint: "point_value",
 			annotMountRootfs:   "false",
-			annotSolo5BlkDev:   "blkdev_value",
+			annotBlkDev:        "blkdev_value",
 		}
 		resultMap := config.Map()
 		assert.Equal(t, expectedMap, resultMap)

pkg/unikontainers/types/types.go

@@ -86,12 +86,11 @@ type UnikernelParams struct {
 	Monitor    string   // The monitor where guest will execute
 	Version    string   // The version of the unikernel
 	InitrdPath string   // The path to the initrd of the unikernel
-	// Solo5BlkDevName is the Solo5 block device name declared at build time
-	Solo5BlkDevName string
-	Net             NetDevParams
-	Block           []BlockDevParams
-	Rootfs          RootfsParams  // Information about rootfs
-	ProcConf        ProcessConfig // Information for the process execution inside the guest
+	BlkDevName string   // The name of the guest block device declared at build time
+	Net        NetDevParams
+	Block      []BlockDevParams
+	Rootfs     RootfsParams  // Information about rootfs
+	ProcConf   ProcessConfig // Information for the process execution inside the guest
 }
 
 // ExecArgs holds the data required by Execve to start the VMM

pkg/unikontainers/unikernels/mirage.go

@@ -24,11 +24,11 @@ import (
 const MirageUnikernel string = "mirage"
 
 type Mirage struct {
-	Command         string
-	Monitor         string
-	Net             MirageNet
-	Block           []MirageBlock
-	solo5BlkDevName string
+	Command    string
+	Monitor    string
+	Net        MirageNet
+	Block      []MirageBlock
+	blkDevName string
 }
 
 type MirageNet struct {
@@ -84,7 +84,7 @@ func (m *Mirage) MonitorBlockCli() []types.MonitorBlockArgs {
 		// how MirageOS handles/configures them.
 		return []types.MonitorBlockArgs{
 			{
-				ID:   m.solo5BlkDevName,
+				ID:   m.blkDevName,
 				Path: m.Block[0].HostPath,
 			},
 		}
@@ -119,10 +119,10 @@ func (m *Mirage) Init(data types.UnikernelParams) error {
 	m.Command = strings.Join(data.CmdLine, " ")
 	m.Monitor = data.Monitor
 
-	if data.Solo5BlkDevName != "" {
-		m.solo5BlkDevName = data.Solo5BlkDevName
+	if data.BlkDevName != "" {
+		m.blkDevName = data.BlkDevName
 	} else {
-		m.solo5BlkDevName = "storage"
+		m.blkDevName = "storage"
 	}
 
 	return nil

pkg/unikontainers/unikernels/mirage_test.go

@@ -74,14 +74,14 @@ func TestMirageInitSubnetMask(t *testing.T) {
 	}
 }
 
-func TestMirageSolo5BlkDevName(t *testing.T) {
+func TestMirageBlkDevName(t *testing.T) {
 	t.Run("uses block device name from annotation", func(t *testing.T) {
 		t.Parallel()
 		m := &Mirage{}
 		err := m.Init(types.UnikernelParams{
-			Monitor:         "hvt",
-			Solo5BlkDevName: "mydisk",
-			Block:           []types.BlockDevParams{{Source: "/path/to/img"}},
+			Monitor:    "hvt",
+			BlkDevName: "mydisk",
+			Block:      []types.BlockDevParams{{Source: "/path/to/img"}},
 		})
 		assert.NoError(t, err)
 		args := m.MonitorBlockCli()

pkg/unikontainers/unikontainers.go

@@ -391,12 +391,12 @@ func (u *Unikontainer) Exec(metrics m.Writer) error {
 	// UnikernelParams
 	// populate unikernel params
 	unikernelParams := types.UnikernelParams{
-		CmdLine:         u.Spec.Process.Args,
-		EnvVars:         u.Spec.Process.Env,
-		Monitor:         vmmType,
-		Version:         unikernelVersion,
-		ProcConf:        procAttrs,
-		Solo5BlkDevName: u.State.Annotations[annotSolo5BlkDev],
+		CmdLine:    u.Spec.Process.Args,
+		EnvVars:    u.Spec.Process.Env,
+		Monitor:    vmmType,
+		Version:    unikernelVersion,
+		ProcConf:   procAttrs,
+		BlkDevName: u.State.Annotations[annotBlkDev],
 	}
 	if len(unikernelParams.CmdLine) == 0 {
 		unikernelParams.CmdLine = strings.Fields(u.State.Annotations[annotCmdLine])