✨ Extract some commands into kairosctl (#310)

This PR extracts the registration command into a `kairos-register` binary of its own. The old sub command is kept so users can see a deprecation notice and adapt for a future release when it's removed. The version number is shared between binaries. ⚠️ I'm not entirely sure about the gorelease, and would benefit from a couple of extra 👀 on this, thanks! relates to kairos-io/kairos#1211 --------- Signed-off-by: Mauro Morales <mauro.morales@spectrocloud.com> Signed-off-by: Mauro Morales <contact@mauromorales.com> Signed-off-by: Itxaka <itxaka.garcia@spectrocloud.com> Signed-off-by: GitHub <noreply@github.com> Co-authored-by: Dimitris Karakasilis <dimitris@karakasilis.me> Co-authored-by: Itxaka <itxaka.garcia@spectrocloud.com> Co-authored-by: ci-robbot [bot] <105103991+ci-robbot@users.noreply.github.com> Co-authored-by: mudler <mudler@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2025-09-03 16:09:37 +00:00 · 2023-04-21 11:04:15 +02:00
parent b6d6e39d23
commit d88983a906
9 changed files with 351 additions and 224 deletions
--- a/internal/cli/bridge.go
+++ b/internal/cli/bridge.go
@@ -17,6 +17,101 @@ import (
 	"github.com/urfave/cli/v2"
 )

+func BridgeCMD(toolName string) *cli.Command {
+	usage := "Connect to a kairos VPN network"
+	description := `
+		Starts a bridge with a kairos network or a node.
+
+		# With a network
+
+		By default, "bridge" will create a VPN network connection to the node with the token supplied, thus it requires elevated permissions in order to work.
+
+		For example:
+
+		$ sudo %s bridge --network-token <TOKEN>
+
+		Will start a VPN, which local ip is fixed to 10.1.0.254 (tweakable with --address).
+
+		The API will also be accessible at http://127.0.0.1:8080
+
+		# With a node
+
+		"%s bridge" can be used also to connect over to a node in recovery mode. When operating in this modality kairos bridge requires no specific permissions, indeed a tunnel
+		will be created locally to connect to the machine remotely.
+
+		For example:
+
+		$ %s bridge --qr-code-image /path/to/image.png
+
+		Will scan the QR code in the image and connect over. Further instructions on how to connect over will be printed out to the screen.
+
+		See also: https://kairos.io/docs/reference/recovery_mode/
+
+		`
+
+	if toolName != "kairosctl" {
+		usage += " (WARNING: this command will be deprecated in the next release, use the kairosctl binary instead)"
+		description = "\t\tWARNING: This command will be deprecated in the next release. Please use the new kairosctl binary instead.\n" + description
+	}
+
+	return &cli.Command{
+		Name:        "bridge",
+		UsageText:   fmt.Sprintf("%s %s", toolName, "bridge --network-token XXX"),
+		Usage:       usage,
+		Description: fmt.Sprintf(description, toolName, toolName, toolName),
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:     "network-token",
+				Required: false,
+				EnvVars:  []string{"NETWORK_TOKEN"},
+				Usage:    "Network token to connect over",
+			},
+			&cli.StringFlag{
+				Name:     "log-level",
+				Required: false,
+				EnvVars:  []string{"LOGLEVEL"},
+				Value:    "info",
+				Usage:    "Bridge log level",
+			},
+			&cli.BoolFlag{
+				Name:     "qr-code-snapshot",
+				Required: false,
+				Usage:    "Bool to take a local snapshot instead of reading from an image file for recovery",
+				EnvVars:  []string{"QR_CODE_SNAPSHOT"},
+			},
+			&cli.StringFlag{
+				Name:     "qr-code-image",
+				Usage:    "Path to an image containing a valid QR code for recovery mode",
+				Required: false,
+				EnvVars:  []string{"QR_CODE_IMAGE"},
+			},
+			&cli.StringFlag{
+				Name:  "api",
+				Value: "127.0.0.1:8080",
+				Usage: "Listening API url",
+			},
+			&cli.BoolFlag{
+				Name:    "dhcp",
+				EnvVars: []string{"DHCP"},
+				Usage:   "Enable DHCP",
+			},
+			&cli.StringFlag{
+				Value:   "10.1.0.254/24",
+				Name:    "address",
+				EnvVars: []string{"ADDRESS"},
+				Usage:   "Specify an address for the bridge",
+			},
+			&cli.StringFlag{
+				Value:   "/tmp/kairos",
+				Name:    "lease-dir",
+				EnvVars: []string{"lease-dir"},
+				Usage:   "DHCP Lease directory",
+			},
+		},
+		Action: bridge,
+	}
+}
+
 // bridge is just starting a VPN with edgevpn to the given network token.
 func bridge(c *cli.Context) error {
 	qrCodePath := ""