Embed prebuilt eden-sdn VM image inside the container

Previously, the lfedge/eden-sdn container included only the SDN service layer
(sdnagent and its dependencies). This change builds a complete eden-sdn VM
image—including bootloader, kernel, containerd, etc.—and packages it directly
into the container, similar to how EVE images are handled in lfedge/eve.

This significantly speeds up the eden-sdn setup process by eliminating the need
to rebuild the VM image during each `eden setup`.

Additionally, the VM image now uses legacy BIOS boot instead of UEFI, which is
sufficient for eden-sdn and simplifies the boot process.

Finally, eden-sdn now follows its own semantic versioning, independent of
eden. Its version is manually defined in `sdn/VERSION`, ensuring that
eden-sdn is not unnecessarily rebuilt and published with a new image tag
when unrelated eden components change.

These are initial steps towards integrating eden-sdn into eden tests
and github workflows.

Signed-off-by: Milan Lenco <milan@zededa.com>

Author: milan-zededa

Makefile

@@ -5,7 +5,6 @@ DO_DOCKER ?= 1
 
 DOCKER_TARGET ?= load
 DOCKER_PLATFORM ?= $(shell uname -s | tr '[A-Z]' '[a-z]')/$(subst aarch64,arm64,$(subst x86_64,amd64,$(shell uname -m)))
-LINUXKIT_TARGET ?= build
 
 # ESERVER_TAG is the tag for eserver image to build
 ESERVER_TAG ?= "lfedge/eden-http-server"
@@ -33,8 +32,7 @@ ifeq ($(EDEN_VERSION),)
 	EDEN_VERSION = $(shell git describe --always)
 endif
 
-# SDN_DIR is the directory with eden-sdn Dockerfile to build
-SDN_DIR=$(CURDIR)/sdn/vm
+SDN_DIR=$(CURDIR)/sdn
 
 # HOSTARCH is the host architecture
 # ARCH is the target architecture
@@ -158,9 +156,7 @@ push-multi-arch-eden:
 	@docker buildx build --$(DOCKER_TARGET) --platform $(DOCKER_PLATFORM) --tag $(EDEN_TAG):$(EDEN_VERSION) .
 
 push-multi-arch-sdn: $(LINUXKIT)
-	$(eval SDN_TAG = $(shell $(LINUXKIT) pkg show-tag $(SDN_DIR)))
-	@echo "$(LINUXKIT_TARGET) eden-sdn image $(SDN_TAG)"
-	@$(LINUXKIT) pkg $(LINUXKIT_TARGET) --force --platforms $(DOCKER_PLATFORM) --docker --build-yml build.yml $(SDN_DIR)
+	$(MAKE) -C $(SDN_DIR) LINUXKIT=$(LINUXKIT) DOCKER_TARGET=$(DOCKER_TARGET) DOCKER_PLATFORM=$(DOCKER_PLATFORM)
 
 push-multi-arch-processing:
 	@echo "Build and $(DOCKER_TARGET) processing image $(PROCESSING_TAG):$(PROCESSING_VERSION)"

cmd/edenSetup.go

@@ -83,7 +83,7 @@ func newSetupCmd(configName, verbosity *string) *cobra.Command {
 	addSdnImageOpt(setupCmd, cfg)
 	addSdnDisableOpt(setupCmd, cfg)
 	addSdnSourceDirOpt(setupCmd, cfg)
-	addSdnLinuxkitOpt(setupCmd, cfg)
+	addSdnVersionOpt(setupCmd, cfg)
 
 	return setupCmd
 }

cmd/sdn.go

@@ -336,8 +336,8 @@ func addSdnConfigDirOpt(parentCmd *cobra.Command, cfg *openevec.EdenSetupArgs) {
 	parentCmd.Flags().StringVarP(&cfg.Sdn.ConfigDir, "sdn-config-dir", "", "", "directory where to put generated SDN-related config files")
 }
 
