feat: adding --no-prompt flag (#25)

with --no-prompt flag user can control if the installer should or not
ask for confirmations. this is useful for when we start deploying this
as part of the compatibility matrix.

Author: ricardomaraschini

cmd/helmvm/install.go

@@ -147,41 +147,55 @@ func copyUserProvidedConfig(c *cli.Context) error {
 	return nil
 }
 
+// overwriteExistingConfig asks user if they want to overwrite the existing cluster
+// configuration file.
+func overwriteExistingConfig() (bool, error) {
+	var useCurrent = &survey.Confirm{
+		Message: "Do you want to use the existing configuration ?",
+		Default: true,
+	}
+	logrus.Warn("A cluster configuration file was found. This means you already")
+	logrus.Warn("have created a cluster configured. You can either use the existing")
+	logrus.Warn("configuration or create a new one (the original configuration will")
+	logrus.Warn("be backed up).")
+	var answer bool
+	if err := survey.AskOne(useCurrent, &answer); err != nil {
+		return false, err
+	}
+	return answer, nil
+}
+
 // ensureK0sctlConfig ensures that a k0sctl.yaml file exists in the configuration
 // directory. If none exists then this directs the user to a wizard to create one.
-func ensureK0sctlConfig(c *cli.Context, nodes []infra.Node) error {
+func ensureK0sctlConfig(c *cli.Context, nodes []infra.Node, prompt bool) error {
+	multi := c.Bool("multi-node") || len(nodes) > 0
+	if !multi && runtime.GOOS != "linux" {
+		return fmt.Errorf("single node clusters only supported on linux")
+	}
 	bundledir := c.String("bundle-dir")
 	bundledir = strings.TrimRight(bundledir, "/")
-	multi := c.Bool("multi-node") || len(nodes) > 0
 	cfgpath := defaults.PathToConfig("k0sctl.yaml")
 	if usercfg := c.String("config"); usercfg != "" {
 		logrus.Infof("Using %s config file", usercfg)
 		return copyUserProvidedConfig(c)
 	}
-	var useCurrent = &survey.Confirm{
-		Message: "Do you want to use the existing configuration ?",
-		Default: true,
-	}
 	if _, err := os.Stat(cfgpath); err == nil {
-		var answer bool
-		logrus.Warn("A cluster configuration file was found. This means you already")
-		logrus.Warn("have created a cluster configured. You can either use the existing")
-		logrus.Warn("configuration or create a new one (the original configuration will")
-		logrus.Warn("be backed up).")
-		if err := survey.AskOne(useCurrent, &answer); err != nil {
-			return fmt.Errorf("unable to process answers: %w", err)
-		} else if answer {
-			return updateConfigBundle(c.Context, bundledir)
+		if len(nodes) == 0 {
+			if !prompt {
+				return updateConfigBundle(c.Context, bundledir)
+			}
+			if over, err := overwriteExistingConfig(); err != nil {
+				return fmt.Errorf("unable to process answers: %w", err)
+			} else if !over {
+				return updateConfigBundle(c.Context, bundledir)
+			}
 		}
 		if err := createK0sctlConfigBackup(c.Context); err != nil {
 			return fmt.Errorf("unable to create config backup: %w", err)
 		}
 	} else if !os.IsNotExist(err) {
 		return fmt.Errorf("unable to open config: %w", err)
 	}
-	if !multi && runtime.GOOS != "linux" {
-		return fmt.Errorf("single node clusters only supported on linux")
-	}
 	cfg, err := config.RenderClusterConfig(c.Context, nodes, multi)
 	if err != nil {
 		return fmt.Errorf("unable to render config: %w", err)
@@ -258,9 +272,9 @@ func dumpApplyLogs() {
 
 // applyK0sctl runs the k0sctl apply command and waits for it to finish. If
 // no configuration is found one is generated.
-func applyK0sctl(c *cli.Context, nodes []infra.Node) error {
+func applyK0sctl(c *cli.Context, prompt bool, nodes []infra.Node) error {
 	logrus.Infof("Processing cluster configuration")
-	if err := ensureK0sctlConfig(c, nodes); err != nil {
+	if err := ensureK0sctlConfig(c, nodes, prompt); err != nil {
 		return fmt.Errorf("unable to create config file: %w", err)
 	}
 	logrus.Infof("Applying cluster configuration")
@@ -313,6 +327,11 @@ var installCommand = &cli.Command{
 			Usage: "Only apply addons. Skips cluster install",
 			Value: false,
 		},
+		&cli.BoolFlag{
+			Name:  "no-prompt",
+			Usage: "Do not prompt user when it is not necessary",
+			Value: false,
+		},
 	},
 	Action: func(c *cli.Context) error {
 		if defaults.DecentralizedInstall() {
@@ -321,6 +340,7 @@ var installCommand = &cli.Command{
 			logrus.Warnf("Run '%s node --help' for more information.", defaults.BinaryName())
 			return fmt.Errorf("decentralized install detected")
 		}
+		prompt := !c.Bool("no-prompt")
 		logrus.Infof("Materializing binaries")
 		if err := goods.Materialize(); err != nil {
 			return fmt.Errorf("unable to materialize binaries: %w", err)
@@ -330,11 +350,11 @@ var installCommand = &cli.Command{
 			var nodes []infra.Node
 			if dir := c.String("infra"); dir != "" {
 				logrus.Infof("Processing infrastructure manifests")
-				if nodes, err = infra.Apply(c.Context, dir); err != nil {
+				if nodes, err = infra.Apply(c.Context, dir, prompt); err != nil {
 					return fmt.Errorf("unable to create infra: %w", err)
 				}
 			}
-			if err := applyK0sctl(c, nodes); err != nil {
+			if err := applyK0sctl(c, prompt, nodes); err != nil {
 				return fmt.Errorf("unable update cluster: %w", err)
 			}
 		}
@@ -346,7 +366,7 @@ var installCommand = &cli.Command{
 		ccfg := defaults.PathToConfig("k0sctl.yaml")
 		kcfg := defaults.PathToConfig("kubeconfig")
 		os.Setenv("KUBECONFIG", kcfg)
-		if applier, err := addons.NewApplier(); err != nil {
+		if applier, err := addons.NewApplier(prompt); err != nil {
 			return fmt.Errorf("unable to create applier: %w", err)
 		} else if err := applier.Apply(c.Context); err != nil {
 			return fmt.Errorf("unable to apply addons: %w", err)

cmd/helmvm/upgrade.go

@@ -45,6 +45,13 @@ func canRunUpgrade(c *cli.Context) error {
 var upgradeCommand = &cli.Command{
 	Name:  "upgrade",
 	Usage: "Upgrade the local node",
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "no-prompt",
+			Usage: "Do not prompt user when it is not necessary",
+			Value: false,
+		},
+	},
 	Action: func(c *cli.Context) error {
 		if err := canRunUpgrade(c); err != nil {
 			return err
@@ -74,7 +81,7 @@ var upgradeCommand = &cli.Command{
 		}
 		os.Setenv("KUBECONFIG", kcfg)
 		logrus.Infof("Upgrading addons")
-		if applier, err := addons.NewApplier(); err != nil {
+		if applier, err := addons.NewApplier(c.Bool("no-prompt")); err != nil {
 			return fmt.Errorf("unable to create applier: %w", err)
 		} else if err := applier.Apply(c.Context); err != nil {
 			return fmt.Errorf("unable to apply addons: %w", err)

pkg/addons/adminconsole/adminconsole.go

@@ -36,9 +36,14 @@ type AdminConsole struct {
 	config    *action.Configuration
 	logger    action.DebugLog
 	namespace string
+	prompt    bool
 }
 
 func (a *AdminConsole) askPassword() (string, error) {
+	if !a.prompt {
+		logrus.Warnf("Admin Console password set to: password")
+		return "password", nil
+	}
 	question := &survey.Password{Message: "Enter a new Admin Console password:"}
 	var pass string
 	for pass == "" {
@@ -155,12 +160,17 @@ func (a *AdminConsole) installedRelease(ctx context.Context) (*release.Release,
 	return releases[0], nil
 }
 
-func New(namespace string, logger action.DebugLog) (*AdminConsole, error) {
+func New(namespace string, prompt bool, logger action.DebugLog) (*AdminConsole, error) {
 	env := cli.New()
 	env.SetNamespace(namespace)
 	config := &action.Configuration{}
 	if err := config.Init(env.RESTClientGetter(), namespace, "", logger); err != nil {
 		return nil, fmt.Errorf("unable to init configuration: %w", err)
 	}
-	return &AdminConsole{namespace: namespace, config: config, logger: logger}, nil
+	return &AdminConsole{
+		namespace: namespace,
+		config:    config,
+		logger:    logger,
+		prompt:    prompt,
+	}, nil
 }

pkg/addons/applier.go

@@ -77,7 +77,7 @@ func (a *Applier) waitForKubernetes(ctx context.Context) error {
 }
 
 // NewApplier creates a new Applier instance with all addons registered.
-func NewApplier() (*Applier, error) {
+func NewApplier(prompt bool) (*Applier, error) {
 	k8slogger := zap.New(func(o *zap.Options) {
 		o.DestWriter = io.Discard
 	})
@@ -101,7 +101,7 @@ func NewApplier() (*Applier, error) {
 	}
 	applier.addons["openebs"] = obs
 	logger = logrus.WithField("addon", "adminconsole")
-	aconsole, err := adminconsole.New("helmvm", logger.Infof)
+	aconsole, err := adminconsole.New("helmvm", prompt, logger.Infof)
 	if err != nil {
 		return nil, fmt.Errorf("unable to create admin console addon: %w", err)
 	}

pkg/infra/infra.go

@@ -29,7 +29,7 @@ type Node struct {
 
 // Apply uses "terraform apply" to apply the infrastructe defined in the
 // directory passed as argument.
-func Apply(ctx context.Context, dir string) ([]Node, error) {
+func Apply(ctx context.Context, dir string, prompt bool) ([]Node, error) {
 	log, end := pb.Start()
 	outputs, err := runApply(ctx, dir, log)
 	if err != nil {
@@ -45,10 +45,13 @@ func Apply(ctx context.Context, dir string) ([]Node, error) {
 		return nil, fmt.Errorf("unable to process terraform output: %w", err)
 	}
 	printNodes(nodes)
+	if !prompt {
+		return nodes, nil
+	}
 	logrus.Info("You may want to take note of the output for later use")
-	prompt := &survey.Input{Message: "Press enter to proceed"}
+	question := &survey.Input{Message: "Press enter to proceed"}
 	var ignore string
-	if err := survey.AskOne(prompt, &ignore); err != nil {
+	if err := survey.AskOne(question, &ignore); err != nil {
 		return nil, fmt.Errorf("unable to ask for enter: %w", err)
 	}
 	return nodes, nil