cleanup: incorporate pr comments

Author: Shabirmean

README.md

@@ -142,7 +142,7 @@ EXTERNAL-IP
 
 - **Workload Identity**: [See these instructions.](./docs/workload-identity.md)
 - **Cloud SQL**: [See these instructions](./extras/cloudsql) to replace the in-cluster databases with hosted Google Cloud SQL.
-- **Multicluster with Cloud SQL**: [See these instructions](./extras/cloudsql-multicluster) to replicate the app across two regions using GKE, Multi-cluster Ingress, and Google Cloud SQL.
+- **Multi Cluster with Cloud SQL**: [See these instructions](./extras/cloudsql-multicluster) to replicate the app across two regions using GKE, Multi Cluster Ingress, and Google Cloud SQL.
 - **Istio**: Apply `istio-manifests/` to your cluster to access the frontend through the IngressGateway.
 - **Anthos Service Mesh**: ASM requires Workload Identity to be enabled in your GKE cluster. [See the workload identity instructions](./docs/workload-identity.md) to configure and deploy the app. Then, apply `istio-manifests/` to your cluster to configure frontend ingress.
 - **Java Monolith (VM)**: We provide a version of this app where the three Java microservices are coupled together into one monolithic service, which you can deploy inside a VM (eg. Google Compute Engine). See the [ledgermonolith](./src/ledgermonolith) directory.

extras/asm-multicluster/README.md

@@ -1,60 +1,60 @@
-# Anthos Service Mesh - Multicluster 
+# Anthos Service Mesh - Multi Cluster
 