-func addSdnLinuxkitOpt(parentCmd *cobra.Command, cfg *openevec.EdenSetupArgs) {
-	parentCmd.Flags().StringVarP(&cfg.Sdn.LinuxkitBin, "sdn-linuxkit-bin", "", "", "path to linuxkit binary used to build SDN VM")
+func addSdnVersionOpt(parentCmd *cobra.Command, cfg *openevec.EdenSetupArgs) {
+	parentCmd.Flags().StringVarP(&cfg.Sdn.Version, "sdn-version", "", defaults.DefaultSDNVersion, "Eden-SDN version")
 }
 
 func addSdnIPv6Opt(parentCmd *cobra.Command, cfg *openevec.EdenSetupArgs) {

pkg/defaults/defaults.go

@@ -59,6 +59,7 @@ const (
 	DefaultRegistryTag          = "2.7"
 	DefaultProcTag              = "83cfe07"
 	DefaultMkimageTag           = "8.5.0"
+	DefaultSDNVersion           = "v1.0.0"
 	DefaultImage                = "library/alpine"
 	DefaultAdamContainerRef     = "lfedge/adam"
 	DefaultRedisContainerRef    = "redis"

pkg/defaults/templates.go

@@ -284,6 +284,9 @@ sdn:
     #disable SDN
     disable: '{{parse "sdn.disable"}}'
 
+    #Eden-SDN version
+    version: '{{parse "sdn.version"}}'
+
     #directory with SDN source code
     source-dir: '{{parse "sdn.source-dir"}}'
 
@@ -293,9 +296,6 @@ sdn:
     #live image of SDN
     image-file: '{{parse "sdn.image-file"}}'
 
-    #path to linuxkit binary used to build SDN VM
-    linuxkit-bin: '{{parse "sdn.linuxkit-bin"}}'
-
     #CPU count for SDN VM
     cpu: {{parse "sdn.cpu"}}
 

pkg/edensdn/client.go

@@ -191,7 +191,7 @@ func (client *SdnClient) SSHIntoSdnVM() error {
 	return utils.RunCommandForeground("ssh", client.sshArgs()...)
 }
 
-// SSHPortFowarding : establish port forwarding between the host and the SDN VM using ssh.
+// SSHPortForwarding : establish port forwarding between the host and the SDN VM using ssh.
 // Close the tunnel by running returned "close" function.
 func (client *SdnClient) SSHPortForwarding(localPort, targetPort uint16,
 	targetIP string) (close func(), err error) {

pkg/edensdn/qemu.go

@@ -106,7 +106,6 @@ func (vm *SdnVMQemuRunner) Start() error {
 	// QEMU config
 	qemuConfigPath := filepath.Join(vm.ConfigDir, "qemu.conf")
 	settings := utils.QemuSettings{
-		Firmware: vm.Firmware,
 		MemoryMB: vm.RAM,
 		CPUs:     vm.CPU,
 	}

pkg/edensdn/vm.go

@@ -29,7 +29,6 @@ type SdnVMConfig struct {
 	ConfigDir      string
 	CPU            int
 	RAM            int // in MB
-	Firmware       []string
 	NetModel       model.NetworkModel
 	TelnetPort     uint16
 	SSHPort        uint16

pkg/openevec/config.go

@@ -162,12 +162,12 @@ type GcpConfig struct {
 }
 
 type SdnConfig struct {
+	Version        string `mapstructure:"version" cobraflag:"sdn-version"`
 	ImageFile      string `mapstructure:"image-file" cobraflag:"sdn-image-file"`
 	SourceDir      string `mapstructure:"source-dir" cobraflag:"sdn-source-dir" resolvepath:""`
 	RAM            int    `mapstructure:"ram" cobraflag:"sdn-ram"`
 	CPU            int    `mapstructure:"cpu" cobraflag:"sdn-cpu"`
 	ConfigDir      string `mapstructure:"config-dir" cobraflag:"sdn-config-dir" resolvepath:""`
-	LinuxkitBin    string `mapstructure:"linuxkit-bin" cobraflag:"sdn-linuxkit-bin" resolvepath:""`
 	NetModelFile   string `mapstructure:"network-model" cobraflag:"sdn-network-model" resolvepath:""`
 	ConsoleLogFile string `mapstructure:"console-log" cobraflag:"sdn-console-log" resolvepath:""`
 	Disable        bool   `mapstructure:"disable" cobraflag:"sdn-disable"`

pkg/openevec/defaults.go

@@ -185,6 +185,7 @@ func GetDefaultConfig(projectRootPath string) (*EdenSetupArgs, error) {
 		},
 
 		Sdn: SdnConfig{
+			Version:        defaults.DefaultSDNVersion,
 			RAM:            defaults.DefaultSdnMemory,
 			CPU:            defaults.DefaultSdnCpus,
 			ConsoleLogFile: filepath.Join(projectRootPath, defaults.DefaultDist, "sdn-console.log"),
@@ -195,8 +196,7 @@ func GetDefaultConfig(projectRootPath string) (*EdenSetupArgs, error) {
 			SSHPort:        defaults.DefaultSdnSSHPort,
 			SourceDir:      filepath.Join(projectRootPath, "sdn"),
 			ConfigDir:      filepath.Join(edenDir, fmt.Sprintf("%s-sdn", "default")),
-			ImageFile:      filepath.Join(imageDist, "eden", "sdn-efi.qcow2"),
-			LinuxkitBin:    filepath.Join(projectRootPath, defaults.DefaultBuildtoolsDir, "linuxkit"),
+			ImageFile:      filepath.Join(imageDist, "eden", "eden-sdn.qcow2"),
 			NetModelFile:   "",
 			EnableIPv6:     false,
 			IPv6Subnet:     defaults.DefaultSdnIPv6Subnet,