cli: minor wording tweaks

This commit is contained in:
Thomas Tendyck 2022-05-09 17:02:47 +02:00 committed by Thomas Tendyck
parent 1872d52a49
commit bbfd84729d
6 changed files with 12 additions and 12 deletions

View File

@ -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)")

View File

@ -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")

View File

@ -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
}

View File

@ -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())

View File

@ -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,
}

View File

@ -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),