-This demo shows how to install Bank of Anthos across 2 clusters, using [Anthos Service Mesh endpoint discovery](https://cloud.google.com/service-mesh/docs/managed-control-plane#configure_endpoint_discovery_only_for_multi-cluster_installations) for cross-cluster routing.  
+This demo shows how to install Bank of Anthos across 2 clusters, using [Anthos Service Mesh endpoint discovery](https://cloud.google.com/service-mesh/docs/managed-control-plane#configure_endpoint_discovery_only_for_multi-cluster_installations) for cross-cluster routing.
 
-For a "replicated" multicluster setup with no cross-cluster traffic, see the [Cloud SQL + Multicluster](/extras/cloudsql-multicluster) demo. 
+For a "replicated" multicluster setup with no cross-cluster traffic, see the [Cloud SQL + Multi Cluster](/extras/cloudsql-multicluster) demo.
 
-## Architecture 
+## Architecture
 
 ![architecture](screenshots/architecture.png)
 
 
-## Prerequisites 
+## Prerequisites
 
-1. A Google Cloud project. 
-2. The following tools installed in your local environment: 
-- [gcloud](https://cloud.google.com/sdk/docs/install), up to date with `gcloud components update` 
+1. A Google Cloud project.
+2. The following tools installed in your local environment:
+- [gcloud](https://cloud.google.com/sdk/docs/install), up to date with `gcloud components update`
 - [kubectl](https://cloud.google.com/sdk/gcloud/reference/components/install) - you can install this via gcloud: `gcloud components install kubectl`
 - [kubectx](https://github.com/ahmetb/kubectx#installation)
-- (MacOS only) coreutils: `brew install coreutils` 
-- (MacOS only) jq: `brew install jq` 
-- (MacOS only) kpt: 
+- (MacOS only) coreutils: `brew install coreutils`
+- (MacOS only) jq: `brew install jq`
+- (MacOS only) kpt:
 ```
 brew tap GoogleContainerTools/kpt https://github.com/GoogleContainerTools/kpt.git
 brew install kpt
 ```
 
-## Steps 
+## Steps
 
 1. **Set variables.**
 
 ```
-export PROJECT_ID="<your-project-id>" 
+export PROJECT_ID="<your-project-id>"
 gcloud config set project $PROJECT_ID
 ```
 
 
-2. **Enable APIs.** 
+2. **Enable APIs.**
 
 ```
-gcloud services enable container.googleapis.com anthos.googleapis.com 
+gcloud services enable container.googleapis.com anthos.googleapis.com
 ```
 
-3. **Make sure you've `cd`-ed into this directory, then run the cluster setup script**. This script creates 2 GKE clusters, `cluster-1` and `cluster-2`, installs Anthos Service Mesh, and sets up cross-cluster endpoint discovery. This script takes about 10 minutes to run. 
+3. **Make sure you've `cd`-ed into this directory, then run the cluster setup script**. This script creates 2 GKE clusters, `cluster-1` and `cluster-2`, installs Anthos Service Mesh, and sets up cross-cluster endpoint discovery. This script takes about 10 minutes to run.
 
 ```
-cd extras/asm-multicluster/ 
+cd extras/asm-multicluster/
 ./cluster-setup.sh
 ```
 
-4. **Verify that your local kubectx is set up** for `cluster-1` and `cluster-2`, and that you can access both clusters. 
+4. **Verify that your local kubectx is set up** for `cluster-1` and `cluster-2`, and that you can access both clusters.
 
 ```
-kubectx cluster-1 
-kubectl get nodes 
+kubectx cluster-1
+kubectl get nodes
 ```
 
-You should see: 
+You should see:
 
 ```
 NAME                                       STATUS   ROLES    AGE   VERSION
@@ -64,24 +64,24 @@ gke-cluster-1-default-pool-855fbe61-f3qw   Ready    <none>   62m   v1.18.15-gke.
 gke-cluster-1-default-pool-855fbe61-tw2z   Ready    <none>   62m   v1.18.15-gke.1501
 ```
 
-5. **Deploy the Bank of Anthos app across both clusters**. This will deploy the frontend and Python backends to cluster-1, and the Java backends to cluster 2. Note that ASM endpoint discovery only works if all the Kubernetes Services are deployed to both clusters, so that's what we're doing here.   
+5. **Deploy the Bank of Anthos app across both clusters**. This will deploy the frontend and Python backends to cluster-1, and the Java backends to cluster 2. Note that ASM endpoint discovery only works if all the Kubernetes Services are deployed to both clusters, so that's what we're doing here.
 
-**Note** - you should run these commands from this directory. (`extras/asm-multicluster`). 
+**Note** - you should run these commands from this directory. (`extras/asm-multicluster`).
 
 ```
-kubectx cluster-1 
-kubectl apply -f services-all.yaml 
+kubectx cluster-1
+kubectl apply -f services-all.yaml
 kubectl apply -f ../../kubernetes-manifests/config.yaml
 kubectl apply -f ../../extras/jwt/jwt-secret.yaml
-kubectl apply -f ../../kubernetes-manifests/accounts-db.yaml 
+kubectl apply -f ../../kubernetes-manifests/accounts-db.yaml
 kubectl apply -f ../../kubernetes-manifests/contacts.yaml
 kubectl apply -f ../../kubernetes-manifests/frontend.yaml
 kubectl apply -f ../../kubernetes-manifests/userservice.yaml
 kubectl apply -f ../../kubernetes-manifests/loadgenerator.yaml
 kubectl apply -f ../../istio-manifests/frontend-ingress.yaml
 
-kubectx cluster-2 
-kubectl apply -f services-all.yaml 
+kubectx cluster-2
+kubectl apply -f services-all.yaml
 kubectl apply -f ../../kubernetes-manifests/config.yaml
 kubectl apply -f ../../extras/jwt/jwt-secret.yaml
 kubectl apply -f ../../kubernetes-manifests/ledger-db.yaml
@@ -90,13 +90,13 @@ kubectl apply -f ../../kubernetes-manifests/ledger-writer.yaml
 kubectl apply -f ../../kubernetes-manifests/transaction-history.yaml
 ```
 
-6. **Verify that the pods start up successfully.** Note that you should see 2 containers per pod `(2/2)`, one containing the Bank of Anthos service container, the other containing the ASM sidecar proxy (Envoy). 
+6. **Verify that the pods start up successfully.** Note that you should see 2 containers per pod `(2/2)`, one containing the Bank of Anthos service container, the other containing the ASM sidecar proxy (Envoy).
 
 ```
-kubectx cluster-1; kubectl get pods 
+kubectx cluster-1; kubectl get pods
 ```
 
-You should see: 
+You should see:
 
 ```
 NAME                             READY   STATUS    RESTARTS   AGE
@@ -107,13 +107,13 @@ loadgenerator-797dfd6c5c-r86vn   2/2     Running   0          14m
 userservice-7c9bc855f5-ff8tq     2/2     Running   0          14m
 ```
 
-Do the same for cluster-2: 
+Do the same for cluster-2:
 
 ```
-kubectx cluster-2; kubectl get pods 
+kubectx cluster-2; kubectl get pods
 ```
 
-You should see: 
+You should see:
 
 ```
 NAME                                  READY   STATUS    RESTARTS   AGE
@@ -123,27 +123,27 @@ ledgerwriter-7d88d5898c-vhs5l         2/2     Running   0          14m
 transactionhistory-84cf479f65-lzgdt   2/2     Running   0          14m
 ```
 
-7. **Access the Bank of Anthos frontend** using the Istio IngressGateway's LoadBalancer IP. 
+7. **Access the Bank of Anthos frontend** using the Istio IngressGateway's LoadBalancer IP.
 
 ```
-kubectx cluster-1; kubectl get svc istio-ingressgateway -n istio-system 
+kubectx cluster-1; kubectl get svc istio-ingressgateway -n istio-system
 
 NAME                   TYPE           CLUSTER-IP     EXTERNAL-IP     PORT(S)                                                                      AGE
 istio-ingressgateway   LoadBalancer   10.7.254.103   <EXTERNAL_IP>  15021:30429/TCP,80:32101/TCP,443:31503/TCP,15012:30573/TCP,15443:31131/TCP   21m
 ```
 
-Navigate to the `EXTERNAL_IP` in a browser; you should see the Bank of Anthos login page. 
+Navigate to the `EXTERNAL_IP` in a browser; you should see the Bank of Anthos login page.
 
-8. **Open the Google Cloud Console, and navigate to Anthos > Service Mesh**. You may see an Anthos window pop up - click "Enable." 
+8. **Open the Google Cloud Console, and navigate to Anthos > Service Mesh**. You may see an Anthos window pop up - click "Enable."
 
 ![enable anthos](screenshots/enable-anthos.png)
 
 
-9. View the Bank of Anthos services in the Anthos Service Mesh dashboard. In the Table view, you should see metrics populated for services in both cluster-1 and cluster 2. 
+9. View the Bank of Anthos services in the Anthos Service Mesh dashboard. In the Table view, you should see metrics populated for services in both cluster-1 and cluster 2.
 
 ![table](screenshots/asm-table.png)
 
 
-In the topology view, you should see traffic flowing from cluster 1 services (frontend) to cluster 2 services (eg. transactionhistory). 
+In the topology view, you should see traffic flowing from cluster 1 services (frontend) to cluster 2 services (eg. transactionhistory).
 
 ![topology](screenshots/asm-topology.png)

extras/cloudsql-multicluster/README.md

@@ -1,8 +1,8 @@
-# Multi-cluster Bank of Anthos with Cloud SQL
+# Multi Cluster Bank of Anthos with Cloud SQL
 
 This doc contains instructions for deploying the Cloud SQL version of Bank of Anthos in a multi-region high availability / global configuration.
 
-The use case for this setup is to demo running a global, scaled app, where even if one cluster goes down, users will be routed to the next available cluster. These instructions also show how to use [Multi-cluster Ingress](https://cloud.google.com/kubernetes-engine/docs/concepts/multi-cluster-ingress) to route users to the closest GKE cluster, demonstrating a low-latency use case.
+The use case for this setup is to demo running a global, scaled app, where even if one cluster goes down, users will be routed to the next available cluster. These instructions also show how to use [Multi Cluster Ingress](https://cloud.google.com/kubernetes-engine/docs/concepts/multi-cluster-ingress) to route users to the closest GKE cluster, demonstrating a low-latency use case.
 
 This guide has two parts to it:
 1. Deploy Bank of Anthos on 2 GKE clusters with **Multi Cluster Ingress** for
@@ -63,6 +63,8 @@ gcloud container clusters create ${CLUSTER_2_NAME} \
 	--workload-pool="${PROJECT_ID}.svc.id.goog" --enable-ip-alias
 ```
 
+> Note: It can take more than **10 minutes** for both clusters to get created.
+
 5. **Configure kubectx for the clusters.**
 
 ```
@@ -92,6 +94,7 @@ kubectx cluster1
 kubectx cluster2
 ../cloudsql/create_cloudsql_instance.sh
 ```
+> Note: Setting up the `CloudSQL` instance can sometimes take more than 10 minutes.
 
 8. **Create Cloud SQL admin secrets** in your GKE clusters. This gives your in-cluster Cloud SQL clients a username and password to access Cloud SQL. (Note that admin/admin credentials are for demo use only and should never be used in a production environment.)
 
@@ -110,7 +113,6 @@ kubectl create secret -n ${NAMESPACE} generic cloud-sql-admin \
  --from-literal=connectionName=${INSTANCE_CONNECTION_NAME}
 ```
 
-
 9. **Deploy the DB population jobs.**  These are one-off bash scripts that initialize the Accounts and Ledger databases with data. You only need to run these Jobs once, so we deploy them only on `cluster1`.
 
 ```
@@ -151,22 +153,22 @@ kubectx cluster2
 kubectl delete svc frontend -n ${NAMESPACE}
 ```
 
-13.  **Run the Multi-cluster Ingress setup script.** This registers both GKE clusters to Anthos with ***"memberships"*** and sets cluster 1 as the ***"config cluster"*** to administer the Multi-cluster Ingress resources.
+13.  **Run the Multi Cluster Ingress setup script.** This registers both GKE clusters to Anthos with ***"memberships"*** and sets cluster 1 as the ***"config cluster"*** to administer the Multi Cluster Ingress resources.
 
 ```
 ./register_clusters.sh
 ```
 
 
-14. **Create Multi-cluster Ingress resources for global routing.**  This YAML file contains two resources a headless Multicluster Kubernetes Service ("MCS") mapped to the `frontend` Pods, and a multi cluster Ingress resource, `frontend-global-ingress`, with `frontend-mcs` as the MCS backend. Note that we're only deploying this to Cluster 1, which we've designated as the multicluster ingress "config cluster."
+14. **Create Multi Cluster Ingress resources for global routing.**  This YAML file contains two resources a headless Multi Cluster Kubernetes Service ("MCS") mapped to the `frontend` Pods, and a Multi Cluster Ingress resource, `frontend-global-ingress`, with `frontend-mcs` as the MCS backend. Note that we're only deploying this to Cluster 1, which we've designated as the Multi Cluster Ingress "config cluster."
 
 ```
 kubectx cluster1
 kubectl apply -n ${NAMESPACE} -f multicluster-ingress.yaml
 ```
 
 
-15. **Verify that the multicluster ingress resource was created.** Look for the `Status` field to be populated with two Network Endpoint Groups (NEGs) corresponding to the regions where your 2 GKE clusters are running.
+15. **Verify that the Multi Cluster Ingress resource was created.** Look for the `Status` field to be populated with two Network Endpoint Groups (NEGs) corresponding to the regions where your 2 GKE clusters are running.
 
 > **Note:** It may take up to 90 seconds before a `VIP` is assigned to the
 > MultiClusterIngress resource.

extras/cloudsql-multicluster/register_clusters.sh

@@ -65,10 +65,10 @@ echo "🌏 Listing your Anthos cluster memberships:"
 gcloud container hub memberships list
 
 
-echo "🌏 Adding cluster 1 as the Multi-cluster ingress config cluster..."
+echo "🌏 Adding cluster 1 as the Multi Cluster Ingress config cluster..."
 gcloud alpha container hub ingress enable \
   --config-membership=projects/${PROJECT_ID}/locations/global/memberships/${CLUSTER_1_NAME}
 
 gcloud alpha container hub ingress describe
 
-echo "⭐️ Done."
+echo "⭐️ Done."

extras/cloudsql-multicluster/tls-for-mci.md

@@ -12,7 +12,7 @@ created in the [Multi Cluster Bank of Anthos with Cloud SQL](README.md) guide.
 - This guide assumes that all the environment variables and **kubectx**(s) -
   _cluster1 & cluster2_ - are still valid
 - This guide assumes that all the commands are executed from the same directory
-  as this README ***`(extras/cloudsql-multicluster/tls-for-mci.md)`***
+  as this file ***`(extras/cloudsql-multicluster/tls-for-mci.md)`***
 
 ---
 
@@ -57,7 +57,7 @@ envsubst < multicluster-ingress-https.template > multicluster-ingress-https.yaml
 kubectl apply -n ${NAMESPACE} -f multicluster-ingress-https.yaml
 ```
 
-6. **Verify that the multicluster ingress resource was updated.**
+6. **Verify that the Multi Cluster Ingress resource was updated.**
    This may take a few minutes. Wait until the **VIP** of the `MultiClusterIngress`
    has been updated to your newly created STATIC_IP.