Set default environment name to the cluster name (#2164)

Author: deliahu

.circleci/config.yml

@@ -56,14 +56,14 @@ commands:
     steps:
       - run:
           name: Create Cluster
-          command: cortex cluster up << parameters.config >> --configure-env aws -y
+          command: cortex cluster up << parameters.config >> --configure-env cortex -y
       - run:
           name: Run E2E Tests
           no_output_timeout: 30m
           command: |
-            pytest -v test/e2e/tests --env aws --skip-autoscaling --skip-load --skip-long-running
-            pytest -v test/e2e/tests --env aws -k test_autoscaling
-            pytest -v test/e2e/tests --env aws -k test_load
+            pytest -v test/e2e/tests --env cortex --skip-autoscaling --skip-load --skip-long-running
+            pytest -v test/e2e/tests --env cortex -k test_autoscaling
+            pytest -v test/e2e/tests --env cortex -k test_load
       - run:
           name: Delete Cluster
           command: cortex cluster down --config << parameters.config >> -y

cli/cmd/cluster.go

@@ -74,7 +74,7 @@ var _eksctlPrefixRegex = regexp.MustCompile(`^.*[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]
 
 func clusterInit() {
 	_clusterUpCmd.Flags().SortFlags = false
-	_clusterUpCmd.Flags().StringVarP(&_flagClusterUpEnv, "configure-env", "e", "aws", "name of environment to configure")
+	_clusterUpCmd.Flags().StringVarP(&_flagClusterUpEnv, "configure-env", "e", "", "name of environment to configure (default: the name of your cluster)")
 	_clusterUpCmd.Flags().BoolVarP(&_flagClusterDisallowPrompt, "yes", "y", false, "skip prompts")
 	_clusterCmd.AddCommand(_clusterUpCmd)
 
@@ -144,26 +144,31 @@ var _clusterUpCmd = &cobra.Command{
 
 		clusterConfigFile := args[0]
 
-		envExists, err := isEnvConfigured(_flagClusterUpEnv)
-		if err != nil {
+		if _, err := docker.GetDockerClient(); err != nil {
 			exit.Error(err)
 		}
-		if envExists {
-			if _flagClusterDisallowPrompt {
-				fmt.Printf("found an existing environment named \"%s\", which will be overwritten to connect to this cluster once it's created\n\n", _flagClusterUpEnv)
-			} else {
-				prompt.YesOrExit(fmt.Sprintf("found an existing environment named \"%s\"; would you like to overwrite it to connect to this cluster once it's created?", _flagClusterUpEnv), "", "you can specify a different environment name to be configured to connect to this cluster by specifying the --configure-env flag (e.g. `cortex cluster up --configure-env prod`); or you can list your environments with `cortex env list` and delete an environment with `cortex env delete ENV_NAME`")
-			}
-		}
 
-		if _, err := docker.GetDockerClient(); err != nil {
+		accessConfig, err := getNewClusterAccessConfig(clusterConfigFile)
+		if err != nil {
 			exit.Error(err)
 		}
 
-		accessConfig, err := getNewClusterAccessConfig(clusterConfigFile)
+		envName := _flagClusterUpEnv
+		if envName == "" {
+			envName = accessConfig.ClusterName
+		}
+
+		envExists, err := isEnvConfigured(envName)
 		if err != nil {
 			exit.Error(err)
 		}
+		if envExists {
+			if _flagClusterDisallowPrompt {
+				fmt.Printf("found an existing environment named \"%s\", which will be overwritten to connect to this cluster once it's created\n\n", envName)
+			} else {
+				prompt.YesOrExit(fmt.Sprintf("found an existing environment named \"%s\"; would you like to overwrite it to connect to this cluster once it's created?", envName), "", "you can specify a different environment name to be configured to connect to this cluster by specifying the --configure-env flag (e.g. `cortex cluster up --configure-env prod`); or you can list your environments with `cortex env list` and delete an environment with `cortex env delete ENV_NAME`")
+			}
+		}
 
 		awsClient, err := newAWSClient(accessConfig.Region, true)
 		if err != nil {
@@ -290,23 +295,23 @@ var _clusterUpCmd = &cobra.Command{
 
 		loadBalancer, err := getLoadBalancer(clusterConfig.ClusterName, OperatorLoadBalancer, awsClient)
 		if err != nil {
-			exit.Error(errors.Append(err, fmt.Sprintf("\n\nyou can attempt to resolve this issue and configure your cli environment by running `cortex cluster info --configure-env %s`", _flagClusterUpEnv)))
+			exit.Error(errors.Append(err, fmt.Sprintf("\n\nyou can attempt to resolve this issue and configure your cli environment by running `cortex cluster info --configure-env %s`", envName)))
 		}
 
 		newEnvironment := cliconfig.Environment{
-			Name:             _flagClusterUpEnv,
+			Name:             envName,
 			OperatorEndpoint: "https://" + *loadBalancer.DNSName,
 		}
 
 		err = addEnvToCLIConfig(newEnvironment, true)
 		if err != nil {
-			exit.Error(errors.Append(err, fmt.Sprintf("\n\nyou can attempt to resolve this issue and configure your cli environment by running `cortex cluster info --configure-env %s`", _flagClusterUpEnv)))
+			exit.Error(errors.Append(err, fmt.Sprintf("\n\nyou can attempt to resolve this issue and configure your cli environment by running `cortex cluster info --configure-env %s`", envName)))
 		}
 
 		if envExists {
-			fmt.Printf(console.Bold("\nthe environment named \"%s\" has been updated to point to this cluster (and was set as the default environment)\n"), _flagClusterUpEnv)
+			fmt.Printf(console.Bold("\nthe environment named \"%s\" has been updated to point to this cluster (and was set as the default environment)\n"), envName)
 		} else {
-			fmt.Printf(console.Bold("\nan environment named \"%s\" has been configured to point to this cluster (and was set as the default environment)\n"), _flagClusterUpEnv)
+			fmt.Printf(console.Bold("\nan environment named \"%s\" has been configured to point to this cluster (and was set as the default environment)\n"), envName)
 		}
 	},
 }

cli/cmd/errors.go

@@ -50,7 +50,6 @@ const (
 	ErrCortexYAMLNotFound                  = "cli.cortex_yaml_not_found"
 	ErrDockerCtrlC                         = "cli.docker_ctrl_c"
 	ErrResponseUnknown                     = "cli.response_unknown"
-	ErrOnlyAWSClusterFlagSet               = "cli.only_aws_cluster_flag_set"
 	ErrMissingAWSCredentials               = "cli.missing_aws_credentials"
 	ErrCredentialsInClusterConfig          = "cli.credentials_in_cluster_config"
 	ErrClusterUp                           = "cli.cluster_up"

docs/clients/cli.md

@@ -113,7 +113,7 @@ Usage:
   cortex cluster up CLUSTER_CONFIG_FILE [flags]
 
 Flags:
-  -e, --configure-env string   name of environment to configure (default "aws")
+  -e, --configure-env string   name of environment to configure (default: the name of your cluster)
   -y, --yes                    skip prompts
   -h, --help                   help for up
 ```

docs/clusters/management/environments.md

@@ -1,6 +1,6 @@
 # Environments
 
-When you create a cluster with `cortex cluster up`, an environment named `aws` is automatically created to point to your cluster and is configured to be the default environment. You can name the environment something else via the `--configure-env` flag, e.g. `cortex cluster up --configure-env prod`. You can also use the `--configure-env` flag with `cortex cluster info` to create / update the specified environment.
+When you create a cluster with `cortex cluster up`, an environment with the same name as your cluster is automatically created to point to your cluster and is configured to be the default environment. You can name the environment something else via the `--configure-env` flag, e.g. `cortex cluster up --configure-env prod`. You can also use the `--configure-env` flag with `cortex cluster info` to create / update the specified environment.
 
 You can list your environments with `cortex env list`, change the default environment with `cortex env default`, delete an environment with `cortex env delete`, and create/update an environment with `cortex env configure`.
 

docs/workloads/batch/example.md

@@ -93,7 +93,7 @@ cortex get image-classifier
 import cortex
 import requests
 
-cx = cortex.client("aws")
+cx = cortex.client("cortex")
 batch_endpoint = cx.get_api("image-classifier")["endpoint"]
 
 dest_s3_dir = # specify S3 directory for the results, e.g. "s3://my-bucket/dir" (make sure your cluster has access to this bucket)

docs/workloads/dependencies/example.md

@@ -40,7 +40,7 @@ api_spec = {
     }
 }
 
-cx = cortex.client("aws")
+cx = cortex.client("cortex")
 cx.deploy(api_spec, project_dir=".")
 ```
 

docs/workloads/realtime/metrics.md

@@ -6,10 +6,10 @@ response code counts (summed over the past 2 weeks) for your APIs:
 ```bash
 cortex get
 
-env   api                         status   up-to-date   requested   last update   avg request   2XX
-aws   iris-classifier             live     1            1           17m           24ms          1223
-aws   text-generator              live     1            1           8m            180ms         433
-aws   image-classifier-resnet50   live     2            2           1h            32ms          1121126
+env      api                         status   up-to-date   requested   last update   avg request   2XX
+cortex   iris-classifier             live     1            1           17m           24ms          1223
+cortex   text-generator              live     1            1           8m            180ms         433
+cortex   image-classifier-resnet50   live     2            2           1h            32ms          1121126
 ```
 
 The `cortex get API_NAME` command also provides a link to a Grafana dashboard:

docs/workloads/realtime/multi-model/example.md

@@ -32,7 +32,7 @@ requirements = ["tensorflow", "transformers", "wget", "fasttext"]
 
 api_spec = {"name": "multi-model", "kind": "RealtimeAPI"}
 
-cx = cortex.client("aws")
+cx = cortex.client("cortex")
 cx.deploy_realtime_api(api_spec, handler=Handler, requirements=requirements)
 ```
 

docs/workloads/realtime/traffic-splitter/example.md

@@ -33,7 +33,7 @@ api_spec_gpu = {
     },
 }
 
-cx = cortex.client("aws")
+cx = cortex.client("cortex")
 cx.deploy_realtime_api(api_spec_cpu, handler=Handler, requirements=requirements)
 cx.deploy_realtime_api(api_spec_gpu, handler=Handler, requirements=requirements)
 ```