feat: Longhorn toolbox CLI

Dockerfile.dapper

@@ -5,7 +5,7 @@ ENV ARCH=${DAPPER_HOST_ARCH}
 
 ENV DAPPER_RUN_ARGS --privileged
 ENV DAPPER_ENV REPO TAG DRONE_TAG
-ENV DAPPER_SOURCE /longhorn-preflight
+ENV DAPPER_SOURCE /cli
 ENV DAPPER_OUTPUT ./bin ./spdk coverage.out
 ENV DAPPER_DOCKER_SOCKET true
 

README.md

@@ -1,44 +1,43 @@
-# Longhorn Preflight
+# Longhorn Commandline Interface (longhornctl)
 
-`longhorn-preflight` helps install, configure and check the prerequisites for Longhorn system.
+This repository contains the source code for `longhornctl`, a CLI (command-line interface) designed to simplify Longhorn manual operations.
 
-## Install
+## What Can You Do With `longhornctl`?
 
-### Deploy
+- Install and verify prelight requirements.
+- Execute one-time Longhorn operations.
+- Gain inside into your Longhorn system.
 
-Users can create `longhorn-preflight` DaemonSet for installing and configuring the prerequisites and the environment.
+## Install `longhornctl`
 
-```
-# kubectl -f deploy/install.yaml
-```
+### Run From Container Image
 
-### Tweak the Options
+`To be updated`
 
-#### General Options
+### Using curl
 
-- `UPDATE_PACKAGE_LIST`: Update package list before install required packages.
+`To be updated`
 
-#### SPDK Specific Options
+### Build From Source
 
-- `ENABLE_SPDK`: Enable installation of required packages, modules and setup.
-- `HUGEMEM`: Hugepage size in MiB for SPDK.
-- `PCI_ALLOWED`: Whitespace separated list of PCI devices. By default, block all PCI devices use a non-valid address.
-- `DRIVER_OVERRIDE`: Bind devices to the given user space driver.
+1. Clone repository
+    ```bash
+    git clone https://github.com/longhorn/cli.git
+    ```
+1. Build the `longhornctl` binary
+    ```bash
+    cd cli
+    make
+    ```
+    > **Note:** This process will generate two binaries:
+    >   - `longhornctl`: A command-line interface for remote Longhorn operations, designed to be run outside the Kubernetes cluster. It executes `longhornctl-local` for operations within the cluster.
+    >   - `longhornctl-local`: A command-line interface to be used within a DaemonSet pod inside the Kubernetes cluster, handling in-cluster and host operations.
+1. After the build process completes, find the `longhornctl` binary in the `./bin` directory.
 
-## Check
+## Getting Started
 
-### Deploy
+To begin, run `longhornctl --help` to access a list of available commands and options.
 
-Users can create `longhorn-preflight` DaemonSet for checking the prerequisites and the environment.
+### Command Reference
 
-```
-# kubectl -f deploy/check.yaml
-```
-
-### Tweak the Options
-
-#### SPDK Specific Options
-
-- `ENABLE_SPDK`: Enable installation of required packages, modules and setup.
-- `HUGEMEM`: Hugepage size in MiB for SPDK.
-- `UIO_DRIVER`: Userspace IO driver.
+`To be updated`

