test(mc): refactor, and add to docs

test/multicloud/README.md

@@ -6,21 +6,25 @@ This project leverages [OpenTofu](https://opentofu.org/docs/intro/) Infrastructu
 
 ## Modules available
 
-* [aks](./modules/aks/)
-* [gke](./modules/gke/)
-* [kind](./modules/kind/)
-* [retina](./modules/retina/)
+* [aks](./modules/aks/): Deploy Azure Kubernetes Service cluster.
+* [gke](./modules/gke/): Deploy Google Kubernetes Engine cluster.
+* [kind](./modules/kind/): Deploy KIND cluster.
+* [helm-release](./modules/helm-release/): Deploy a Helm Chart, used to deploy Retina and Prometheus.
+* [kubernetes-lb](./modules/kubernetes-lb/): Create a Kubernetes Service of type Load Balancer, used to expose Prometheus.
+* [grafana](./modules/grafana/): Set up multiple Prometheus data sources in Grafana Cloud.
+* [aks-nsg](./modules/aks-nsg/): Inboud and outbount rules for AKS Load Balancer.
+* [gke-firewall](./modules/gke-firewall/): Inboud and outbount rules for GKE Load Balancer.
 
 ## Prerequisites
 
 * [OpenTofu installation guide](https://opentofu.org/docs/intro/install/)
 
 * AKS:
 
-    1. create an Azure account
-    2. [Install az](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)
+    1. Create an Azure account.
+    2. [Install az](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli).
 
-    To deploy an AKS cluster and install retina, create file `live/retina-aks/terraform.tfvars` with the Azure TenantID and SubscriptionID
+    To deploy an AKS cluster and install retina, create file `live/retina-aks/terraform.tfvars` with the Azure TenantID and SubscriptionID.
 
     ```sh
     # example values
@@ -30,10 +34,10 @@ This project leverages [OpenTofu](https://opentofu.org/docs/intro/) Infrastructu
 
 * GKE:
 
-    1. create a gcloud account, project and enable billing
-    2. create a service account and service account key
-    3. [Enable Kubernetes Engine API](https://console.developers.google.com/apis/api/container.googleapis.com/overview?project=mc-retina)
-    4. [Install gcloud](https://cloud.google.com/sdk/docs/install)
+    1. create a gcloud account, project and enable billing.
+    2. create a service account and service account key.
+    3. [Enable Kubernetes Engine API](https://console.developers.google.com/apis/api/container.googleapis.com/overview?project=mc-retina).
+    4. [Install gcloud](https://cloud.google.com/sdk/docs/install).
 
     To deploy a GKE cluster export `GOOGLE_APPLICATION_CREDENTIALS` env variable to point to the path where your [service account key](https://cloud.google.com/iam/docs/keys-create-delete) is located.
 
@@ -42,12 +46,24 @@ This project leverages [OpenTofu](https://opentofu.org/docs/intro/) Infrastructu
     export GOOGLE_APPLICATION_CREDENTIALS=/Users/srodi/src/retina/test/multicloud/live/retina-gke/service-key.json
     ```
 
+* Grafana
+
+    1. Set up a [Grafana Cloud free account](https://grafana.com/pricing/) and start an instance.
+    2. Create a [Service Account](https://grafana.com/docs/grafana/latest/administration/service-accounts/#create-a-service-account-in-grafana).
+    3. Export `GRAFANA_AUTH` environmnet variable containing the service account token.
+
+    ```sh
+    export GRAFANA_AUTH=glsa_s0MeRan0mS7r1ng_1ab2c345
+    ```
+
 * Kind:
 
     1. Docker installed on the host machine
 
 ## Quickstart
 
+![Hubble on GKE v1 dataplane (no Cilium)](./diagrams/mc-gke-hubble.png)
+
 The following Make targets can be used to manage each stack lifecycle.
 
 ### Create
@@ -93,9 +109,13 @@ make test
 
 ## Providers references
 
-* [GKE resource documentation](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/container_cluster)
-* [AKS resource documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/kubernetes_cluster)
-* [Kind resource documentation](https://registry.terraform.io/providers/tehcyx/kind/latest/docs/resources/cluster)
+Resources documentation:
+
+* [GKE](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/container_cluster)
+* [AKS](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/kubernetes_cluster)
+* [Kind](https://registry.terraform.io/providers/tehcyx/kind/latest/docs/resources/cluster)
+* [Helm Release](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release)
+* [Kubernetes LB Service](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/service)
 
 ## Troubleshooting
 
@@ -111,3 +131,9 @@ tofu import module.gke.google_service_account.default projects/mc-retina/service
 ```
 
 >Note: each resource documentation contains a section on how to import resources into the State. [Example for google_container_cluster resource](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/container_cluster#import)
+
+## Multi-Cloud
+
+The [live/](./live/) directory contains the multi-cloud / multi-cluster stacks to deploy clusters, install Retina, install Prometheus, expose all Prometheus using load blanaces, and configure a Grafana Cloud instance to consume prometheus data sources to visualize multiple cluster in a single Grafana dashboard. 
+
+![Architecture Diagram](./diagrams/mc-diagram.svg)