Merge pull request #3136 from Nordix/nuhakala/vbmctl-setup-network

✨ Add libvirt network creation and deletion to vbmctl

Author: metal3-io-bot

hack/ci-e2e.sh

@@ -69,15 +69,15 @@ sudo sysctl fs.inotify.max_user_instances=8192
 # Build the container image with e2e tag (used in tests)
 IMG=quay.io/metal3-io/baremetal-operator IMG_TAG=e2e make docker
 
-if ! sudo virsh net-list --all | grep baremetal-e2e; then
-    virsh -c qemu:///system net-define "${REPO_ROOT}/hack/e2e/net.xml"
-    virsh -c qemu:///system net-start baremetal-e2e
-fi
+# Build vbmctl
+make build-vbmctl
+# Create VMs to act as BMHs in the tests and the libvirt network
+./bin/vbmctl -c "${REPO_ROOT}/test/e2e/config/vbmctl.yaml" create bml
 
-# We need to create veth pair to connect metal3 net (defined above) and kind
-# docker subnet. Let us start by creating a docker network with pre-defined
-# name for bridge, so that we can configure the veth pair correctly.
-# Also assume that if kind net exists, it is created by us.
+# We need to create veth pair to connect metal3 net (defined above with vbmctl)
+# and kind docker subnet. Let us start by creating a docker network with
+# pre-defined name for bridge, so that we can configure the veth pair
+# correctly. Also assume that if kind net exists, it is created by us.
 if ! docker network list | grep kind; then
     # These options are used by kind itself. It uses docker default mtu and
     # generates ipv6 subnet ULA, but we can fix the ULA. Only addition to kind
@@ -112,11 +112,6 @@ sudo iptables -L FORWARD -n -v
 # server endpoint, not ironic.
 IP_ADDRESS="192.168.222.1"
 
-# Build vbmctl
-make build-vbmctl
-# Create VMs to act as BMHs in the tests.
-./bin/vbmctl -c "${REPO_ROOT}/test/e2e/config/vbmctl.yaml" create bml
-
 if [[ "${BMO_E2E_EMULATOR}" == "vbmc" ]]; then
   # Start VBMC
   docker start vbmc || docker run --name vbmc --network host -d \

test/e2e/config/vbmctl.yaml

@@ -15,7 +15,7 @@ spec:
       size: 20
     - name: "2"
       size: 20
-    networks:
+    networkAttachments:
     - network: baremetal-e2e
       macAddress: "00:60:2f:31:81:01"
   - name: bmo-e2e-1
@@ -26,6 +26,11 @@ spec:
       size: 20
     - name: "2"
       size: 20
-    networks:
+    networkAttachments:
     - network: baremetal-e2e
       macAddress: "00:60:2f:31:81:02"
+  networks:
+  - name: baremetal-e2e
+    bridge: metal3
+    address: 192.168.222.1
+    netmask: 255.255.255.0

test/vbmctl/README.md

@@ -17,7 +17,7 @@ This tool is under active development.
 | `vbmctl create bml` / `vbmctl delete bml` | ✅ Implemented |
 | `vbmctl status` | ✅ Implemented (basic) |
 | Configurable volumes | ❌ TODO (hard-coded to two per VM) |
-| Network management | ❌ TODO (uses existing libvirt networks) |
+| Network management | ⚠️ Partially implemented (only libvirt networks) |
 | BMC emulator support | ❌ TODO |
 | Image server | ❌ TODO |
 | State management (persistent state) | ❌ TODO |
@@ -29,6 +29,7 @@ This tool is under active development.
 - **DHCP Reservation**: Reserve IP addresses for VMs via DHCP on existing
    libvirt networks
 - **Library Support**: Can be imported as a Go module for programmatic use
+- **Libvirt network management**: create and delete libvirt networks
 
 ## Build Tags
 
@@ -60,6 +61,9 @@ vbmctl config view
 # Create a single virtual machine
 vbmctl create vm --name test-vm --memory 4096 --vcpus 2
 
+# Create network with default values (default name: baremetal-e2e)
+vbmctl create network
+
 # Create VM with custom options
 vbmctl create vm \
   --name bmo-e2e-0 \
@@ -70,7 +74,7 @@ vbmctl create vm \
   --mac-address 00:60:2f:31:81:01 \
   --ip-address 192.168.222.100
 
-# Create a bare metal lab (all VMs defined in spec.vms of the config file)
+# Create a bare metal lab (all VMs and networks defined in spec.vms of the config file)
 vbmctl create bml
 
 # Check status
@@ -82,6 +86,9 @@ vbmctl delete vm test-vm
 # Delete the bare metal lab (all VMs defined in spec.vms of the config file)
 vbmctl delete bml
 
