feat: Use the app name in the help menu output (#2396)

Use app title in command help menu output

Author: screspod

api/internal/managers/infra/install.go

@@ -33,7 +33,7 @@ const K0sComponentName = "Runtime"
 func AlreadyInstalledError() error {
 	return fmt.Errorf(
 		"\nAn installation is detected on this machine.\nTo install, you must first remove the existing installation.\nYou can do this by running the following command:\n\n  sudo ./%s reset\n",
-		runtimeconfig.BinaryName(),
+		runtimeconfig.AppSlug(),
 	)
 }
 

api/pkg/logger/logger.go

@@ -12,7 +12,7 @@ import (
 )
 
 func NewLogger() (*logrus.Logger, error) {
-	fname := fmt.Sprintf("%s-%s.api.log", runtimeconfig.BinaryName(), time.Now().Format("20060102150405.000"))
+	fname := fmt.Sprintf("%s-%s.api.log", runtimeconfig.AppSlug(), time.Now().Format("20060102150405.000"))
 	logpath := runtimeconfig.PathToLog(fname)
 	logfile, err := os.OpenFile(logpath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0400)
 	if err != nil {

cmd/installer/cli/adminconsole.go

@@ -7,16 +7,16 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func AdminConsoleCmd(ctx context.Context, name string) *cobra.Command {
+func AdminConsoleCmd(ctx context.Context, appTitle string) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "admin-console",
-		Short: fmt.Sprintf("Manage the %s Admin Console", name),
+		Short: fmt.Sprintf("Manage the %s Admin Console", appTitle),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return nil
 		},
 	}
 
-	cmd.AddCommand(AdminConsoleResetPasswordCmd(ctx, name))
+	cmd.AddCommand(AdminConsoleResetPasswordCmd(ctx, appTitle))
 
 	return cmd
 }

cmd/installer/cli/adminconsole_resetpassword.go

@@ -15,13 +15,13 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func AdminConsoleResetPasswordCmd(ctx context.Context, name string) *cobra.Command {
+func AdminConsoleResetPasswordCmd(ctx context.Context, appTitle string) *cobra.Command {
 	var rc runtimeconfig.RuntimeConfig
 
 	cmd := &cobra.Command{
 		Use:   "reset-password [password]",
 		Args:  cobra.MaximumNArgs(1),
-		Short: fmt.Sprintf("Reset the %s Admin Console password. If no password is provided, you will be prompted to enter a new one.", name),
+		Short: fmt.Sprintf("Reset the %s Admin Console password. If no password is provided, you will be prompted to enter a new one.", appTitle),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			// Skip root check if dryrun mode is enabled
 			if !dryrun.Enabled() && os.Getuid() != 0 {

cmd/installer/cli/enable_ha.go

@@ -20,12 +20,12 @@ import (
 )
 
 // EnableHACmd is the command for enabling HA mode.
-func EnableHACmd(ctx context.Context, name string) *cobra.Command {
+func EnableHACmd(ctx context.Context, appTitle string) *cobra.Command {
 	var rc runtimeconfig.RuntimeConfig
 
 	cmd := &cobra.Command{
 		Use:   "enable-ha",
-		Short: fmt.Sprintf("Enable high availability for the %s cluster", name),
+		Short: fmt.Sprintf("Enable high availability for the %s cluster", appTitle),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			// Skip root check if dryrun mode is enabled
 			if !dryrun.Enabled() && os.Getuid() != 0 {

cmd/installer/cli/install.go

@@ -100,29 +100,29 @@ type installConfig struct {
 var webAssetsFS fs.FS = nil
 
 // InstallCmd returns a cobra command for installing the embedded cluster.
-func InstallCmd(ctx context.Context, name string) *cobra.Command {
+func InstallCmd(ctx context.Context, appSlug, appTitle string) *cobra.Command {
 	var flags InstallCmdFlags
 
 	ctx, cancel := context.WithCancel(ctx)
 
 	rc := runtimeconfig.New(nil)
 	ki := kubernetesinstallation.New(nil)
 
-	short := fmt.Sprintf("Install %s", name)
+	short := fmt.Sprintf("Install %s", appTitle)
 	if os.Getenv("ENABLE_V3") == "1" {
-		short = fmt.Sprintf("Install %s onto Linux or Kubernetes", name)
+		short = fmt.Sprintf("Install %s onto Linux or Kubernetes", appTitle)
 	}
 
 	cmd := &cobra.Command{
 		Use:     "install",
 		Short:   short,
-		Example: installCmdExample(name),
+		Example: installCmdExample(appSlug),
 		PostRun: func(cmd *cobra.Command, args []string) {
 			rc.Cleanup()
 			cancel() // Cancel context when command completes
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			if err := verifyAndPrompt(ctx, name, flags, prompts.New()); err != nil {
+			if err := verifyAndPrompt(ctx, appSlug, flags, prompts.New()); err != nil {
 				return err
 			}
 			if err := preRunInstall(cmd, &flags, rc, ki); err != nil {
@@ -137,7 +137,7 @@ func InstallCmd(ctx context.Context, name string) *cobra.Command {
 			installReporter.ReportInstallationStarted(ctx)
 
 			if flags.enableManagerExperience {
-				return runManagerExperienceInstall(ctx, flags, rc, ki, installReporter)
+				return runManagerExperienceInstall(ctx, flags, rc, ki, installReporter, appTitle)
 			}
 
 			_ = rc.SetEnv()
@@ -173,7 +173,7 @@ func InstallCmd(ctx context.Context, name string) *cobra.Command {
 		panic(err)
 	}
 
-	cmd.AddCommand(InstallRunPreflightsCmd(ctx, name))
+	cmd.AddCommand(InstallRunPreflightsCmd(ctx, appSlug))
 
 	return cmd
 }
@@ -196,12 +196,12 @@ const (
 `
 )
 
-func installCmdExample(name string) string {
+func installCmdExample(appSlug string) string {
 	if os.Getenv("ENABLE_V3") != "1" {
 		return ""
 	}
 
-	return fmt.Sprintf(installCmdExampleText, name, name)
+	return fmt.Sprintf(installCmdExampleText, appSlug, appSlug)
 }
 
 func mustAddInstallFlags(cmd *cobra.Command, flags *InstallCmdFlags) {
@@ -265,7 +265,7 @@ func newLinuxInstallFlags(flags *InstallCmdFlags) *pflag.FlagSet {
 	// Use the app slug as default data directory only when ENABLE_V3 is set
 	defaultDataDir := ecv1beta1.DefaultDataDir
 	if os.Getenv("ENABLE_V3") == "1" {
-		defaultDataDir = filepath.Join("/var/lib", runtimeconfig.BinaryName())
+		defaultDataDir = filepath.Join("/var/lib", runtimeconfig.AppSlug())
 	}
 
 	flagSet.StringVar(&flags.dataDir, "data-dir", defaultDataDir, "Path to the data directory")
@@ -570,7 +570,7 @@ func cidrConfigFromCmd(cmd *cobra.Command) (*newconfig.CIDRConfig, error) {
 	return cidrCfg, nil
 }
 
-func runManagerExperienceInstall(ctx context.Context, flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig, ki kubernetesinstallation.Installation, installReporter *InstallReporter) (finalErr error) {
+func runManagerExperienceInstall(ctx context.Context, flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig, ki kubernetesinstallation.Installation, installReporter *InstallReporter, appTitle string) (finalErr error) {
 	// this is necessary because the api listens on all interfaces,
 	// and we only know the interface to use when the user selects it in the ui
 	ipAddresses, err := netutils.ListAllValidIPAddresses()
@@ -663,7 +663,7 @@ func runManagerExperienceInstall(ctx context.Context, flags InstallCmdFlags, rc
 	}
 
 	logrus.Infof("\nVisit the %s manager to continue: %s\n",
-		runtimeconfig.BinaryName(),
+		appTitle,
 		getManagerURL(flags.hostname, flags.managerPort))
 	<-ctx.Done()
 
@@ -813,9 +813,9 @@ func getAddonInstallOpts(flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig,
 	return opts, nil
 }
 
-func verifyAndPrompt(ctx context.Context, name string, flags InstallCmdFlags, prompt prompts.Prompt) error {
+func verifyAndPrompt(ctx context.Context, appSlug string, flags InstallCmdFlags, prompt prompts.Prompt) error {
 	logrus.Debugf("checking if k0s is already installed")
-	err := verifyNoInstallation(name, "reinstall")
+	err := verifyNoInstallation(appSlug, "reinstall")
 	if err != nil {
 		return err
 	}
@@ -987,7 +987,7 @@ func verifyChannelRelease(cmdName string, isAirgap bool, assumeYes bool) error {
 	return nil
 }
 
-func verifyNoInstallation(name string, cmdName string) error {
+func verifyNoInstallation(appSlug string, cmdName string) error {
 	installed, err := k0s.IsInstalled()
 	if err != nil {
 		return err
@@ -996,7 +996,7 @@ func verifyNoInstallation(name string, cmdName string) error {
 		logrus.Errorf("\nAn installation is detected on this machine.")
 		logrus.Infof("To %s, you must first remove the existing installation.", cmdName)
 		logrus.Infof("You can do this by running the following command:")
-		logrus.Infof("\n  sudo ./%s reset\n", name)
+		logrus.Infof("\n  sudo ./%s reset\n", appSlug)
 		return NewErrorNothingElseToAdd(errors.New("previous installation detected"))
 	}
 	return nil

cmd/installer/cli/install_runpreflights.go

@@ -22,7 +22,7 @@ import (
 // they contain failures. We use this to differentiate the way we provide user feedback.
 var ErrPreflightsHaveFail = metrics.NewErrorNoFail(fmt.Errorf("host preflight failures detected"))
 
-func InstallRunPreflightsCmd(ctx context.Context, name string) *cobra.Command {
+func InstallRunPreflightsCmd(ctx context.Context, appSlug string) *cobra.Command {
 	var flags InstallCmdFlags
 
 	rc := runtimeconfig.New(nil)
@@ -45,7 +45,7 @@ func InstallRunPreflightsCmd(ctx context.Context, name string) *cobra.Command {
 			rc.Cleanup()
 		},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			if err := runInstallRunPreflights(cmd.Context(), name, flags, rc); err != nil {
+			if err := runInstallRunPreflights(cmd.Context(), appSlug, flags, rc); err != nil {
 				return err
 			}
 
@@ -62,8 +62,8 @@ func InstallRunPreflightsCmd(ctx context.Context, name string) *cobra.Command {
 	return cmd
 }
 
-func runInstallRunPreflights(ctx context.Context, name string, flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig) error {
-	if err := verifyAndPrompt(ctx, name, flags, prompts.New()); err != nil {
+func runInstallRunPreflights(ctx context.Context, appSlug string, flags InstallCmdFlags, rc runtimeconfig.RuntimeConfig) error {
+	if err := verifyAndPrompt(ctx, appSlug, flags, prompts.New()); err != nil {
 		return err
 	}
 

cmd/installer/cli/join.go

@@ -50,15 +50,15 @@ type JoinCmdFlags struct {
 }
 
 // JoinCmd returns a cobra command for joining a node to the cluster.
-func JoinCmd(ctx context.Context, name string) *cobra.Command {
+func JoinCmd(ctx context.Context, appSlug, appTitle string) *cobra.Command {
 	var flags JoinCmdFlags
 
 	ctx, cancel := context.WithCancel(ctx)
 	rc := runtimeconfig.New(nil)
 
 	cmd := &cobra.Command{
 		Use:   "join <url> <token>",
-		Short: fmt.Sprintf("Join a node to the %s cluster", name),
+		Short: fmt.Sprintf("Join a node to the %s cluster", appTitle),
 		Args:  cobra.ExactArgs(2),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			if err := preRunJoin(&flags); err != nil {
@@ -87,7 +87,7 @@ func JoinCmd(ctx context.Context, name string) *cobra.Command {
 				joinReporter.ReportSignalAborted(ctx, sig)
 			})
 
-			if err := runJoin(cmd.Context(), name, flags, rc, jcmd, args[0], joinReporter); err != nil {
+			if err := runJoin(cmd.Context(), appSlug, flags, rc, jcmd, args[0], joinReporter); err != nil {
 				// Check if this is an interrupt error from the terminal
 				if errors.Is(err, terminal.InterruptErr) {
 					joinReporter.ReportSignalAborted(ctx, syscall.SIGINT)
@@ -106,8 +106,8 @@ func JoinCmd(ctx context.Context, name string) *cobra.Command {
 		panic(err)
 	}
 
-	cmd.AddCommand(JoinRunPreflightsCmd(ctx, name))
-	cmd.AddCommand(JoinPrintCommandCmd(ctx, name))
+	cmd.AddCommand(JoinRunPreflightsCmd(ctx, appSlug, appTitle))
+	cmd.AddCommand(JoinPrintCommandCmd(ctx, appTitle))
 
 	return cmd
 }
@@ -153,18 +153,18 @@ func addJoinFlags(cmd *cobra.Command, flags *JoinCmdFlags) error {
 	return nil
 }
 
-func runJoin(ctx context.Context, name string, flags JoinCmdFlags, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse, kotsAPIAddress string, joinReporter *JoinReporter) error {
+func runJoin(ctx context.Context, appSlug string, flags JoinCmdFlags, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse, kotsAPIAddress string, joinReporter *JoinReporter) error {
 	// both controller and worker nodes will have 'worker' in the join command
 	isWorker := !strings.Contains(jcmd.K0sJoinCommand, "controller")
 	if !isWorker {
 		logrus.Warn("\nDo not join another node until this node has joined successfully.")
 	}
 
-	if err := runJoinVerifyAndPrompt(name, flags, rc, jcmd); err != nil {
+	if err := runJoinVerifyAndPrompt(appSlug, flags, rc, jcmd); err != nil {
 		return err
 	}
 
-	cidrCfg, err := initializeJoin(ctx, name, rc, jcmd, kotsAPIAddress)
+	cidrCfg, err := initializeJoin(ctx, appSlug, rc, jcmd, kotsAPIAddress)
 	if err != nil {
 		return fmt.Errorf("unable to initialize join: %w", err)
 	}
@@ -180,7 +180,7 @@ func runJoin(ctx context.Context, name string, flags JoinCmdFlags, rc runtimecon
 	logrus.Debugf("installing and joining cluster")
 	loading := spinner.Start()
 	loading.Infof("Installing node")
-	if err := installAndJoinCluster(ctx, rc, jcmd, name, flags, isWorker); err != nil {
+	if err := installAndJoinCluster(ctx, rc, jcmd, appSlug, flags, isWorker); err != nil {
 		loading.ErrorClosef("Failed to install node")
 		return err
 	}
@@ -226,9 +226,9 @@ func runJoin(ctx context.Context, name string, flags JoinCmdFlags, rc runtimecon
 	return nil
 }
 
-func runJoinVerifyAndPrompt(name string, flags JoinCmdFlags, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse) error {
+func runJoinVerifyAndPrompt(appSlug string, flags JoinCmdFlags, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse) error {
 	logrus.Debugf("checking if k0s is already installed")
-	err := verifyNoInstallation(name, "join a node")
+	err := verifyNoInstallation(appSlug, "join a node")
 	if err != nil {
 		return err
 	}
@@ -284,7 +284,7 @@ func runJoinVerifyAndPrompt(name string, flags JoinCmdFlags, rc runtimeconfig.Ru
 	return nil
 }
 
-func initializeJoin(ctx context.Context, name string, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse, kotsAPIAddress string) (cidrCfg *newconfig.CIDRConfig, err error) {
+func initializeJoin(ctx context.Context, appSlug string, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse, kotsAPIAddress string) (cidrCfg *newconfig.CIDRConfig, err error) {
 	logrus.Info("")
 	spinner := spinner.Start()
 	spinner.Infof("Initializing")
@@ -306,7 +306,7 @@ func initializeJoin(ctx context.Context, name string, rc runtimeconfig.RuntimeCo
 		logrus.Debugf("unable to chmod embedded-cluster home dir: %s", err)
 	}
 
-	logrus.Debugf("materializing %s binaries", name)
+	logrus.Debugf("materializing %s binaries", appSlug)
 	if err := materializeFilesForJoin(ctx, rc, jcmd, kotsAPIAddress); err != nil {
 		return nil, fmt.Errorf("failed to materialize files: %w", err)
 	}
@@ -382,13 +382,13 @@ func getJoinCIDRConfig(rc runtimeconfig.RuntimeConfig) (*newconfig.CIDRConfig, e
 	}, nil
 }
 
-func installAndJoinCluster(ctx context.Context, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse, name string, flags JoinCmdFlags, isWorker bool) error {
+func installAndJoinCluster(ctx context.Context, rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCommandResponse, appSlug string, flags JoinCmdFlags, isWorker bool) error {
 	logrus.Debugf("saving token to disk")
 	if err := saveTokenToDisk(jcmd.K0sToken); err != nil {
 		return fmt.Errorf("unable to save token to disk: %w", err)
 	}
 
-	logrus.Debugf("installing %s binaries", name)
+	logrus.Debugf("installing %s binaries", appSlug)
 	if err := installK0sBinary(rc); err != nil {
 		return fmt.Errorf("unable to install k0s binary: %w", err)
 	}
@@ -424,7 +424,7 @@ func installAndJoinCluster(ctx context.Context, rc runtimeconfig.RuntimeConfig,
 		return fmt.Errorf("unable to join node to cluster: %w", err)
 	}
 
-	if err := startAndWaitForK0s(name); err != nil {
+	if err := startAndWaitForK0s(appSlug); err != nil {
 		return err
 	}
 
@@ -495,8 +495,8 @@ func applyNetworkConfiguration(rc runtimeconfig.RuntimeConfig, jcmd *join.JoinCo
 }
 
 // startAndWaitForK0s starts the k0s service and waits for the node to be ready.
-func startAndWaitForK0s(name string) error {
-	logrus.Debugf("starting %s service", name)
+func startAndWaitForK0s(appSlug string) error {
+	logrus.Debugf("starting %s service", appSlug)
 	if _, err := helpers.RunCommand(runtimeconfig.K0sBinaryPath, "start"); err != nil {
 		return fmt.Errorf("unable to start service: %w", err)
 	}

cmd/installer/cli/join_printcommand.go

@@ -12,12 +12,12 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func JoinPrintCommandCmd(ctx context.Context, name string) *cobra.Command {
+func JoinPrintCommandCmd(ctx context.Context, appTitle string) *cobra.Command {
 	var rc runtimeconfig.RuntimeConfig
 
 	cmd := &cobra.Command{
 		Use:   "print-command",
-		Short: fmt.Sprintf("Print controller join command for %s", name),
+		Short: fmt.Sprintf("Print controller join command for %s", appTitle),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			// Skip root check if dryrun mode is enabled
 			if !dryrun.Enabled() && os.Getuid() != 0 {