Implement "k0s status" on Windows

kke · kke · commit 9bee0b971532 · 2025-11-27T15:53:02.000+02:00
Fixes #2887 Uses pipe based transport on Windows to listen and query the status service. Signed-off-by: Kimmo Lehto <klehto@mirantis.com>
diff --git a/cmd/root.go b/cmd/root.go
@@ -15,6 +15,7 @@ import (
 	"github.com/k0sproject/k0s/cmd/kubeconfig"
 	"github.com/k0sproject/k0s/cmd/kubectl"
 	"github.com/k0sproject/k0s/cmd/start"
+	"github.com/k0sproject/k0s/cmd/status"
 	"github.com/k0sproject/k0s/cmd/stop"
 	"github.com/k0sproject/k0s/cmd/sysinfo"
 	"github.com/k0sproject/k0s/cmd/token"
@@ -46,6 +47,7 @@ func NewRootCmd() *cobra.Command {
 	cmd.AddCommand(kubectl.NewK0sKubectlCmd())
 	cmd.AddCommand(start.NewStartCmd())
 	cmd.AddCommand(stop.NewStopCmd())
+	cmd.AddCommand(status.NewStatusCmd())
 	cmd.AddCommand(sysinfo.NewSysinfoCmd())
 	cmd.AddCommand(token.NewTokenCmd())
 	cmd.AddCommand(validate.NewValidateCmd()) // hidden+deprecated
diff --git a/cmd/root_linux.go b/cmd/root_linux.go
@@ -9,7 +9,6 @@ import (
 	"github.com/k0sproject/k0s/cmd/keepalived"
 	"github.com/k0sproject/k0s/cmd/reset"
 	"github.com/k0sproject/k0s/cmd/restore"
-	"github.com/k0sproject/k0s/cmd/status"
 
 	"github.com/spf13/cobra"
 )
@@ -20,5 +19,4 @@ func addPlatformSpecificCommands(root *cobra.Command) {
 	root.AddCommand(keepalived.NewKeepalivedSetStateCmd()) // hidden
 	root.AddCommand(reset.NewResetCmd())
 	root.AddCommand(restore.NewRestoreCmd())
-	root.AddCommand(status.NewStatusCmd())
 }
diff --git a/cmd/status/status.go b/cmd/status/status.go
@@ -1,5 +1,3 @@
-//go:build unix
-
 // SPDX-FileCopyrightText: 2021 k0s authors
 // SPDX-License-Identifier: Apache-2.0
 
diff --git a/cmd/worker/worker_windows.go b/cmd/worker/worker_windows.go
@@ -12,7 +12,10 @@ import (
 
 	"github.com/k0sproject/k0s/internal/pkg/dir"
 	"github.com/k0sproject/k0s/internal/pkg/log"
+	"github.com/k0sproject/k0s/pkg/build"
 	"github.com/k0sproject/k0s/pkg/component/manager"
+	"github.com/k0sproject/k0s/pkg/component/prober"
+	"github.com/k0sproject/k0s/pkg/component/status"
 	"github.com/k0sproject/k0s/pkg/component/worker"
 	"github.com/k0sproject/k0s/pkg/config"
 	"github.com/k0sproject/k0s/pkg/constant"
@@ -45,6 +48,23 @@ func initLogging(ctx context.Context, logDir string) error {
 	return nil
 }
 
-func addPlatformSpecificComponents(context.Context, *manager.Manager, *config.CfgVars, EmbeddingController, *worker.CertificateManager) {
-	// no-op
+func addPlatformSpecificComponents(ctx context.Context, m *manager.Manager, k0sVars *config.CfgVars, controller EmbeddingController, certManager *worker.CertificateManager) {
+	if controller != nil {
+		return
+	}
+
+	m.Add(ctx, &status.Status{
+		Prober: prober.DefaultProber,
+		StatusInformation: status.K0sStatus{
+			Pid:        os.Getpid(),
+			Role:       "worker",
+			Args:       os.Args,
+			Version:    build.Version,
+			Workloads:  true,
+			SingleNode: false,
+			K0sVars:    k0sVars,
+		},
+		CertManager: certManager,
+		Socket:      k0sVars.StatusSocketPath,
+	})
 }
diff --git a/pkg/autopilot/controller/setup.go b/pkg/autopilot/controller/setup.go
@@ -178,9 +178,6 @@ func (sc *setupController) createControlNode(ctx context.Context, cf apcli.Facto
 	return nil
 }
 
-// TODO re-use from somewhere else
-const DefaultK0sStatusSocketPath = "/run/k0s/status.sock"
-
 func getControlNodeAddresses(hostname string) ([]corev1.NodeAddress, error) {
 	addresses := []corev1.NodeAddress{}
 	apiAddress, err := getControllerAPIAddress()
@@ -201,7 +198,7 @@ func getControlNodeAddresses(hostname string) ([]corev1.NodeAddress, error) {
 }
 
 func getControllerAPIAddress() (string, error) {
-	status, err := status.GetStatusInfo(DefaultK0sStatusSocketPath)
+	status, err := status.GetStatusInfo(status.DefaultSocketPath)
 	if err != nil {
 		return "", err
 	}
diff --git a/pkg/autopilot/controller/signal/k0s/init.go b/pkg/autopilot/controller/signal/k0s/init.go
@@ -39,7 +39,7 @@ func RegisterControllers(ctx context.Context, logger *logrus.Entry, mgr crman.Ma
 	logger.Infof("Using effective hostname = '%v'", hostname)
 
 	k0sVersionHandler := func() (string, error) {
-		return getK0sVersion(DefaultK0sStatusSocketPath)
+		return getK0sVersion(status.DefaultSocketPath)
 	}
 
 	if err := registerSignalController(logger, mgr, signalControllerEventFilter(hostname, apsigpred.DefaultErrorHandler(logger, "k0s signal")), delegate, clusterID, k0sVersionHandler); err != nil {
diff --git a/pkg/autopilot/controller/signal/k0s/restart_unix.go b/pkg/autopilot/controller/signal/k0s/restart_unix.go
@@ -93,7 +93,7 @@ func (r *restart) Reconcile(ctx context.Context, req cr.Request) (cr.Result, err
 
 	// Get the current version of k0s
 	logger.Info("Determining the current version of k0s")
-	k0sVersion, err := getK0sVersion(DefaultK0sStatusSocketPath)
+	k0sVersion, err := getK0sVersion(status.DefaultSocketPath)
 	if err != nil {
 		logger.Info("Unable to determine current verion of k0s; requeuing")
 		return cr.Result{}, fmt.Errorf("unable to get k0s version: %w", err)
@@ -128,7 +128,7 @@ func (r *restart) Reconcile(ctx context.Context, req cr.Request) (cr.Result, err
 
 	logger.Info("Preparing to restart k0s")
 
-	k0sPid, err := getK0sPid(DefaultK0sStatusSocketPath)
+	k0sPid, err := getK0sPid(status.DefaultSocketPath)
 	if err != nil {
 		logger.Info("Unable to determine current k0s pid; requeuing")
 		return cr.Result{RequeueAfter: restartRequeueDuration}, fmt.Errorf("unable to get k0s pid: %w", err)
diff --git a/pkg/autopilot/controller/signal/k0s/restarted_unix.go b/pkg/autopilot/controller/signal/k0s/restarted_unix.go
@@ -14,6 +14,7 @@ import (
 	apdel "github.com/k0sproject/k0s/pkg/autopilot/controller/delegate"
 	apsigpred "github.com/k0sproject/k0s/pkg/autopilot/controller/signal/common/predicate"
 	apsigv2 "github.com/k0sproject/k0s/pkg/autopilot/signaling/v2"
+	"github.com/k0sproject/k0s/pkg/component/status"
 
 	"github.com/sirupsen/logrus"
 	cr "sigs.k8s.io/controller-runtime"
@@ -86,7 +87,7 @@ func (r *restarted) Reconcile(ctx context.Context, req cr.Request) (cr.Result, e
 
 	// Get the current version of k0s
 	logger.Info("Determining the current version of k0s")
-	k0sVersion, err := getK0sVersion(DefaultK0sStatusSocketPath)
+	k0sVersion, err := getK0sVersion(status.DefaultSocketPath)
 	if err != nil {
 		logger.Info("Unable to determine current verion of k0s; requeuing")
 		return cr.Result{}, fmt.Errorf("unable to get k0s version: %w", err)
diff --git a/pkg/autopilot/controller/signal/k0s/signal.go b/pkg/autopilot/controller/signal/k0s/signal.go
@@ -27,7 +27,6 @@ import (
 
 const (
 	SignalResponseProcessingTimeout = 1 * time.Minute
-	DefaultK0sStatusSocketPath      = "/run/k0s/status.sock"
 )
 
 type k0sVersionHandlerFunc func() (string, error)
diff --git a/pkg/autopilot/controller/updates/updater.go b/pkg/autopilot/controller/updates/updater.go
@@ -20,7 +20,6 @@ import (
 	apv1beta2 "github.com/k0sproject/k0s/pkg/apis/autopilot/v1beta2"
 	apcli "github.com/k0sproject/k0s/pkg/autopilot/client"
 	appc "github.com/k0sproject/k0s/pkg/autopilot/controller/plans/core"
-	"github.com/k0sproject/k0s/pkg/autopilot/controller/signal/k0s"
 	uc "github.com/k0sproject/k0s/pkg/autopilot/updater"
 	"github.com/k0sproject/k0s/pkg/build"
 	"github.com/k0sproject/k0s/pkg/component/status"
@@ -77,7 +76,7 @@ func newCronUpdater(parentCtx context.Context, updateConfig apv1beta2.UpdateConf
 		schedule = defaultCronSchedule
 	}
 
-	status, err := status.GetStatusInfo(k0s.DefaultK0sStatusSocketPath)
+	status, err := status.GetStatusInfo(status.DefaultSocketPath)
 	if err != nil {
 		return nil, err
 	}
diff --git a/pkg/component/status/client.go b/pkg/component/status/client.go
@@ -1,15 +1,11 @@
-//go:build unix
-
 // SPDX-FileCopyrightText: 2022 k0s authors
 // SPDX-License-Identifier: Apache-2.0
 
 package status
 
 import (
-	"context"
 	"encoding/json"
 	"fmt"
-	"net"
 	"net/http"
 
 	"github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
@@ -40,7 +36,7 @@ type ProbeStatus struct {
 // GetStatus returns the status of the k0s process using the status socket
 func GetStatusInfo(socketPath string) (*K0sStatus, error) {
 	status := &K0sStatus{}
-	if err := doHTTPRequestViaUnixSocket(socketPath, "status", status); err != nil {
+	if err := doStatusHTTPRequest(socketPath, "status", status); err != nil {
 		return nil, err
 	}
 	return status, nil
@@ -49,22 +45,18 @@ func GetStatusInfo(socketPath string) (*K0sStatus, error) {
 // GetComponentStatus returns the per-component events and health-checks
 func GetComponentStatus(socketPath string, maxCount int) (*prober.State, error) {
 	status := &prober.State{}
-	if err := doHTTPRequestViaUnixSocket(socketPath,
+	if err := doStatusHTTPRequest(socketPath,
 		fmt.Sprintf("components?maxCount=%d", maxCount),
 		status); err != nil {
 		return nil, err
 	}
 	return status, nil
 }
 
-func doHTTPRequestViaUnixSocket(socketPath string, path string, tgt any) error {
-	httpc := http.Client{
-		Transport: &http.Transport{
-			DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
-				var d net.Dialer
-				return d.DialContext(ctx, "unix", socketPath)
-			},
-		},
+func doStatusHTTPRequest(socketPath string, path string, tgt any) error {
+	httpc, err := newStatusHTTPClient(socketPath)
+	if err != nil {
+		return fmt.Errorf("status: can't prepare transport for %q: %w", socketPath, err)
 	}
 
 	response, err := httpc.Get("http://localhost/" + path)
diff --git a/pkg/component/status/defaults.go b/pkg/component/status/defaults.go
@@ -0,0 +1,10 @@
+// SPDX-FileCopyrightText: 2025 k0s authors
+// SPDX-License-Identifier: Apache-2.0
+
+package status
+
+import "github.com/k0sproject/k0s/pkg/constant"
+
+// DefaultSocketPath is the platform-specific default socket path used by k0s
+// when no explicit status socket is provided.
+const DefaultSocketPath = constant.StatusSocketPathDefault
diff --git a/pkg/component/status/status.go b/pkg/component/status/status.go
@@ -1,5 +1,3 @@
-//go:build unix
-
 // SPDX-FileCopyrightText: 2021 k0s authors
 // SPDX-License-Identifier: Apache-2.0
 
@@ -11,7 +9,6 @@ import (
 	"errors"
 	"net"
 	"net/http"
-	"os"
 	"strconv"
 	"time"
 
@@ -67,8 +64,7 @@ func (s *Status) Init(_ context.Context) error {
 		Handler: mux,
 	}
 
-	removeLeftovers(s.Socket)
-	s.listener, err = net.Listen("unix", s.Socket)
+	s.listener, err = newStatusListener(s.Socket)
 	if err != nil {
 		s.L.Errorf("failed to create listener %s", err)
 		return err
@@ -78,14 +74,6 @@ func (s *Status) Init(_ context.Context) error {
 	return nil
 }
 
-// removeLeftovers tries to remove leftover sockets that nothing is listening on
-func removeLeftovers(socket string) {
-	_, err := net.Dial("unix", socket)
-	if err != nil {
-		_ = os.Remove(socket)
-	}
-}
-
 // Start runs the component
 func (s *Status) Start(_ context.Context) error {
 	go func() {
@@ -103,8 +91,10 @@ func (s *Status) Stop() error {
 	if err := s.httpserver.Shutdown(ctx); err != nil && !errors.Is(err, context.Canceled) {
 		return err
 	}
-	// Unix socket doesn't need to be explicitly removed because it's handled
-	// by httpserver.Shutdown
+	if s.listener != nil {
+		_ = s.listener.Close()
+	}
+	cleanupStatusListener(s.Socket)
 	return nil
 }
 
diff --git a/pkg/component/status/transport_unix.go b/pkg/component/status/transport_unix.go
@@ -0,0 +1,40 @@
+//go:build unix
+
+// SPDX-FileCopyrightText: 2025 k0s authors
+// SPDX-License-Identifier: Apache-2.0
+
+package status
+
+import (
+	"context"
+	"net"
+	"net/http"
+	"os"
+)
+
+func newStatusListener(socketPath string) (net.Listener, error) {
+	removeLeftovers(socketPath)
+	return net.Listen("unix", socketPath)
+}
+
+func cleanupStatusListener(socketPath string) {
+	_ = os.Remove(socketPath)
+}
+
+func removeLeftovers(socket string) {
+	_, err := net.Dial("unix", socket)
+	if err != nil {
+		_ = os.Remove(socket)
+	}
+}
+
+func newStatusHTTPClient(socketPath string) (*http.Client, error) {
+	transport := &http.Transport{
+		DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
+			var d net.Dialer
+			return d.DialContext(ctx, "unix", socketPath)
+		},
+	}
+
+	return &http.Client{Transport: transport}, nil
+}
diff --git a/pkg/component/status/transport_windows.go b/pkg/component/status/transport_windows.go
@@ -0,0 +1,50 @@
+//go:build windows
+
+// SPDX-FileCopyrightText: 2025 k0s authors
+// SPDX-License-Identifier: Apache-2.0
+
+package status
+
+import (
+	"context"
+	"net"
+	"net/http"
+	"path/filepath"
+	"strings"
+
+	"github.com/Microsoft/go-winio"
+)
+
+func newStatusListener(socketPath string) (net.Listener, error) {
+	return winio.ListenPipe(pipePath(socketPath), nil)
+}
+
+func cleanupStatusListener(string) {}
+
+func newStatusHTTPClient(socketPath string) (*http.Client, error) {
+	path := pipePath(socketPath)
+	transport := &http.Transport{
+		DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
+			return winio.DialPipeContext(ctx, path)
+		},
+	}
+	return &http.Client{Transport: transport}, nil
+}
+
+func pipePath(socketPath string) string {
+	if strings.HasPrefix(socketPath, `\\.\pipe\`) || strings.HasPrefix(socketPath, `//./pipe/`) {
+		return socketPath
+	}
+
+	cleaned := filepath.Clean(socketPath)
+	cleaned = strings.ReplaceAll(cleaned, "\\", "/")
+	cleaned = strings.TrimPrefix(cleaned, "/")
+	cleaned = strings.ReplaceAll(cleaned, "/", "-")
+	cleaned = strings.ReplaceAll(cleaned, ":", "")
+
+	if cleaned == "" || cleaned == "." {
+		cleaned = "k0s-status"
+	}
+
+	return `\\.\pipe\` + cleaned
+}
diff --git a/pkg/config/cfgvars.go b/pkg/config/cfgvars.go
diff --git a/pkg/constant/constant_unix.go b/pkg/constant/constant_unix.go
diff --git a/pkg/constant/constant_windows.go b/pkg/constant/constant_windows.go

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ import (`
`9`	`9`	`"github.com/k0sproject/k0s/cmd/keepalived"`
`10`	`10`	`"github.com/k0sproject/k0s/cmd/reset"`
`11`	`11`	`"github.com/k0sproject/k0s/cmd/restore"`
`12`		`- "github.com/k0sproject/k0s/cmd/status"`
`13`	`12`
`14`	`13`	`"github.com/spf13/cobra"`
`15`	`14`	`)`
`@@ -20,5 +19,4 @@ func addPlatformSpecificCommands(root *cobra.Command) {`
`20`	`19`	`root.AddCommand(keepalived.NewKeepalivedSetStateCmd()) // hidden`
`21`	`20`	`root.AddCommand(reset.NewResetCmd())`
`22`	`21`	`root.AddCommand(restore.NewRestoreCmd())`
`23`		`- root.AddCommand(status.NewStatusCmd())`
`24`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-//go:build unix`
`2`		`-`
`3`	`1`	`// SPDX-FileCopyrightText: 2021 k0s authors`
`4`	`2`	`// SPDX-License-Identifier: Apache-2.0`
`5`	`3`
Original file line number	Diff line number	Diff line change
`@@ -178,9 +178,6 @@ func (sc *setupController) createControlNode(ctx context.Context, cf apcli.Facto`
`178`	`178`	`return nil`
`179`	`179`	`}`
`180`	`180`
`181`		`-// TODO re-use from somewhere else`
`182`		`-const DefaultK0sStatusSocketPath = "/run/k0s/status.sock"`
`183`		`-`
`184`	`181`	`func getControlNodeAddresses(hostname string) ([]corev1.NodeAddress, error) {`
`185`	`182`	`addresses := []corev1.NodeAddress{}`
`186`	`183`	`apiAddress, err := getControllerAPIAddress()`
`@@ -201,7 +198,7 @@ func getControlNodeAddresses(hostname string) ([]corev1.NodeAddress, error) {`
`201`	`198`	`}`
`202`	`199`
`203`	`200`	`func getControllerAPIAddress() (string, error) {`
`204`		`- status, err := status.GetStatusInfo(DefaultK0sStatusSocketPath)`
	`201`	`+ status, err := status.GetStatusInfo(status.DefaultSocketPath)`
`205`	`202`	`if err != nil {`
`206`	`203`	`return "", err`
`207`	`204`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func RegisterControllers(ctx context.Context, logger *logrus.Entry, mgr crman.Ma`
`39`	`39`	`logger.Infof("Using effective hostname = '%v'", hostname)`
`40`	`40`
`41`	`41`	`k0sVersionHandler := func() (string, error) {`
`42`		`- return getK0sVersion(DefaultK0sStatusSocketPath)`
	`42`	`+ return getK0sVersion(status.DefaultSocketPath)`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`if err := registerSignalController(logger, mgr, signalControllerEventFilter(hostname, apsigpred.DefaultErrorHandler(logger, "k0s signal")), delegate, clusterID, k0sVersionHandler); err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,6 @@ import (`
`27`	`27`
`28`	`28`	`const (`
`29`	`29`	`SignalResponseProcessingTimeout = 1 * time.Minute`
`30`		`- DefaultK0sStatusSocketPath = "/run/k0s/status.sock"`
`31`	`30`	`)`
`32`	`31`
`33`	`32`	`type k0sVersionHandlerFunc func() (string, error)`