+# Create network with default values
+vbmctl delete network
+
 # Show help
 vbmctl --help
 ```
@@ -141,10 +148,15 @@ spec:
       size: 20
     - name: "data"
       size: 10
-    networks:
+    networkAttachments:
     - network: "baremetal-e2e"
       macAddress: "00:60:2f:31:81:02"
       ipAddress: "192.168.222.101"
+  networks:
+  - name: baremetal-e2e
+    bridge: metal3
+    address: 192.168.222.1
+    netmask: 255.255.255.0
 ```
 
 The `spec.vms` section defines the VMs that will be created when you run `vbmctl
@@ -176,6 +188,23 @@ func main() {
     }
     defer conn.Close()
 
+    // Create network manager
+    networkManager, err := libvirt.NewNetworkManager(conn)
+    if err != nil {
+        return fmt.Errorf("failed to create Network manager: %w", err)
+    }
+
+    // Create a network
+    network, err := networkManager.CreateNetwork(ctx, vbmctlapi.NetworkConfig{
+        Name:    "baremetal-e2e",
+        Bridge:  "metal3",
+        Address: "192.168.222.1",
+        Netmask: "255.255.255.0",
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
     // Create VM manager
     vmManager, err := libvirt.NewVMManager(conn, libvirt.VMManagerOptions{
         PoolName: "baremetal-e2e",
@@ -195,7 +224,7 @@ func main() {
         },
         Networks: []api.NetworkAttachment{
             {
-                Network:    "baremetal-e2e",
+                Network:    "baremetal-e2e", // refers to network created above
                 MACAddress: "00:60:2f:31:81:01",
             },
         },

test/vbmctl/cmd/vbmctl/main.go

@@ -44,10 +44,10 @@ func newRootCmd() *cobra.Command {
 for testing and development purposes. It currently provides functionality for:
 
   - Creating and managing virtual machines using libvirt
+  - Creating and managing libvirt networks
   - Reserving IP addresses for VMs via DHCP on existing libvirt networks
 
 Planned features (not yet implemented):
-  - Network management (create/delete libvirt networks)
   - BMC emulator support (sushy-tools, vbmc)
   - Image server for provisioning
 
@@ -88,6 +88,7 @@ func newCreateCmd() *cobra.Command {
 
 	cmd.AddCommand(newCreateVMCmd())
 	cmd.AddCommand(newCreateBMLCmd())
+	cmd.AddCommand(newCreateNetworkCmd())
 	return cmd
 }
 
@@ -185,8 +186,9 @@ func newCreateBMLCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "bml",
 		Short: "Create a bare metal lab from configuration file",
-		Long: `Create a bare metal lab (bml) with all VMs defined in the spec.vms section
-of the configuration file.
+		Long: `Create a bare metal lab (bml) with all VMs and networks defined in the spec.vms
+and spec.networks sections of the configuration file. Note that network block can
+be omitted and VMs can be connected to existing networks as well.
 
 Example configuration:
   spec:
@@ -197,9 +199,12 @@ Example configuration:
         volumes:
           - name: "root"
             size: 20
-        networks:
+        networkAttachments:
           - network: "baremetal-e2e"
-            macAddress: "00:60:2f:31:81:01"`,
+            macAddress: "00:60:2f:31:81:01"
+	networks:
+      - name: "baremetal-e2e"
+	  - bridge: "metal3"`,
 		RunE: func(_ *cobra.Command, _ []string) error {
 			ctx, cancel := contextWithSignal()
 			defer cancel()
@@ -219,6 +224,22 @@ Example configuration:
 			}
 			defer func() { _, _ = conn.Close() }()
 
+			// Create networks before VMs
+			networkManager, err := libvirt.NewNetworkManager(conn)
+			if err != nil {
+				return fmt.Errorf("failed to create Network manager: %w", err)
+			}
+			networks, err := networkManager.CreateNetworks(ctx, cfg.Spec.Networks)
+			if err != nil {
+				return err
+			}
+			//nolint:forbidigo // CLI output is intentional
+			fmt.Println("\nCreated networks:")
+			for _, network := range networks {
+				//nolint:forbidigo // CLI output is intentional
+				fmt.Printf("  - %s (UUID: %s)\n", network.Name, network.UUID)
+			}
+
 			vmManager, err := libvirt.NewVMManager(conn, libvirt.VMManagerOptions{
 				PoolName: cfg.Spec.Pool.Name,
 				PoolPath: cfg.Spec.Pool.Path,
@@ -249,6 +270,63 @@ Example configuration:
 	return cmd
 }
 
+func newCreateNetworkCmd() *cobra.Command {
+	var (
+		name    string
+		bridge  string
+		address string
+		netmask string
+	)
+
+	cmd := &cobra.Command{
+		Use:   "network",
+		Short: "Create a network",
+		Long:  "Create a new network with the specified configuration.",
+		RunE: func(_ *cobra.Command, _ []string) error {
+			ctx, cancel := contextWithSignal()
+			defer cancel()
+
+			cfg, err := loadConfig()
+			if err != nil {
+				return err
+			}
+
+			conn, err := libvirtgo.NewConnect(cfg.Spec.Libvirt.URI)
+			if err != nil {
+				return fmt.Errorf("failed to connect to libvirt: %w", err)
+			}
+			defer func() { _, _ = conn.Close() }()
+
+			networkManager, err := libvirt.NewNetworkManager(conn)
+			if err != nil {
+				return fmt.Errorf("failed to create Network manager: %w", err)
+			}
+
+			networkCfg := vbmctlapi.NetworkConfig{
+				Name:    name,
+				Bridge:  bridge,
+				Address: address,
+				Netmask: netmask,
+			}
+
+			network, err := networkManager.CreateNetwork(ctx, networkCfg)
+			if err != nil {
+				return err
+			}
+			//nolint:forbidigo // CLI output is intentional
+			fmt.Printf("Created network: %s (UUID: %s)\n", network.Name, network.UUID)
+			return nil
+		},
+	}
+
+	cmd.Flags().StringVar(&name, "name", config.DefaultNetworkName, "name of the network")
+	cmd.Flags().StringVar(&bridge, "bridge", config.DefaultNetworkBridge, "name of the bridge interface")
+	cmd.Flags().StringVar(&address, "address", config.DefaultNetworkAddress, "address of bridge")
+	cmd.Flags().StringVar(&netmask, "netmask", config.DefaultNetworkNetmask, "netmask for network")
+
+	return cmd
+}
+
 func newDeleteCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "delete",
@@ -258,6 +336,7 @@ func newDeleteCmd() *cobra.Command {
 
 	cmd.AddCommand(newDeleteVMCmd())
 	cmd.AddCommand(newDeleteBMLCmd())
+	cmd.AddCommand(newDeleteNetworkCmd())
 	return cmd
 }
 
@@ -344,8 +423,8 @@ func newDeleteBMLCmd() *cobra.Command {
 
 			//nolint:forbidigo // CLI output is intentional
 			fmt.Printf("Deleting bare metal lab (%d VMs)...\n", len(names))
-
-			if err := vmManager.DeleteAll(ctx, names, true); err != nil {
+			err = vmManager.DeleteAll(ctx, names, true)
+			if err != nil {
 				return err
 			}
 
@@ -356,6 +435,70 @@ func newDeleteBMLCmd() *cobra.Command {
 				fmt.Printf("  - %s\n", name)
 			}
 
+			networkManager, err := libvirt.NewNetworkManager(conn)
+			if err != nil {
+				return fmt.Errorf("failed to create Network manager: %w", err)
+			}
+
+			networks := make([]string, len(cfg.Spec.Networks))
+			for i, network := range cfg.Spec.Networks {
+				networks[i] = network.Name
+			}
+
+			//nolint:forbidigo // CLI output is intentional
+			fmt.Printf("Deleting networks (%d networks)...\n", len(networks))
+
+			if err := networkManager.DeleteNetworks(ctx, networks); err != nil {
+				return err
+			}
+
+			//nolint:forbidigo // CLI output is intentional
+			fmt.Println("Deleted networks:")
+			for _, name := range networks {
+				//nolint:forbidigo // CLI output is intentional
+				fmt.Printf("  - %s\n", name)
+			}
+
+			return nil
+		},
+	}
+
+	return cmd
+}
+
+func newDeleteNetworkCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "network [name]",
+		Short: "Delete a network",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(_ *cobra.Command, args []string) error {
+			ctx, cancel := contextWithSignal()
+			defer cancel()
+
+			name := args[0]
+
+			cfg, err := loadConfig()
+			if err != nil {
+				return err
+			}
+
+			conn, err := libvirtgo.NewConnect(cfg.Spec.Libvirt.URI)
+			if err != nil {
+				return fmt.Errorf("failed to connect to libvirt: %w", err)
+			}
+			defer func() { _, _ = conn.Close() }()
+
+			networkManager, err := libvirt.NewNetworkManager(conn)
+			if err != nil {
+				return fmt.Errorf("failed to create Network manager: %w", err)
+			}
+
+			if err := networkManager.DeleteNetwork(ctx, name); err != nil {
+				return fmt.Errorf("failed to delete network: %w", err)
+			}
+
+			//nolint:forbidigo // CLI output is intentional
+			fmt.Printf("Deleted network %s\n", name)
 			return nil
 		},
 	}