From 739081d710ff3194f4a1f9ed449716c919609ce7 Mon Sep 17 00:00:00 2001
From: Philippe Boneff <phb@google.com>
Date: Wed, 24 Jul 2024 16:52:26 +0000
Subject: [PATCH] better names and move documentation around

---
 deployment/README.md                       | 22 +-------------------
 deployment/live/example-gcp/README.md      | 24 ++++++++++++++++++++++
 deployment/live/example-gcp/terragrunt.hcl |  2 +-
 deployment/modules/gcs/main.tf             |  2 +-
 4 files changed, 27 insertions(+), 23 deletions(-)
 create mode 100644 deployment/live/example-gcp/README.md

diff --git a/deployment/README.md b/deployment/README.md
index 2b54ef5e..f95cee5d 100644
--- a/deployment/README.md
+++ b/deployment/README.md
@@ -14,25 +14,5 @@ Deploying these examples requires installation of:
 
 ## Deploying
 
-First authenticate via `gcloud` as a principle with sufficient ACLs for
-the project:
-```bash
-gcloud auth application-default login
-```
-
-Then, specify your Google Cloud project ID:
-```bash
-export GOOGLE_PROJECT={VALUE}
-```
-
-Eventually, customize the region (defaults to "us-east1"), and bucket name prefix
-(defaults to "tessera"):
-```bash
-export GOOGLE_REGION={VALUE}
-export TESSERA_BASE_NAME={VALUE}
-```
-
-Terraforming the project can be done by:
- 1. `cd` to the relevant `live` directory for the environment to deploy/change
- 2. Run `terragrunt apply`
+See individual `live` subdirectories.
 
diff --git a/deployment/live/example-gcp/README.md b/deployment/live/example-gcp/README.md
new file mode 100644
index 00000000..b009a5fb
--- /dev/null
+++ b/deployment/live/example-gcp/README.md
@@ -0,0 +1,24 @@
+## Deployment 
+
+First authenticate via `gcloud` as a principle with sufficient ACLs for
+the project:
+```bash
+gcloud auth application-default login
+```
+
+Then, specify your Google Cloud project ID:
+```bash
+export GOOGLE_PROJECT={VALUE}
+```
+
+Eventually, customize the region (defaults to "us-east1"), and bucket name prefix
+(defaults to "tessera-example"):
+```bash
+export GOOGLE_REGION={VALUE}
+export TESSERA_BASE_NAME={VALUE}
+```
+
+Terraforming the project can be done by:
+ 1. `cd` to the relevant `live` directory for the environment to deploy/change
+ 2. Run `terragrunt apply`
+
diff --git a/deployment/live/example-gcp/terragrunt.hcl b/deployment/live/example-gcp/terragrunt.hcl
index b94b03da..5e5599ac 100644
--- a/deployment/live/example-gcp/terragrunt.hcl
+++ b/deployment/live/example-gcp/terragrunt.hcl
@@ -5,7 +5,7 @@ terraform {
 locals {
   project_id = get_env("GOOGLE_PROJECT")
   location   = get_env("GOOGLE_REGION", "us-central1")
-  base_name   = get_env("TESSERA_BASE_NAME", "tessera")
+  base_name   = get_env("TESSERA_BASE_NAME", "tessera-example")
 }
 
 inputs = merge(
diff --git a/deployment/modules/gcs/main.tf b/deployment/modules/gcs/main.tf
index 6f2fd339..c5d819a5 100644
--- a/deployment/modules/gcs/main.tf
+++ b/deployment/modules/gcs/main.tf
@@ -52,7 +52,7 @@ resource "google_storage_bucket_iam_binding" "log_bucket_writer" {
 resource "google_spanner_instance" "log_spanner" {
   name             = var.base_name
   config           = "regional-${var.location}"
-  display_name     = "${var.base_name} Spanner Instance"
+  display_name     = "${var.base_name}"
   processing_units = 100
 }