From bbfd84729d0c7b443fc19ed4ba1b27aa48147c97 Mon Sep 17 00:00:00 2001 From: Thomas Tendyck Date: Mon, 9 May 2022 17:02:47 +0200 Subject: [PATCH] cli: minor wording tweaks --- cli/cmd/create.go | 4 ++-- cli/cmd/init.go | 2 +- cli/cmd/recover.go | 4 ++-- cli/cmd/root.go | 6 +++--- cli/cmd/terminate.go | 4 ++-- cli/cmd/verify.go | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/cli/cmd/create.go b/cli/cmd/create.go index dd573df6c..090fed151 100644 --- a/cli/cmd/create.go +++ b/cli/cmd/create.go @@ -29,8 +29,8 @@ func newCreateCmd() *cobra.Command { ValidArgsFunction: createCompletion, RunE: runCreate, } - cmd.Flags().String("name", "constell", "create the Constellation cluster with the specified name") - cmd.Flags().BoolP("yes", "y", false, "create the Constellation cluster without further confirmation") + cmd.Flags().String("name", "constell", "create the cluster with the specified name") + cmd.Flags().BoolP("yes", "y", false, "create the cluster without further confirmation") cmd.Flags().IntP("control-plane-nodes", "c", 1, "number of control-plane nodes (required)") must(cobra.MarkFlagRequired(cmd.Flags(), "control-plane-nodes")) cmd.Flags().IntP("worker-nodes", "w", 1, "number of worker nodes (required)") diff --git a/cli/cmd/init.go b/cli/cmd/init.go index 77c2bb0a6..6f49a885c 100644 --- a/cli/cmd/init.go +++ b/cli/cmd/init.go @@ -41,7 +41,7 @@ func newInitCmd() *cobra.Command { RunE: runInitialize, } cmd.Flags().String("privatekey", "", "path to your private key") - cmd.Flags().String("master-secret", "", "path to base64 encoded master secret") + cmd.Flags().String("master-secret", "", "path to base64-encoded master secret") cmd.Flags().Bool("wg-autoconfig", false, "enable automatic configuration of WireGuard interface") must(cmd.Flags().MarkHidden("wg-autoconfig")) cmd.Flags().Bool("autoscale", false, "enable Kubernetes cluster-autoscaler") diff --git a/cli/cmd/recover.go b/cli/cmd/recover.go index a4fa19f8a..91e3b29f2 100644 --- a/cli/cmd/recover.go +++ b/cli/cmd/recover.go @@ -24,7 +24,7 @@ var diskUUIDRegexp = regexp.MustCompile("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA func newRecoverCmd() *cobra.Command { cmd := &cobra.Command{ Use: "recover", - Short: "Recover a Constellation cluster", + Short: "Recover a completely stopped Constellation cluster", Long: "Recover a Constellation cluster by sending a recovery key to an instance in the boot stage." + "\nThis is only required if instances restart without other instances available for bootstrapping.", Args: cobra.ExactArgs(0), @@ -34,7 +34,7 @@ func newRecoverCmd() *cobra.Command { must(cmd.MarkFlagRequired("endpoint")) cmd.Flags().String("disk-uuid", "", "disk UUID of the encrypted state disk (required)") must(cmd.MarkFlagRequired("disk-uuid")) - cmd.Flags().String("master-secret", constants.MasterSecretFilename, "path to base64 encoded master secret") + cmd.Flags().String("master-secret", constants.MasterSecretFilename, "path to base64-encoded master secret") return cmd } diff --git a/cli/cmd/root.go b/cli/cmd/root.go index 93c093882..549b45293 100644 --- a/cli/cmd/root.go +++ b/cli/cmd/root.go @@ -11,8 +11,8 @@ import ( var rootCmd = &cobra.Command{ Use: "constellation", - Short: "Set up your Constellation cluster", - Long: "Set up your Constellation cluster.", + Short: "Manage your Constellation cluster", + Long: "Manage your Constellation cluster.", SilenceUsage: true, } @@ -54,7 +54,7 @@ func init() { cobra.EnableCommandSorting = false // Set output of cmd.Print to stdout. (By default, it's stderr.) rootCmd.SetOut(os.Stdout) - rootCmd.PersistentFlags().String("dev-config", "", "create the Constellation cluster using settings from a development config") + rootCmd.PersistentFlags().String("dev-config", "", "use settings from a development config") must(rootCmd.MarkPersistentFlagFilename("dev-config", "json")) rootCmd.AddCommand(newCreateCmd()) rootCmd.AddCommand(newInitCmd()) diff --git a/cli/cmd/terminate.go b/cli/cmd/terminate.go index 4395bcb1d..d0398d3c9 100644 --- a/cli/cmd/terminate.go +++ b/cli/cmd/terminate.go @@ -18,8 +18,8 @@ import ( func newTerminateCmd() *cobra.Command { cmd := &cobra.Command{ Use: "terminate", - Short: "Terminate an existing Constellation cluster", - Long: "Terminate an existing Constellation cluster. The cluster can't be started again, and all persistent storage will be lost.", + Short: "Terminate a Constellation cluster", + Long: "Terminate a Constellation cluster. The cluster can't be started again, and all persistent storage will be lost.", Args: cobra.NoArgs, RunE: runTerminate, } diff --git a/cli/cmd/verify.go b/cli/cmd/verify.go index 4dce3fcaa..ddad6be72 100644 --- a/cli/cmd/verify.go +++ b/cli/cmd/verify.go @@ -19,8 +19,8 @@ import ( func newVerifyCmd() *cobra.Command { cmd := &cobra.Command{ Use: "verify {aws|azure|gcp}", - Short: "Verify the confidential properties of your Constellation cluster", - Long: "Verify the confidential properties of your Constellation cluster.", + Short: "Verify the confidential properties of a Constellation cluster", + Long: "Verify the confidential properties of a Constellation cluster.", Args: cobra.MatchAll( cobra.ExactArgs(1), isCloudProvider(0),