cmd/local/longhornctl-local.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"os"
+
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	"k8s.io/kubectl/pkg/util/templates"
+
+	localsubcmd "github.com/longhorn/cli/cmd/local/subcmd"
+	remotesubcmd "github.com/longhorn/cli/cmd/remote/subcmd"
+	"github.com/longhorn/cli/pkg/consts"
+	"github.com/longhorn/cli/pkg/types"
+	"github.com/longhorn/cli/pkg/utils"
+)
+
+func main() {
+	if err := newCmdLonghornctlLocal().Execute(); err != nil {
+		logrus.WithError(err).Fatal("Failed to execute command")
+		os.Exit(1)
+	}
+}
+
+func newCmdLonghornctlLocal() *cobra.Command {
+	globalOpts := &types.GlobalCmdOptions{}
+
+	cmd := &cobra.Command{
+		Use:   consts.CmdLonghornctlLocal,
+		Short: "Longhorn commandline interface.",
+		Long:  "CLI (local) for troubleshooting and operations to be used in the Kubernetes cluster.",
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			err := utils.SetLog(globalOpts.LogLevel)
+			if err != nil {
+				logrus.WithError(err).Warn("Failed to set log level")
+			}
+		},
+	}
+
+	cmd.CompletionOptions.HiddenDefaultCmd = true
+
+	cmd.PersistentFlags().StringVarP(&globalOpts.LogLevel, consts.CmdOptLogLevel, "l", "info", "log level (trace, debug, info, warn, error, fatal, panic)")
+
+	groups := templates.CommandGroups{
+		{
+			Message: "Install And Uninstall Commands:",
+			Commands: []*cobra.Command{
+				localsubcmd.NewCmdInstall(globalOpts),
+			},
+		},
+		{
+			Message: "Operation Commands:",
+			Commands: []*cobra.Command{
+				localsubcmd.NewCmdTrim(globalOpts),
+			},
+		},
+		{
+			Message: "Troubleshoot Commands:",
+			Commands: []*cobra.Command{
+				localsubcmd.NewCmdCheck(globalOpts),
+				localsubcmd.NewCmdGet(globalOpts),
+			},
+		},
+	}
+	groups.Add(cmd)
+
+	cmd.AddCommand(remotesubcmd.NewCmdGlobalOptions())
+
+	filters := []string{"options"}
+	templates.ActsAsRootCommand(cmd, filters, groups...)
+
+	return cmd
+}

cmd/local/subcmd/check.go

@@ -0,0 +1,71 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	"github.com/longhorn/cli/pkg/consts"
+	local "github.com/longhorn/cli/pkg/local/preflight"
+	"github.com/longhorn/cli/pkg/types"
+	"github.com/longhorn/cli/pkg/utils"
+)
+
+func NewCmdCheck(globalOpts *types.GlobalCmdOptions) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   consts.SubCmdCheck,
+		Short: "Longhorn checking operations",
+	}
+
+	utils.SetGlobalOptionsLocal(cmd, globalOpts)
+
+	cmd.AddCommand(newCmdCheckPreflight(globalOpts))
+
+	return cmd
+}
+
+func newCmdCheckPreflight(globalOpts *types.GlobalCmdOptions) *cobra.Command {
+	var localChecker = local.Checker{}
+
+	cmd := &cobra.Command{
+		Use:   consts.SubCmdPreflight,
+		Short: "Check preflight environment",
+		Long: `This command verifies your Kubernetes cluster environment. It performs a series of checks to ensure your cluster meets the requirements for Longhorn to function properly.
+These checks can help to identify issues that might prevent Longhorn from functioning properly.`,
+
+		PreRun: func(cmd *cobra.Command, args []string) {
+			localChecker.LogLevel = globalOpts.LogLevel
+
+			if err := localChecker.Init(); err != nil {
+				utils.CheckErr(errors.Wrap(err, "Failed to initialize preflight checker"))
+			}
+		},
+
+		Run: func(cmd *cobra.Command, args []string) {
+			if err := localChecker.Run(); err != nil {
+				utils.CheckErr(errors.Wrap(err, "Failed to run preflight checker"))
+			}
+
+			logrus.Info("Successfully checked preflight environment")
+		},
+
+		PostRun: func(cmd *cobra.Command, args []string) {
+			if err := localChecker.Output(); err != nil {
+				utils.CheckErr(errors.Wrap(err, "Failed to output preflight checker collection"))
+			}
+
+			logrus.Info("Successfully output preflight checker collection")
+		},
+	}
+
+	utils.SetGlobalOptionsLocal(cmd, globalOpts)
+
+	cmd.Flags().StringVarP(&localChecker.OutputFilePath, consts.CmdOptOutputFile, "o", os.Getenv(consts.EnvOutputFilePath), "Output the result to a file, default to stdout.")
+	cmd.Flags().BoolVar(&localChecker.EnableSpdk, consts.CmdOptEnableSpdk, utils.ConvertStringToTypeOrDefault(os.Getenv(consts.EnvEnableSpdk), false), "Enable checking of SPDK required packages, modules, and setup.")
+	cmd.Flags().IntVar(&localChecker.HugePageSize, consts.CmdOptHugePageSize, utils.ConvertStringToTypeOrDefault(os.Getenv(consts.EnvHugePageSize), 1024), "Specify the huge page size in MiB for SPDK.")
+	cmd.Flags().StringVar(&localChecker.UioDriver, consts.CmdOptUioDriver, os.Getenv(consts.EnvUioDriver), "User space I/O driver for SPDK.")
+
+	return cmd
+}