diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20b9986..ff083f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,9 @@ # Contribution Guidelines + + Contributions to this Module are very welcome! We follow a fairly standard [pull request process]( https://help.github.com/articles/about-pull-requests/) for contributions, subject to the following guidelines: diff --git a/README.md b/README.md index af279be..e4c7388 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ # Cloud SQL Modules + + This repo contains modules for running relational databases such as MySQL and PostgreSQL on [Google Cloud Platform (GCP)](https://cloud.google.com/) using [Cloud SQL](https://cloud.google.com/sql/). diff --git a/examples/client-certificate/README.md b/examples/client-certificate/README.md index d614dee..fa50d8b 100644 --- a/examples/client-certificate/README.md +++ b/examples/client-certificate/README.md @@ -13,7 +13,7 @@ Creating the certificate while there are other operations ongoing will result in To run this example, you need to: 1. Install [Terraform](https://www.terraform.io/). -1. Open up `vars.tf` and set secrets at the top of the file as environment variables and fill in any other variables in +1. Open up `variables.tf` and set secrets at the top of the file as environment variables and fill in any other variables in the file that don't have defaults. 1. `terraform init`. 1. `terraform plan`. diff --git a/examples/mysql-private-ip/README.md b/examples/mysql-private-ip/README.md index 3760f80..81d22d0 100644 --- a/examples/mysql-private-ip/README.md +++ b/examples/mysql-private-ip/README.md @@ -1,6 +1,6 @@ # MySQL Cloud SQL Private IP Example -This folder contains an example of how to use the [Cloud SQL module](/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) +This folder contains an example of how to use the [Cloud SQL module](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) [MySQL](https://cloud.google.com/sql/docs/mysql/) database instance with a [private IP address](https://cloud.google.com/sql/docs/mysql/private-ip). ## How do you run this example? @@ -18,4 +18,4 @@ When the templates are applied, Terraform will output the IP address of the inst and the instance path for [connecting using the Cloud SQL Proxy](https://cloud.google.com/sql/docs/mysql/connect-admin-proxy). Note that you cannot connect to the private IP instance from outside Google Cloud Platform. -If you want to experiment with connecting from your own workstation, see the [public IP example](../mysql-public-ip) +If you want to experiment with connecting from your own workstation, see the [public IP example](https://github.com/gruntwork-io/terraform-google-sql/tree/master/examples/mysql-public-ip) diff --git a/examples/mysql-public-ip/README.md b/examples/mysql-public-ip/README.md index b582c7d..b3802a8 100644 --- a/examples/mysql-public-ip/README.md +++ b/examples/mysql-public-ip/README.md @@ -1,6 +1,6 @@ # MySQL Cloud SQL Public IP Example -This folder contains an example of how to use the [Cloud SQL module](/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) +This folder contains an example of how to use the [Cloud SQL module](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) [MySQL](https://cloud.google.com/sql/docs/mysql/) database instance with a [public IP address](https://cloud.google.com/sql/docs/mysql/connect-external-app#appaccessIP). ## How do you run this example? diff --git a/examples/mysql-replicas/README.md b/examples/mysql-replicas/README.md index 849bc66..72113c8 100644 --- a/examples/mysql-replicas/README.md +++ b/examples/mysql-replicas/README.md @@ -1,6 +1,10 @@ # MySQL Cloud SQL HA Example -This folder contains an example of how to use the [Cloud SQL module](/modules/cloud-sql) to create a [High Availability](https://cloud.google.com/sql/docs/mysql/configure-ha) [Google Cloud SQL](https://cloud.google.com/sql/) + + +This folder contains an example of how to use the [Cloud SQL module](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql) to create a [High Availability](https://cloud.google.com/sql/docs/mysql/configure-ha) [Google Cloud SQL](https://cloud.google.com/sql/) [MySQL](https://cloud.google.com/sql/docs/mysql/) database cluster with a [public IP](https://cloud.google.com/sql/docs/mysql/connect-external-app#appaccessIP) and failover and [read replicas](https://cloud.google.com/sql/docs/mysql/replication/). ## How do you run this example? diff --git a/examples/postgres-private-ip/README.md b/examples/postgres-private-ip/README.md index 7fa4c01..575c450 100644 --- a/examples/postgres-private-ip/README.md +++ b/examples/postgres-private-ip/README.md @@ -1,6 +1,10 @@ # PostgreSQL Cloud SQL Private IP Example -This folder contains an example of how to use the [Cloud SQL module](/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) + + +This folder contains an example of how to use the [Cloud SQL module](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) [PostgreSQL](https://cloud.google.com/sql/docs/postgres/) database instance with a [private IP address](https://cloud.google.com/sql/docs/postgres/private-ip). ## How do you run this example? @@ -18,4 +22,4 @@ When the templates are applied, Terraform will output the IP address of the inst and the instance path for [connecting using the Cloud SQL Proxy](https://cloud.google.com/sql/docs/postgres/sql-proxy). Note that you cannot connect to the private IP instance from outside Google Cloud Platform. -If you want to experiment with connecting from your own workstation, see the [public IP example](../postgres-public-ip) +If you want to experiment with connecting from your own workstation, see the [public IP example](https://github.com/gruntwork-io/terraform-google-sql/tree/master/examples/postgres-public-ip) diff --git a/examples/postgres-public-ip/README.md b/examples/postgres-public-ip/README.md index 572e17d..46c046a 100644 --- a/examples/postgres-public-ip/README.md +++ b/examples/postgres-public-ip/README.md @@ -1,6 +1,10 @@ # PostgreSQL Cloud SQL Public IP Example -This folder contains an example of how to use the [Cloud SQL module](/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) + + +This folder contains an example of how to use the [Cloud SQL module](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql) to create a [Google Cloud SQL](https://cloud.google.com/sql/) [PostgreSQL](https://cloud.google.com/sql/docs/postgres/) database instance with a [public IP address](https://cloud.google.com/sql/docs/postgres/connect-external-app#appaccessIP). ## How do you run this example? diff --git a/examples/postgres-replicas/README.md b/examples/postgres-replicas/README.md index 6dd83d0..2f21f31 100644 --- a/examples/postgres-replicas/README.md +++ b/examples/postgres-replicas/README.md @@ -1,6 +1,10 @@ # PostgreSQL Cloud SQL HA Example -This folder contains an example of how to use the [Cloud SQL module](/modules/cloud-sql) to create a [High Availability](https://cloud.google.com/sql/docs/postgres/high-availability) [Google Cloud SQL](https://cloud.google.com/sql/) + + +This folder contains an example of how to use the [Cloud SQL module](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql) to create a [High Availability](https://cloud.google.com/sql/docs/postgres/high-availability) [Google Cloud SQL](https://cloud.google.com/sql/) [PostgreSQL](https://cloud.google.com/sql/docs/postgres/) database cluster with a [public IP address](https://cloud.google.com/sql/docs/postgres/connect-external-app#appaccessIP) and a [read replica](https://cloud.google.com/sql/docs/postgres/replication/). ## How do you run this example? diff --git a/modules/cloud-sql/README.md b/modules/cloud-sql/README.md index ec510f2..2fab1cd 100644 --- a/modules/cloud-sql/README.md +++ b/modules/cloud-sql/README.md @@ -1,5 +1,9 @@ # Cloud SQL Module + + This module creates a [Google Cloud SQL](https://cloud.google.com/sql/) cluster. The cluster is managed by Google, automating backups, replication, patches, and updates.