cmd: rephrase deployment create flag, error and help text (#278)

In order to improve UX, this PR substitutes the word "idempotency token" for "request ID". The help text is also slightly changed to make it more understandable.

Author: karencfv

cmd/deployment/create.go

@@ -137,9 +137,9 @@ var createCmd = &cobra.Command{
 		res, err := deployment.Create(createParams)
 		if err != nil {
 			fmt.Fprintln(os.Stderr,
-				"The deployment creation returned with an error, please use the displayed idempotency token to recreate the deployment resources",
+				"The deployment creation returned with an error. Use the displayed request ID to recreate the deployment resources",
 			)
-			fmt.Fprintln(os.Stderr, "Idempotency token:", reqID)
+			fmt.Fprintln(os.Stderr, "Request ID:", reqID)
 			return err
 		}
 
@@ -162,7 +162,7 @@ func init() {
 	createCmd.Flags().String("name", "", "Optional name for the deployment")
 	createCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
 	createCmd.Flags().Bool("generate-payload", false, "Returns the deployment payload without actually creating the deployment resources")
-	createCmd.Flags().String("request-id", "", "Optional idempotency token - Can be found in the Stderr device when a previous deployment creation failed, for more information see the examples in the help command page")
+	createCmd.Flags().String("request-id", "", "Optional request ID - Can be found in the Stderr device when a previous deployment creation failed. For more information see the examples in the help command page")
 
 	createCmd.Flags().String("es-ref-id", "main-elasticsearch", "Optional RefId for the Elasticsearch deployment")
 	createCmd.Flags().Int32("es-zones", 1, "Number of zones the Elasticsearch instances will span")

cmd/deployment/create_help.go

@@ -68,12 +68,7 @@ $ ecctl deployment create --name my-deployment --size 1024 --track --generate-pa
 ## Create a deployment through the file definition.
 $ ecctl deployment create --file create_example.json --track
 
-## To retry a when the previous deployment creation failed:
-$ ecctl deployment create
-The deployment creation returned with an error, please use the displayed idempotency token
-to recreate the deployment resources
-Idempotency token: GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
-unknown error (status 500)
+## To retry a deployment when the previous deployment creation failed, use the request ID provided in the error response of the previous command:
 $ ecctl deployment create --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb`
 
 	// Remove temporary constants when reads for deployment templates are available on ESS
@@ -89,11 +84,6 @@ $ deployment create --file create_example.json --track
 Deployment [b6ecbea3d5c84124b7dca457f2892086] - [Elasticsearch][b6ecbea3d5c84124b7dca457f2892086]: finished running all the plan steps (Total plan duration: 5m11.s)
 Deployment [91c4d60acb804ba0a27651fac02780ec] - [Kibana][8a9d9916cd6e46a7bb0912211d76e2af]: finished running all the plan steps (Total plan duration: 4m29.58s)
 
-## To retry a when the previous deployment creation failed:
-$ ecctl deployment create --file create_example.json
-The deployment creation returned with an error, please use the displayed idempotency token
-to recreate the deployment resources
-Idempotency token: GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
-unknown error (status 500)
+## To retry a deployment when the previous deployment creation failed, use the request ID provided in the error response of the previous command:
 $ ecctl deployment create --file create_example.json --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb`
 )

docs/ecctl_deployment_create.adoc

@@ -26,12 +26,7 @@ $ deployment create --file create_example.json --track
 Deployment [b6ecbea3d5c84124b7dca457f2892086] - [Elasticsearch][b6ecbea3d5c84124b7dca457f2892086]: finished running all the plan steps (Total plan duration: 5m11.s)
 Deployment [91c4d60acb804ba0a27651fac02780ec] - [Kibana][8a9d9916cd6e46a7bb0912211d76e2af]: finished running all the plan steps (Total plan duration: 4m29.58s)
 
-## To retry a when the previous deployment creation failed:
-$ ecctl deployment create --file create_example.json
-The deployment creation returned with an error, please use the displayed idempotency token
-to recreate the deployment resources
-Idempotency token: GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
-unknown error (status 500)
+## To retry a deployment when the previous deployment creation failed, use the request ID provided in the error response of the previous command:
 $ ecctl deployment create --file create_example.json --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
 ----
 
@@ -41,7 +36,7 @@ $ ecctl deployment create --file create_example.json --request-id=GMZPMRrcMYqHdm
 ----
   -f, --file string         DeploymentCreateRequest file definition. See help for more information
   -h, --help                help for create
-      --request-id string   Optional idempotency token - Can be found in the Stderr device when a previous deployment creation failed, for more information see the examples in the help command page
+      --request-id string   Optional request ID - Can be found in the Stderr device when a previous deployment creation failed. For more information see the examples in the help command page
   -t, --track               Tracks the progress of the performed task
 ----
 

docs/ecctl_deployment_create.md

@@ -23,12 +23,7 @@ $ deployment create --file create_example.json --track
 Deployment [b6ecbea3d5c84124b7dca457f2892086] - [Elasticsearch][b6ecbea3d5c84124b7dca457f2892086]: finished running all the plan steps (Total plan duration: 5m11.s)
 Deployment [91c4d60acb804ba0a27651fac02780ec] - [Kibana][8a9d9916cd6e46a7bb0912211d76e2af]: finished running all the plan steps (Total plan duration: 4m29.58s)
 
-## To retry a when the previous deployment creation failed:
-$ ecctl deployment create --file create_example.json
-The deployment creation returned with an error, please use the displayed idempotency token
-to recreate the deployment resources
-Idempotency token: GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
-unknown error (status 500)
+## To retry a deployment when the previous deployment creation failed, use the request ID provided in the error response of the previous command:
 $ ecctl deployment create --file create_example.json --request-id=GMZPMRrcMYqHdmxjIQkHbdjnhPIeBElcwrHwzVlhGUSMXrEIzVXoBykSVRsKncNb
 ```
 
@@ -37,7 +32,7 @@ $ ecctl deployment create --file create_example.json --request-id=GMZPMRrcMYqHdm
 ```
   -f, --file string         DeploymentCreateRequest file definition. See help for more information
   -h, --help                help for create
-      --request-id string   Optional idempotency token - Can be found in the Stderr device when a previous deployment creation failed, for more information see the examples in the help command page
+      --request-id string   Optional request ID - Can be found in the Stderr device when a previous deployment creation failed. For more information see the examples in the help command page
   -t, --track               Tracks the progress of the performed task
 ```