feat: Add boot subcmd

Author: dennisklein

.golangci.yml

@@ -0,0 +1,36 @@
+version: "2"
+linters:
+  default: all
+  disable:
+    - depguard
+    - err113
+    - exhaustruct
+    - testpackage
+    - paralleltest
+    - wrapcheck
+  settings:
+    errcheck:
+      check-type-assertions: true
+      check-blank: true
+    gocyclo:
+      min-complexity: 15
+    goconst:
+      min-len: 3
+      min-occurrences: 3
+    lll:
+      line-length: 120
+    misspell:
+      locale: US
+    revive:
+      severity: warning
+      rules:
+        - name: exported
+        - name: package-comments
+        - name: var-naming
+    varnamelen:
+      ignore-decls:
+        - t testing.T
+        - T any
+        - ok bool
+        - w http.ResponseWriter
+        - r *http.Request

cmd/bmctl/boot.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"github.com/GSI-HPC/bmctl/pkg/bmc"
+	"github.com/spf13/cobra"
+)
+
+func newBootCmd(bmcClientConfig *bmc.ClientConfig) *cobra.Command {
+	cmd := cobra.Command{
+		Use:   "boot IMAGE",
+		Short: "Boot an image file",
+		Long: `Out-of-band initiated device boot
+
+1. Create SSH tunnel, if SSH proxy is set (expects OpenSSH ssh command in $PATH)
+2. Connect to and authenticate with BMC
+3. Start HTTPS server serving given image file
+4. Insert image URL as virtual medium
+5. Set next boot target to this virtual medium
+6. Reboot the device
+7. Wait until Ctrl+C, after which the HTTPS server is shut down
+
+Limitations (currently):
+* Works for the first device per BMC only
+* local SSH Proxy Port hardcoded to 5555
+`,
+		Args: cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx := cmd.Context()
+			img := args[0]
+
+			client, err := bmc.NewClient(ctx, *bmcClientConfig)
+			if err != nil {
+				return err
+			}
+			defer client.Close()
+
+			return client.Boot(ctx, img)
+		},
+	}
+
+	addBmcClientConfigFlags(&cmd, bmcClientConfig)
+
+	return &cmd
+}

cmd/bmctl/main.go

@@ -5,47 +5,64 @@ import (
 	"log/slog"
 	"os"
 
+	"github.com/GSI-HPC/bmctl/pkg/bmc"
 	"github.com/GSI-HPC/bmctl/pkg/cli"
-	_logging "github.com/GSI-HPC/bmctl/pkg/logging"
+	"github.com/GSI-HPC/bmctl/pkg/logging"
 	"github.com/spf13/cobra"
 )
 
-var showDebug = false
-
-func logLevel() slog.Level {
-	if showDebug {
-		return slog.LevelDebug
+func newRootCmd(showDebug *bool) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "bmctl",
+		Short: "Out-of-band datacenter device management via the BMC interface",
+		Long:  ``,
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			var logger *slog.Logger
+			if *showDebug {
+				logger = logging.NewLogger(slog.LevelDebug)
+			} else {
+				logger = logging.NewLogger(slog.LevelInfo)
+			}
+			ctx := logging.WithLogger(cmd.Context(), logger)
+			parent := cmd
+			for parent != nil {
+				parent.SetContext(ctx)
+				parent = parent.Parent()
+			}
+		},
 	}
-	return slog.LevelInfo
+	cmd.PersistentFlags().BoolVarP(showDebug, "debug", "d", false, "show debug logs")
+
+	return cmd
 }
 
