Merge pull request #8 from GoogleCloudPlatform/development

added more journies for PSA and PSC

Author: axtma

.gitignore

@@ -10,3 +10,4 @@ go.mod
 go.sum
 **/*.log
 **/*plan*
+**/*.DS_Store

README.md

@@ -3,8 +3,7 @@
 
 Streamline your Google Cloud SQL instance deployment and management with this comprehensive Terraform module repository. This repository simplifies Google Cloud networking configuration for Cloud SQL instances. It bundles Terraform modules to make it easier to create and manage Cloud SQL instances and all dependent resources, such as cloud networking resources, IAM policies and service accounts.
 
-This repository contains easy-to-use Terraform modules that would help you set up all the prerequisites components required to consume Cloud SQL with private IP in a GCP project. The modules make it easy to manage Cloud SQL and all relevant GCP resources.
-This solution will help different users like database administrators and application engineers who want to quickly configure Cloud SQL with cloud networking.
+This repository contains easy-to-use Terraform modules that would help you set up all the prerequisites components required to consume Cloud SQL with private IP in a GCP project. The modules make it easy to manage Cloud SQL and all relevant GCP resources. This solution will help different users like database administrators and application engineers who want to quickly configure Cloud SQL with cloud networking.
 
 Here are some specific benefits of using this repository:
 
@@ -31,9 +30,20 @@ Once the Terraform configuration has been applied, your Cloud SQL instance will
 
 Many examples are included in the [examples](./examples/) folder which describes the complete end-to-end examples covering different scenarios along with its implementation guide and architecture design.
 
-1. [Host Service Project Scenario](./examples/1.Host-Service-Project) : This solution guides user through the steps to establish a host and a service project, create a Cloud SQL instance and a VM instance in the service project, and connect the VM instance to the Cloud SQL instance using the VM's private IP address. The host project contains the VPC, subnets, and firewall rules.
+1. [Host Service Project Scenario](./examples/1.Host-Service-Project) : This solution guides a user through the steps to establish a host and a service project, create a Cloud SQL instance and a VM instance in the service project, and connect the VM instance to the Cloud SQL instance using the VM's private IP address. The host project contains the VPC, subnets, and firewall rules.
 
-2. [VPC across VPN Tunnel Scenario](./examples/2.VPC-Across-VPN) : This solution guides user to create a highly available (HA) VPN connection between a user project and a host project with a service project attached. The solution then establishes a Cloud SQL connection using the private IP address of Cloud SQL instance created in the service project and a VM instance created in the user project.
+
+2. This section outlines two user journeys for Service Networking: using **HA-VPN** or **Dedicated Interconnect**.
+
+    2.1 [VPC across VPN Tunnel Scenario](./examples/2.VPC-Across-VPN) : This solution guides a user to create a highly available (HA) VPN connection between a user project and a host project with a service project attached. The solution then establishes a Cloud SQL connection using the private IP address of the Cloud SQL instance created in the service project and a VM instance created in the user project.
+
+    2.2. [Service Networking Across Interconnect](./examples/ServiceNetworkingAcrossInterconnect) : This solution helps the user to create a dedicated interconnect connection with redundancy & 99.9% availability between an on-premise environment and a GCP project. The solution establishes a Cloud SQL connection using the private IP address of a Cloud SQL instance created inside a GCP project and a VM instance present in the user on-premise environment.
+
+3. [PSC across VPN Scenario](./examples/3.PSC) : This solution guides a user to create a PSC enabled Cloud SQL instance with a consumer and producer project setup having a compute VM instance created in the consumer project connecting to the Cloud SQL instance through PSC service endpoint. The consumer project contains the consumer VPC, service endpoint & firewall rules to connect to the SQL instance in the producer project.
+
+4. [PSC across VPN Scenario](./examples/4.PSC-Across-VPN) : This solution guides a user to create a HA VPN connection between user and consumer project to connect to a PSC enabled Cloud SQL instance in a producer project from a compute VM instance through PSC service endpoint. The compute instance in the consumer project connects to the PSC service endpoint via the VPN connection. The PSC service endpoint connects to the Cloud SQL instance.
+
+All [GA offerings](https://cloud.google.com/sql/docs/sqlserver/private-ip) for Cloud SQL (MySQL, PostgreSQL, MSSQL) are supported through our solutions.
 
 ## Variables
 
@@ -63,7 +73,7 @@ Each providers.tf file carries information like service account to be impersonat
 
 Following are sample commands that can be used to update the existing provider.tf.template file to create an provider.tf file.
 
-1. For example1 - Host- Service project scenario
+- For example : 1.Host-Service-Project
 
 ```
 export _TF_SERVICE_ACCOUNT="<ENTER THE SERVICE ACCOUNT HERE>"
@@ -77,7 +87,7 @@ sed \
 examples/1.Host-Service-Project/provider.tf.template > examples/1.Host-Service-Project/provider.tf
 ```
 
-1. For example2 - VPC Across VPN scenario
+- For example : 2.VPC-Across-VPN
 
 ```
 export _TF_SERVICE_ACCOUNT="<ENTER THE SERVICE ACCOUNT HERE>"
@@ -91,76 +101,57 @@ sed \
 examples/2.VPC-Across-VPN/provider.tf.template >examples/2.VPC-Across-VPN/provider.tf
 ```
 
-## Testing
-
-Following sections describes how the examples can be tested in a GCP environment.
-
-
-### Running locally
-While Running these locally(or in your development machines) make sure you have declared following as the environment variables.
+- For example : 3.PSC
 
 ```
-export TF_VAR_host_project_id=<HOST_PROJECT_ID>
-export TF_VAR_service_project_id=<SERVICE_PROJECT_ID>
-export TF_VAR_user_project_id=<USER_PROJECT_ID>
-```
-
-### Unit Test
-
-
-#### Running all the unit test
-
-1. cd REPO_NAME
-2. go mod init test
-3. go mod tidy
-4. **go test -v -json ./... | ./test-summary**
-
-    **Note :** test-summary is used to provide summary of the test results. More details [here](https://pkg.go.dev/gocloud.dev/internal/testing/test-summary)
+export _TF_SERVICE_ACCOUNT="<ENTER THE SERVICE ACCOUNT HERE>"
+export _TF_BUCKET_NAME="<ENTER THE GCS BUCKET NAME HERE>"
+export _TF_EXAMPLE3_PREFIX="<ENTER THE GCS PREFIX NAME HERE>"
 
+sed \
+-e "s|ENTER_TF_SERVICE_ACCOUNT|$_TF_SERVICE_ACCOUNT|" \
+-e "s|ENTER_TF_BUCKET_NAME|$_TF_BUCKET_NAME|" \
+-e "s|ENTER_TF_EXAMPLE3_PREFIX|$_TF_EXAMPLE3_PREFIX|" \
+examples/3.PSC/provider.tf.template >examples/3.PSC/provider.tf
+```
 
-#### Running Example specific test
-1. cd /tests/unit/examples/SCENARIO_NAME
-2. go mod init test
-3. go mod tidy
-4. **go test -timeout 12m -v**
+- For example : 4.PSC-Across-VPN
 
-    **e.g.** Here is an example demonstrating how a unit test for scenario 1 can be executed
-    ```
-    cd /tests/unit/examples/1.Host-Service-Project
-    go mod init test
-    go mod tidy
-    go test -timeout 12m -v
-    ```
+```
+export _TF_SERVICE_ACCOUNT="<ENTER THE SERVICE ACCOUNT HERE>"
+export _TF_BUCKET_NAME="<ENTER THE GCS BUCKET NAME HERE>"
+export _TF_EXAMPLE4_PREFIX="<ENTER THE GCS PREFIX NAME HERE>"
 
-### Integration Test
+sed \
+-e "s|ENTER_TF_SERVICE_ACCOUNT|$_TF_SERVICE_ACCOUNT|" \
+-e "s|ENTER_TF_BUCKET_NAME|$_TF_BUCKET_NAME|" \
+-e "s|ENTER_TF_EXAMPLE4_PREFIX|$_TF_EXAMPLE4_PREFIX|" \
+examples/4.PSC-Across-VPN/provider.tf.template >examples/4.PSC-Across-VPN/provider.tf
+```
 
 
-#### Running all the integration test
+- For example : ServiceNetworkingAcrossInterconnect
 
-1. cd REPO_NAME
-2. go mod init test
-3. go mod tidy
-4. **go test -v -json -timeout 60m ./... | ./test-summary**
+```
+export _TF_SERVICE_ACCOUNT="<ENTER THE SERVICE ACCOUNT HERE>"
+export _TF_BUCKET_NAME="<ENTER THE GCS BUCKET NAME HERE>"
+export _TF_EXAMPLE_SNAcrossIC_PREFIX="<ENTER THE GCS PREFIX NAME HERE>"
 
-    **Note :** test-summary is used to provide summary of the test results. More details [here](https://pkg.go.dev/gocloud.dev/internal/testing/test-summary)
+sed \
+-e "s|ENTER_TF_SERVICE_ACCOUNT|$_TF_SERVICE_ACCOUNT|" \
+-e "s|ENTER_TF_BUCKET_NAME|$_TF_BUCKET_NAME|" \
+-e "s|ENTER_TF_EXAMPLE_SNAcrossIC_PREFIX|$_TF_EXAMPLE_SNAcrossIC_PREFIX|" \
+examples/ServiceNetworkingAcrossInterconnect/provider.tf.template >examples/ServiceNetworkingAcrossInterconnect/provider.tf
+```
 
 
-#### Running Example specific test
-1. cd /tests/unit/examples/SCENARIO_NAME
-2. go mod init test
-3. go mod tidy
-4. **go test -timeout 60m -v**
+## Testing
 
-    **e.g.** Here is an example demonstrating how a unit test for scenario 1 can be executed
-    ```
-    cd /tests/integration/examples/1.Host-Service-Project
-    go mod init test
-    go mod tidy
-    go test -timeout 60m -v
-    ```
+For running the unit test cases and integration test cases, please refer to the [test](./test/README.md) documentation.
 
 
 ## Installation
+
 ### Terraform
 Be sure you have the correct Terraform version (1.5.x), you can choose the binary here:
 - https://releases.hashicorp.com/terraform/

examples/1.Host-Service-Project/README.md

@@ -20,7 +20,7 @@ This example solution is a good starting point for anyone who needs to quickly a
 
 ## Pre-requisite
 
-1. User should have terraform and gcloud installed in the machine from which they plan to execute this script. Here are the link that describes the [terraform installation](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) steps and [gcloud cli installation steps](https://cloud.google.com/sdk/docs/install) .
+1. User should have terraform and gcloud installed in the machine from which they plan to execute this script. Here are the link that describes the [terraform installation](https://developer.hashicorp.com/terraform/tutorials/gcp-get-started/install-cli) steps and [gcloud cli installation steps](https://cloud.google.com/sdk/docs/install) .
 2. User should have two GCP projects which will be used as part of this guide. First GCP project will act as a Host Project and the Second GCP Project will act as a Service Project.
 3. User planning to run this script should have following permissions asssigned to them in the respective projects as described below. User can either use webconsole or gcloud cli to assign these permission to the user identity using which these scripts will be executed. User can follow either step `3.a.` or `3.b.` or `3.c.` to complete this step.
    - **Host Project**
@@ -75,7 +75,7 @@ This command creates an execution plan, which lets you preview the changes that
 
 ## Examples
 
-1. This example leverages the existing network and subnetwork. Network information like network_name, network_id and subnetword_id should be passed in the terraform.tfvars file. The terraform.tfvars should look like
+1. This example leverages the existing network and subnetwork. Network information like network_name, network_id and subnetwork_id should be passed in the terraform.tfvars file. The terraform.tfvars should look like
     ```
     host_project_id        = "<GCP-HOST-PROJECT-ID>"
     service_project_id     = "<GCP-SERVICE-PROJECT-ID>"

examples/1.Host-Service-Project/cloudsql.tf

@@ -1,4 +1,4 @@
-# Copyright 2023 Google LLC
+# Copyright 2023-2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@ module "sql-db" {
   name                = var.cloudsql_instance_name
   database_version    = var.database_version
   zone                = var.zone
+  region              = var.region
   project_id          = var.service_project_id
   ip_configuration    = local.ip_configuration
   deletion_protection = var.deletion_protection

examples/2.VPC-Across-VPN/README.md

@@ -31,7 +31,7 @@ Here is a brief overview of the things being created by the terraform solution :
 
 ## Pre-requisite
 
-1. User should have terraform and gcloud installed in the machine from which they plan to execute this script. Here are the link that describes the [terraform installation](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) steps and [gcloud cli installation steps](https://cloud.google.com/sdk/docs/install) .
+1. User should have terraform and gcloud installed in the machine from which they plan to execute this script. Here are the link that describes the [terraform installation](https://developer.hashicorp.com/terraform/tutorials/gcp-get-started/install-cli) steps and [gcloud cli installation steps](https://cloud.google.com/sdk/docs/install) .
 2. User should have three GCP projects which will be used as part of this guide. First GCP project will act as a Host Project, the Second GCP Project will act as a Service Project and the Third GCP project will act as the user project.
 3. User planning to run this script should have following permissions asssigned to them in the respective projects as described below. User can either use webconsole or gcloud cli to assign these permission to the user identity using which these scripts will be executed. User can follow either step `3.a.` or `3.b.` or `3.c.` to complete this step.
    - **Host Project**
@@ -95,7 +95,7 @@ This command creates an execution plan, which lets you preview the changes that
 
 ## Examples
 
-1. This example leverages the existing network and subnetwork. Network information like network_name, network_id and subnetword_id should be passed in the terraform.tfvars file. The terraform.tfvars should look like
+1. This example leverages the existing network and subnetwork. Network information like network_name, network_id and subnetwork_id should be passed in the terraform.tfvars file. The terraform.tfvars should look like
     ```
     host_project_id        = "<GCP-HOST-PROJECT-ID>"
     service_project_id     = "<GCP-SERVICE-PROJECT-ID>"

examples/2.VPC-Across-VPN/cloudsql.tf

@@ -1,4 +1,4 @@
-# Copyright 2023 Google LLC
+# Copyright 2023-2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@ module "sql-db" {
   name                = var.cloudsql_instance_name
   database_version    = var.database_version
   zone                = var.zone
+  region              = var.region
   project_id          = var.service_project_id
   ip_configuration    = local.ip_configuration
   deletion_protection = var.deletion_protection