Add cluster name/region flags to the CLI (#1492)

Author: RobertLucian

cli/cmd/cluster.go

@@ -52,6 +52,8 @@ import (
 var (
 	_flagClusterEnv                string
 	_flagClusterConfig             string
+	_flagClusterName               string
+	_flagClusterRegion             string
 	_flagClusterInfoDebug          bool
 	_flagClusterDisallowPrompt     bool
 	_flagAWSAccessKeyID            string
@@ -73,6 +75,8 @@ func clusterInit() {
 
 	_infoCmd.Flags().SortFlags = false
 	addClusterConfigFlag(_infoCmd)
+	addClusterNameFlag(_infoCmd)
+	addClusterRegionFlag(_infoCmd)
 	addAWSCredentialsFlags(_infoCmd)
 	_infoCmd.Flags().StringVarP(&_flagClusterEnv, "env", "e", defaultEnv, "environment to update")
 	_infoCmd.Flags().BoolVarP(&_flagClusterInfoDebug, "debug", "d", false, "save the current cluster state to a file")
@@ -89,12 +93,16 @@ func clusterInit() {
 
 	_downCmd.Flags().SortFlags = false
 	addClusterConfigFlag(_downCmd)
+	addClusterNameFlag(_downCmd)
+	addClusterRegionFlag(_downCmd)
 	addAWSCredentialsFlags(_downCmd)
 	_downCmd.Flags().BoolVarP(&_flagClusterDisallowPrompt, "yes", "y", false, "skip prompts")
 	_clusterCmd.AddCommand(_downCmd)
 
 	_exportCmd.Flags().SortFlags = false
 	addClusterConfigFlag(_exportCmd)
+	addClusterNameFlag(_exportCmd)
+	addClusterRegionFlag(_exportCmd)
 	addAWSCredentialsFlags(_exportCmd)
 	_clusterCmd.AddCommand(_exportCmd)
 }
@@ -104,6 +112,14 @@ func addClusterConfigFlag(cmd *cobra.Command) {
 	cmd.Flags().SetAnnotation("config", cobra.BashCompFilenameExt, _configFileExts)
 }
 
+func addClusterNameFlag(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&_flagClusterName, "name", "n", "", "aws name of the cluster")
+}
+
+func addClusterRegionFlag(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&_flagClusterRegion, "region", "r", "", "aws region of the cluster")
+}
+
 func addAWSCredentialsFlags(cmd *cobra.Command) {
 	cmd.Flags().StringVar(&_flagAWSAccessKeyID, "aws-key", "", "aws access key id")
 	cmd.Flags().StringVar(&_flagAWSSecretAccessKey, "aws-secret", "", "aws secret access key")

cli/cmd/lib_cluster_config.go

@@ -89,6 +89,13 @@ func getNewClusterAccessConfig(disallowPrompt bool) (*clusterconfig.AccessConfig
 		}
 	}
 
+	if _flagClusterName != "" {
+		accessConfig.ClusterName = pointer.String(_flagClusterName)
+	}
+	if _flagClusterRegion != "" {
+		accessConfig.Region = pointer.String(_flagClusterRegion)
+	}
+
 	if accessConfig.ClusterName != nil && accessConfig.Region != nil {
 		return accessConfig, nil
 	}
@@ -118,6 +125,13 @@ func getClusterAccessConfigWithCache(disallowPrompt bool) (*clusterconfig.Access
 		}
 	}
 
+	if _flagClusterName != "" {
+		accessConfig.ClusterName = pointer.String(_flagClusterName)
+	}
+	if _flagClusterRegion != "" {
+		accessConfig.Region = pointer.String(_flagClusterRegion)
+	}
+
 	if accessConfig.ClusterName != nil && accessConfig.Region != nil {
 		return accessConfig, nil
 	}

dev/generate_cli_md.sh

@@ -37,8 +37,8 @@ commands=(
   "cluster up"
   "cluster info"
   "cluster configure"
-  "cluster export"
   "cluster down"
+  "cluster export"
   "env configure"
   "env list"
   "env default"

docs/miscellaneous/cli.md

@@ -143,6 +143,8 @@ Usage:
 
 Flags:
   -c, --config string       path to a cluster configuration file
+  -n, --name string         aws name of the cluster
+  -r, --region string       aws region of the cluster
       --aws-key string      aws access key id
       --aws-secret string   aws secret access key
   -e, --env string          environment to update (default "aws")
@@ -170,35 +172,39 @@ Flags:
   -h, --help                        help for configure
 ```
 
-### cluster export
+### cluster down
 
 ```text
-download the code and configuration for all APIs deployed in a cluster
+spin down a cluster
 
 Usage:
-  cortex cluster export [flags]
+  cortex cluster down [flags]
 
 Flags:
   -c, --config string       path to a cluster configuration file
+  -n, --name string         aws name of the cluster
+  -r, --region string       aws region of the cluster
       --aws-key string      aws access key id
       --aws-secret string   aws secret access key
-  -h, --help                help for export
+  -y, --yes                 skip prompts
+  -h, --help                help for down
 ```
 
-### cluster down
+### cluster export
 
 ```text
-spin down a cluster
+download the code and configuration for all APIs deployed in a cluster
 
 Usage:
-  cortex cluster down [flags]
+  cortex cluster export [flags]
 
 Flags:
   -c, --config string       path to a cluster configuration file
+  -n, --name string         aws name of the cluster
+  -r, --region string       aws region of the cluster
       --aws-key string      aws access key id
       --aws-secret string   aws secret access key
-  -y, --yes                 skip prompts
-  -h, --help                help for down
+  -h, --help                help for export
 ```
 
 ### env configure