-func setupLogging(cmd *cobra.Command, args []string) {
-	opts := &slog.HandlerOptions{Level: logLevel()}
-	handler := slog.NewTextHandler(os.Stderr, opts)
-	logger := slog.New(handler)
-	ctx := _logging.WithLogger(cmd.Context(), logger)
-	parent := cmd
-	for parent != nil {
-		parent.SetContext(ctx)
-		parent = parent.Parent()
+func addBmcClientConfigFlags(cmd *cobra.Command, cfg *bmc.ClientConfig) {
+	cmd.Flags().StringVarP(&cfg.Endpoint, "endpoint", "e", "", "BMC Endpoint (DNS Name or IP)")
+	cmd.Flags().StringVarP(&cfg.User, "user", "u", "", "BMC User")
+	cmd.Flags().StringVarP(&cfg.Password, "password", "p", "", "BMC Password")
+	cmd.Flags().BoolVarP(&cfg.Insecure, "insecure", "k", false, "Ignore validity of BMC TLS Cert")
+	cmd.Flags().StringVarP(&cfg.SSHProxy, "ssh-proxy", "J", "", "BMC SSH Proxy")
+	cmd.MarkFlagsRequiredTogether("user", "password")
+
+	if err := cmd.MarkFlagRequired("endpoint"); err != nil {
+		panic(err)
 	}
-}
 
-func newRootCmd() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:              "bmctl",
-		Short:            "Out-of-band datacenter device management via the BMC interface",
-		Long:             ``,
-		PersistentPreRun: setupLogging,
+	if err := cmd.MarkFlagRequired("user"); err != nil {
+		panic(err)
 	}
-	cmd.PersistentFlags().BoolVarP(&showDebug, "debug", "d", false, "show debug logs")
-	return cmd
 }
 
 func main() {
+	var (
+		showDebug       bool
+		bmcClientConfig bmc.ClientConfig
+	)
+
 	ctx := cli.SignalContext()
 
-	rootCmd := newRootCmd()
+	rootCmd := newRootCmd(&showDebug)
+	rootCmd.AddCommand(newBootCmd(&bmcClientConfig))
 	rootCmd.AddCommand(newVersionCmd())
 
 	os.Exit(cli.Execute(ctx, rootCmd))

cmd/bmctl/version.go

@@ -15,15 +15,20 @@ func newVersionCmd() *cobra.Command {
 		Long:  ``,
 		RunE:  version,
 	}
+
 	return cmd
 }
 
 func version(cmd *cobra.Command, args []string) error {
 	cmd.SetOut(os.Stdout)
+
 	info, ok := debug.ReadBuildInfo()
+
 	if !ok {
 		return errors.New("could not read embedded build info ('go build -buildvcs=true')")
 	}
+
 	cmd.Println(info.Main.Version)
+
 	return nil
 }

go.mod

@@ -1,21 +1,35 @@
-// SPDX-FileCopyrightText: 2025 GSI Helmholtzzentrum für Schwerionenforschung GmbH <https://www.gsi.de/en/>
-//
-// SPDX-License-Identifier: LGPL-3.0-or-later
-
 module github.com/GSI-HPC/bmctl
 
-go 1.23.9
+go 1.24
+
+toolchain go1.24.4
 
 require (
+	github.com/cenkalti/backoff/v5 v5.0.2
 	github.com/spf13/cobra v1.9.1
+	github.com/stmcginnis/gofish v0.20.0
 	github.com/stretchr/testify v1.10.0
+	go.abhg.dev/log/silog v0.1.0
+	golang.org/x/net v0.41.0
 	golang.org/x/sys v0.33.0
 )
 
 require (
+	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
+	github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
+	github.com/charmbracelet/lipgloss v1.1.0 // indirect
+	github.com/charmbracelet/x/ansi v0.8.0 // indirect
+	github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
+	github.com/charmbracelet/x/term v0.2.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.16 // indirect
+	github.com/muesli/termenv v0.16.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,17 +1,53 @@
+github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
+github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
+github.com/cenkalti/backoff/v5 v5.0.2 h1:rIfFVxEf1QsI7E1ZHfp/B4DF/6QBAUhmgkxc0H7Zss8=
+github.com/cenkalti/backoff/v5 v5.0.2/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw=
+github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs=
+github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
+github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
+github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
+github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2llXn7xE=
+github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q=
+github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8=
+github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs=
+github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
+github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
+github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc=
+github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
+github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
+github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
 github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
 github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
 github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stmcginnis/gofish v0.20.0 h1:hH2V2Qe898F2wWT1loApnkDUrXXiLKqbSlMaH3Y1n08=
+github.com/stmcginnis/gofish v0.20.0/go.mod h1:PzF5i8ecRG9A2ol8XT64npKUunyraJ+7t0kYMpQAtqU=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
+go.abhg.dev/log/silog v0.1.0 h1:sTX2OQoCPD/gqzYInA2qBTG5/qxWQzumJXnEnGvsvTs=
+go.abhg.dev/log/silog v0.1.0/go.mod h1:Vgqa6nHloXreG/TQCYG2CHofhHPCm8DEVv80WnxPYTs=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
+golang.org/x/net v0.41.0 h1:vBTly1HeNPEn3wtREYfy4GZ/NECgw2Cnl+nK6Nz3uvw=
+golang.org/x/net v0.41.0/go.mod h1:B/K4NNqkfmg07DQYrbwvSluqCJOOXwUjeb/5lOisjbA=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
 golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=

pkg/bmc/bmc.go

@@ -0,0 +1,2 @@
+// Package bmc provides the client API to interact with a Baseboard Management Controller
+package bmc

pkg/bmc/client.go

@@ -0,0 +1,83 @@
+package bmc
+
+import (
+	"context"
+	"fmt"
+	"log/slog"
+
+	"github.com/GSI-HPC/bmctl/pkg/logging"
+	"github.com/GSI-HPC/bmctl/pkg/ssh"
+	"github.com/stmcginnis/gofish"
+)
+
+// ClientConfig holds configuration for connecting to a BMC endpoint.
+type ClientConfig struct {
+	Endpoint string
+	User     string
+	Password string
+	Insecure bool
+	SSHProxy string
+}
+
+// Client provides methods to interact with a BMC.
+type Client struct {
+	closeProxy ssh.ProxyCloser
+	gofish     *gofish.APIClient
+	logger     *slog.Logger
+}
+
+// NewClient creates a new Client with the given configuration.
+func NewClient(ctx context.Context, cfg ClientConfig) (*Client, error) {
+	dialer, closeProxy, err := ssh.NewProxyDialer(ctx, cfg.SSHProxy)
+	if err != nil {
+		closeProxy()
+
+		return nil, err
+	}
+
+	httpClient, err := newHTTPClient(cfg.Insecure, dialer)
+	if err != nil {
+		closeProxy()
+
+		return nil, err
+	}
+
+	gofishCfg := gofish.ClientConfig{
+		Endpoint:   "https://" + cfg.Endpoint,
+		Username:   cfg.User,
+		Password:   cfg.Password,
+		BasicAuth:  false,
+		HTTPClient: httpClient,
+	}
+
+	gofishClient, err := gofish.ConnectContext(ctx, gofishCfg)
+	if err != nil {
+		closeProxy()
+
+		return nil, err
+	}
+
+	logger := logging.FromContext(ctx).
+		With(slog.String("bmc_client", fmt.Sprintf("%s@%s", cfg.User, cfg.Endpoint)))
+	logger.Debug("BMC connected")
+
+	return &Client{
+		closeProxy: closeProxy,
+		gofish:     gofishClient,
+		logger:     logger,
+	}, nil
+}
+
+// Boot performs a BMC initiated virtual media boot.
+func (c *Client) Boot(ctx context.Context, img string) error {
+	c.logger.Info(c.gofish.GetService().RedfishVersion)
+
+	return nil
+}
+
+// Close releases any resources held by the Client.
+func (c *Client) Close() {
+	c.gofish.Logout()
+	c.logger.Debug("BMC disconnected")
+	c.closeProxy()
+}