Merge pull request #3121 from Nordix/tero/add-image-server-support-vbmctl

🌱 Add image server management commands to vbmctl

Author: metal3-io-bot

hack/ci-e2e.sh

@@ -167,9 +167,7 @@ if [[ ! -f "${IMAGE_DIR}/${IPA_FILE}" ]]; then
 fi
 
 ## Start the image server
-docker start image-server-e2e || docker run --name image-server-e2e -d \
-  -p 80:8080 \
-  -v "${IMAGE_DIR}:/usr/share/nginx/html" nginxinc/nginx-unprivileged
+./bin/vbmctl create image-server --host-port 80 --image-dir "${IMAGE_DIR}" --name "vbmctl-image-server-e2e"
 
 # Generate ssh key pair for verifying provisioned BMHs
 if [[ ! -f "${IMAGE_DIR}/ssh_testkey" ]]; then

hack/clean-e2e.sh

@@ -4,7 +4,7 @@ REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 cd "${REPO_ROOT}" || exit 1
 
 docker rm -f vbmc
-docker rm -f image-server-e2e
+docker rm -f vbmctl-image-server-e2e
 docker rm -f sushy-tools
 
 "${REPO_ROOT}/tools/bmh_test/clean_local_bmh_test_setup.sh" "^bmo-e2e-"

test/go.mod

@@ -7,6 +7,8 @@ require (
 	github.com/metal3-io/baremetal-operator/apis v0.5.1
 	github.com/metal3-io/baremetal-operator/pkg/hardwareutils v0.5.1
 	github.com/metal3-io/ironic-standalone-operator/api v0.8.1
+	github.com/moby/moby/api v1.54.1
+	github.com/moby/moby/client v0.4.0
 	github.com/onsi/ginkgo/v2 v2.28.1
 	github.com/onsi/gomega v1.39.1
 	github.com/spf13/cobra v1.10.2
@@ -76,8 +78,6 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.16 // indirect
 	github.com/moby/docker-image-spec v1.3.1 // indirect
-	github.com/moby/moby/api v1.54.1 // indirect
-	github.com/moby/moby/client v0.4.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect
 	github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect

test/vbmctl/README.md

@@ -16,10 +16,10 @@ This tool is under active development.
 | VM management (create/delete/list) | ✅ Implemented |
 | `vbmctl create bml` / `vbmctl delete bml` | ✅ Implemented |
 | `vbmctl status` | ✅ Implemented (basic) |
-| Configurable volumes | ❌ TODO (hard-coded to two per VM) |
+| Configurable volumes |  ✅ Implemented |
 | Network management | ⚠️ Partially implemented (only libvirt networks) |
 | BMC emulator support | ❌ TODO |
-| Image server | ❌ TODO |
+| Image server | ✅ Implemented (basic) |
 | State management (persistent state) | ❌ TODO |
 
 ## Features
@@ -30,6 +30,7 @@ This tool is under active development.
    libvirt networks
 - **Library Support**: Can be imported as a Go module for programmatic use
 - **Libvirt network management**: create and delete libvirt networks
+- **Image Server Management**: Create, delete, list image server
 
 ## Build Tags
 
@@ -77,6 +78,10 @@ vbmctl create vm \
 # Create a bare metal lab (all VMs and networks defined in spec.vms of the config file)
 vbmctl create bml
 
+# Create an image server with default settings. Please note that if
+# a name is specified, vbmctl will automatically add the prefix `vbmctl-`.
+vbmctl create image-server
+
 # Check status
 vbmctl status
 
@@ -89,6 +94,9 @@ vbmctl delete bml
 # Create network with default values
 vbmctl delete network
 
+# Delete the image server
+vbmctl delete image-server
+
 # Show help
 vbmctl --help
 ```
@@ -157,6 +165,9 @@ spec:
     bridge: metal3
     address: 192.168.222.1
     netmask: 255.255.255.0
+  imageServer:
+    dataDir: "/tmp"
+    port: 80
 ```
 
 The `spec.vms` section defines the VMs that will be created when you run `vbmctl
@@ -175,6 +186,7 @@ import (
 
     "github.com/metal3-io/baremetal-operator/test/vbmctl/pkg/api"
     "github.com/metal3-io/baremetal-operator/test/vbmctl/pkg/libvirt"
+    "github.com/metal3-io/baremetal-operator/test/vbmctl/pkg/containers"
     libvirtgo "libvirt.org/go/libvirt"
 )
 
@@ -233,6 +245,19 @@ func main() {
         log.Fatal(err)
     }
 
+    // Create an Image Server
+    err = containers.CreateImageServerInstance(ctx, &api.ImageServerConfig{
+        Image:         "nginx:latest",
+        ContainerName: "image-server",
+        DataDir:       "/var/lib/vbmctl/images",
+        ContainerDataDir: "/usr/share/nginx/html",
+        Port:          8080,
+        ContainerPort: 80,
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
     fmt.Printf("Created VM: %s (UUID: %s)\n", vm.Config.Name, vm.UUID)
 }
 ```