Add Terraform template links in SMT docs (#914)

* Add terraform docs * Add terraform docs * Add terraform docs * Add callout * Add callout
GoogleCloudPlatform · Oct 15, 2024 · 8485393 · 8485393
1 parent 43ab9cc
commit 8485393
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 12 deletions.
diff --git a/docs/cli/cli.md b/docs/cli/cli.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: SMT CLI
-nav_order: 5
+nav_order: 6
 has_children: true
 permalink: /cli
 ---

diff --git a/docs/data-types/schema.md b/docs/data-types/schema.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Data Type Conversion
-nav_order: 7
+nav_order: 8
 has_children: true
 permalink: /data-types-conv
 ---

diff --git a/docs/limitations.md b/docs/limitations.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Known Limitations
-nav_order: 12
+nav_order: 13
 permalink: /known-limitations
 ---
 

diff --git a/docs/minimal/minimal.md b/docs/minimal/minimal.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Minimal downtime migrations
-nav_order: 8
+nav_order: 9
 has_children: true
 permalink: /minimal
 ---

diff --git a/docs/monitoring/Monitoring.md b/docs/monitoring/Monitoring.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Monitoring
-nav_order: 13
+nav_order: 14
 has_children: true
 permalink: /monitoring
 ---

diff --git a/docs/permissions.md b/docs/permissions.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Permissions and Connectivity
-nav_order: 4
+nav_order: 5
 description: "Permissions and connectivity required to run SMT"
 ---
 

diff --git a/docs/poc/poc.md b/docs/poc/poc.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: POC migrations
-nav_order: 9
+nav_order: 10
 has_children: true
 permalink: /poc
 ---

diff --git a/docs/reports.md b/docs/reports.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: SMT Output(s)
-nav_order: 10
+nav_order: 11
 description: "Artifacts generated when you run Spanner migration tool"
 ---
 

diff --git a/docs/reverse-replication/ReverseReplication.md b/docs/reverse-replication/ReverseReplication.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Reverse Replication
-nav_order: 13
+nav_order: 14
 has_children: true
 permalink: /reverse-replication
 ---

diff --git a/docs/terraform.md b/docs/terraform.md
@@ -0,0 +1,47 @@
+---
+layout: default
+title: Terraform Templates
+nav_order: 4
+description: "Terraform templates to run migrations"
+---
+
+# Terraform Templates
+{: .d-inline-block }
+
+New
+{: .label .label-green }
+
+Dataflow templates now contains a repository that provides samples for common scenarios users might have while trying to run a live migration to Spanner using Terraform based orchestration.
+
+Pick a sample that is closest to your use-case, and use it as a starting point, and tailor it to your own specific needs.
+
+## Terraform repositories
+
+1. [Bulk migration](https://github.com/GoogleCloudPlatform/DataflowTemplates/tree/main/v2/datastream-to-spanner/terraform/samples)
+2. [Live migration](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/sourcedb-to-spanner/terraform/samples)
+3. [Sample environment setups](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/spanner-common/terraform/samples)
+
+## Commonly used templates & guides
+
+1. [How to run a production migration using a combination of bulk and live migrations](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/spanner-common/docs/END-TO-END-PRODUCTION-MIGRATION.md)
+2. [Bulk migration](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/sourcedb-to-spanner/terraform/samples/single-job-bulk-migration/README.md)
+3. [Live migration](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/datastream-to-spanner/terraform/samples/mysql-end-to-end/README.md)
+4. [Sharded bulk migration](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/sourcedb-to-spanner/terraform/samples/sharded-bulk-migration/README.md)
+5. [Sharded live migration using one dataflow job](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/datastream-to-spanner/terraform/samples/mysql-sharded-single-df-job/README.md)
+6. [Sharded live migration using multiple dataflow jobs](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/v2/datastream-to-spanner/terraform/samples/mysql-sharded-end-to-end/README.md)
+
+## Sample structure
+
+Each sample contains the following (and potentially more) files:
+
+1. `main.tf` - This contains the Terraform resources which will be created.
+2. `outputs.tf` - This declares the outputs that will be output as part of
+   running the terraform example.
+3. `variables.tf` - This declares the input variables that are required to
+   configure the resources.
+4. `terraform.tf` - This contains the required providers and APIs/project
+   configurations for the sample.
+5. `terraform.tfvars` - This contains the dummy inputs that need to be populated
+   to run the example.
+6. `terraform_simple.tfvars` - This contains the minimal list of dummy inputs
+   that need to be populated to run the example.
diff --git a/docs/transformations/CustomTransformation.md b/docs/transformations/CustomTransformation.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Custom Transformations
-nav_order: 15
+nav_order: 16
 permalink: /custom-transformation
 ---
 

diff --git a/docs/troubleshoot/trouble.md b/docs/troubleshoot/trouble.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Troubleshooting
-nav_order: 11
+nav_order: 12
 has_children: true
 permalink: /troubleshooting
 ---

diff --git a/docs/ui/ui.md b/docs/ui/ui.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: SMT UI
-nav_order: 6
+nav_order: 7
 has_children: true
 permalink: /ui
 ---