fix: Add support for Terraform 1.5 and fix issues in CLI and walkthrough doc (#1042)

enables use of terraform 1.5 versions
show error message on failures of running terraform commands in CLI
fix commands, missing commands and arguments explanations in walkthrough
replaces use of --uri flag with --format flag in `gcloud storage buckets list` command in CLI

Author: minherz

docs/walkthrough.md

@@ -41,7 +41,7 @@ Configure Cloud Shell to use the selected project by running the following
 command in Cloud Shell:
 
 ```bash
-gcloud configure set project <walkthrough-project-id/>
+gcloud config set project <walkthrough-project-id/>
 ```
 
 <walkthrough-enable-apis apis=
@@ -51,17 +51,34 @@ gcloud configure set project <walkthrough-project-id/>
 
 If prompted, authorize Cloud Shell to call listed Google Cloud APIs.
 
-## Launch Cloud Ops Sandbox
+## Create Cloud Ops Sandbox
 
-To launch Sandbox using default settings run the following command in Cloud Shell:
+Before creating a new Cloud Ops Sandbox you have to establish application
+credentials to be used in the provisioning process.
+To establish the credentials, run the following gcloud CLI command in Cloud Shell:
+
+```bash
+gcloud auth application-default login --project-id <walkthrough-project-id/>
+```
+
+and follow instructions. **Note:** you may be asked to authenticate by opening a
+printed URL in the browser.
+
+To create a new Cloud Ops Sandbox using default settings run the following
+command in Cloud Shell:
 
 ```bash
 provisioning/sandboxctl create --project-id <walkthrough-project-id/>
 ```
 
-By default the launch will install [Anthos Service Mesh][3](ASM) and the
-load generator that will create a simulated load on the demo application.
-Also it will provision the [regional cluster][4] in the `us-central1` region.
+By default the launch installs [Anthos Service Mesh][3](ASM) and provisions
+a load generator that will create a continuous load of requests to the demo
+application.
+The demo application is deployed to the [regional cluster][4] in the
+`us-central1` region unless you customize the location parameter.
+**Note:** creating Sandbox that using the [regional cluster][4] takes longer
+time and bears higher costs than using the [zonal cluster][5].
+
 If you wish to customize any of these default settings, you will need to run the
 above command with additional parameters.
 
@@ -73,7 +90,7 @@ If you want to experiment with Sandbox without simulated load, add the
 `--skip-loadgenerator` parameter to the launch command below.
 
 In order to change the region where GKE cluster is provisioned or to be provisioned
-it as a [zonal cluster][5], add `--cluster-location [LOC]` parameter.
+it as the [zonal cluster][5], add `--cluster-location [LOC]` parameter.
 And provide a name of a region or a zone as `[LOC]`
 
 The GKE cluster name is set to `cloud-ops-sandbox`. If you want to customize it

provisioning/sandboxctl

@@ -96,11 +96,12 @@ create_subcommand() {
       export TF_APPEND_USER_AGENT="deploystack/cloud-ops-sandbox"
       export GOOGLE_TERRAFORM_USERAGENT_EXTENSION="${TF_APPEND_USER_AGENT}"
     fi
-    terraform init -backend-config "bucket=${TF_BUCKET_NAME}" -backend-config "prefix=${TERRAFORM_PREFIX}" -lockfile=false && \
-    terraform apply -auto-approve -var-file="${tf_FILE_LOCATION}" && \
+    if ! (terraform init -backend-config "bucket=${TF_BUCKET_NAME}" -backend-config "prefix=${TERRAFORM_PREFIX}" -lockfile=false); then error "Failed to apply terraform configuration. Run with --verbose flag to get more details."; fi && \
+    terraform apply -auto-approve -var-file="${TF_FILE_LOCATION}" && \
     print_launch_instructions
     send_telemetry "hipstershop-available"
   }
+
   ### Cleanup ###
   unset -v GOOGLE_TERRAFORM_USERAGENT_EXTENSION TF_APPEND_USER_AGENT
   popd > /dev/null
@@ -128,8 +129,8 @@ delete_subcommand() {
       export TF_APPEND_USER_AGENT="deploystack/cloud-ops-sandbox"
       export GOOGLE_TERRAFORM_USERAGENT_EXTENSION="${TF_APPEND_USER_AGENT}"
     fi
-    terraform init -backend-config "bucket=${TF_BUCKET_NAME}" -backend-config "prefix=${TERRAFORM_PREFIX}" -lockfile=false && \
-    terraform destroy -auto-approve -var-file="${tf_FILE_LOCATION}" && \
+    if ! (terraform init -backend-config "bucket=${TF_BUCKET_NAME}" -backend-config "prefix=${TERRAFORM_PREFIX}" -lockfile=false); then error "Failed to apply terraform configuration. Run with --verbose flag to get more details."; fi && \
+    terraform destroy -auto-approve -var-file="${TF_FILE_LOCATION}" && \
     info "Successfully deleted Cloud Ops Sandbox from ${PROJECT_ID} project."
   }
   ### Cleanup ###
@@ -177,6 +178,7 @@ init() {
   SKIP_ASM=0
   VERBOSE=0
   CLOUDOPS_SANDBOX_POOL_CFG=${CLOUDOPS_SANDBOX_POOL_CFG:-}
+  TF_FILE_LOCATION="$(mktemp).tfvars"; readonly TF_FILE_LOCATION
 }
 
 ### Support functions ###
@@ -204,7 +206,7 @@ fatal() {
 
 fatal_with_usage() {
   error "${1}"
-  usage_short >&2
+  usage >&2
   exit 2
 }
 
@@ -228,9 +230,9 @@ SUBCOMMANDS:
                                       Google Cloud environment.
 
 OPTIONS:
-  -l|--cluster_location  <LOCATION>   The GCP location of the target cluster.
-  -n|--cluster_name      <NAME>       The name of the target cluster.
-  -p|--project_id        <ID>         The GCP project ID.
+  -l|--cluster-location  <LOCATION>   The GCP location of the target cluster.
+  -n|--cluster-name      <NAME>       The name of the target cluster.
+  -p|--project-id        <ID>         The GCP project ID.
   --skip-asm                          (Optional) Set to not install Anthos
                                       Service Mesh. Default is false.
   --skip-loadgenerator                (Optional) Set to not deploy load
@@ -385,10 +387,10 @@ send_telemetry() {
 
 x_exit_if_no_auth_token() {
   local AUTHTOKEN; AUTHTOKEN="$(get_auth_token)"
-  if [[ -z "${AUTHTOKEN}" ]]; then
+  if [[ -z "${AUTHTOKEN}" || "${AUTHTOKEN}" =~ ^"ERROR:" ]]; then
     { read -r -d '' MSG; validation_error "${MSG}"; } <<EOF || true
-Auth token is not obtained successfully. Please login and
-retry, e.g., run 'gcloud auth application-default login' to login.
+Auth token is not obtained successfully. Please login and retry,
+${0}
 EOF
   fi
 }
@@ -415,7 +417,7 @@ local_iam_user() {
 prepare_terraform_state() {
   TF_BUCKET_NAME="${PROJECT_ID}-cloud-ops-sandbox-tf-state"
   local URIS
-  URIS=$(gcloud storage buckets list "gs://${TF_BUCKET_NAME}*" --uri --project "${PROJECT_ID}")
+  URIS=$(gcloud storage buckets list "gs://${TF_BUCKET_NAME}*" --format="value(storage_url)" --project "${PROJECT_ID}")
   if [[ -z "${URIS}" ]]; then
     info "Creating storage bucket to host Cloud Ops Sandbox state..."
     retry 3 gcloud storage buckets create "gs://${TF_BUCKET_NAME}" --project "${PROJECT_ID}"
@@ -436,7 +438,7 @@ does_terraform_state_exist() {
     STATE_OBJ_URI="gs://${TF_BUCKET_NAME}/${TERRAFORM_PREFIX}/default.tfstate"
   fi
   local URIS
-  URIS=$(gcloud storage objects list "${STATE_OBJ_URI}" --uri --project "${PROJECT_ID}")
+  URIS=$(gcloud storage objects list "${STATE_OBJ_URI}" --format="value(storage_url)" --project "${PROJECT_ID}")
   if [[ -z "${URIS}" ]]; then
     false
     return
@@ -464,12 +466,10 @@ append_to_terraform_config() {
   fi
 
   local ASSIGNMENT="${1} = \"${2}\""
-  echo "${ASSIGNMENT}" >> "${tf_FILE_LOCATION}"
+  echo "${ASSIGNMENT}" >> "${TF_FILE_LOCATION}"
 }
 
 configure_terraform_input_vars() {
-  tf_FILE_LOCATION="$(mktemp).tfvars"; readonly tf_FILE_LOCATION
-
   local CONTEXT_TFVARS; CONTEXT_TFVARS=$(cat <<EOF
 state_bucket_name = "${TF_BUCKET_NAME}"
 state_prefix = "${TERRAFORM_PREFIX}"
@@ -478,9 +478,9 @@ filepath_manifest = "${SCRIPT_DIR}/kustomize/online-boutique/"
 EOF
 )
 
-  echo "${CONTEXT_TFVARS}" >| "${tf_FILE_LOCATION}"
+  echo "${CONTEXT_TFVARS}" >| "${TF_FILE_LOCATION}"
   if [ -n "" ]; then
-    echo "? = \"${}\"" >> "${tf_FILE_LOCATION}"
+    echo "? = \"${}\"" >> "${TF_FILE_LOCATION}"
   fi
 
   if [[ -n "${CLUSTER_NAME}" ]]; then

provisioning/terraform/providers.tf

@@ -20,8 +20,8 @@
 # in the data section.
 
 terraform {
-  # The module has 0.12 syntax and is not compatible with any versions below 0.12.
-  required_version = "~> 1.4.1"
+  # The module has syntax validated vs 1.4.1
+  required_version = ">= 1.4.1, < 1.6.0"
 
   required_providers {
     google = {