Skip to content
This repository was archived by the owner on Mar 29, 2023. It is now read-only.

Commit 400d8b6

Browse files
author
autero1
authored
[skip ci] Merge pull request #34 from gruntwork-io/fix_links
[skip ci] Fix links
2 parents fdcd2e0 + 73a2344 commit 400d8b6

File tree

10 files changed

+45
-17
lines changed

10 files changed

+45
-17
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Contribution Guidelines
22

3+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
4+
relative linking correctly.
5+
-->
6+
37
Contributions to this Module are very welcome! We follow a fairly standard [pull request process](
48
https://help.github.com/articles/about-pull-requests/) for contributions, subject to the following guidelines:
59

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
# Cloud SQL Modules
55

6+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
7+
relative linking correctly.
8+
-->
9+
610
This repo contains modules for running relational databases such as MySQL and PostgreSQL on
711
[Google Cloud Platform (GCP)](https://cloud.google.com/) using [Cloud SQL](https://cloud.google.com/sql/).
812

@@ -25,7 +29,7 @@ This repo has the following folder structure:
2529

2630
The primary module is:
2731

28-
* [cloud-sql](/modules/cloud-sql): Deploy a Cloud SQL [MySQL](https://cloud.google.com/sql/docs/mysql/) or
32+
* [cloud-sql](https://github.com/gruntwork-io/terraform-google-sql/tree/master/modules/cloud-sql): Deploy a Cloud SQL [MySQL](https://cloud.google.com/sql/docs/mysql/) or
2933
[PostgreSQL](https://cloud.google.com/sql/docs/postgres/) database.
3034

3135
* [examples](https://github.com/gruntwork-io/terraform-google-sql/tree/master/examples): This folder contains
@@ -60,7 +64,7 @@ a version number bump.
6064

6165
## Who maintains this Module?
6266

63-
This Module and its Submodules are maintained by [Gruntwork](http://www.gruntwork.io/). Read the [Gruntwork Philosophy](/GRUNTWORK_PHILOSOPHY.md) document to learn more about how Gruntwork builds production grade infrastructure code. If you are looking for help or
67+
This Module and its Submodules are maintained by [Gruntwork](http://www.gruntwork.io/). Read the [Gruntwork Philosophy](https://github.com/gruntwork-io/terraform-google-sql/blob/master/GRUNTWORK_PHILOSOPHY.md) document to learn more about how Gruntwork builds production grade infrastructure code. If you are looking for help or
6468
commercial support, send an email to
6569
[support@gruntwork.io](mailto:support@gruntwork.io?Subject=Google%20SQL%20Module).
6670

@@ -75,13 +79,13 @@ Gruntwork can help with:
7579

7680
## How do I contribute to this Module?
7781

78-
Contributions are very welcome! Check out the [Contribution Guidelines](/CONTRIBUTING.md) for instructions.
82+
Contributions are very welcome! Check out the [Contribution Guidelines](https://github.com/gruntwork-io/terraform-google-sql/blob/master/CONTRIBUTING.md) for instructions.
7983

8084

8185
## How is this Module versioned?
8286

8387
This Module follows the principles of [Semantic Versioning](http://semver.org/). You can find each new release, along
84-
with the changelog, in the [Releases Page](../../releases).
88+
with the changelog, in the [Releases Page](https://github.com/gruntwork-io/terraform-google-sql/releases).
8589

8690
During initial development, the major version will be 0 (e.g., `0.x.y`), which indicates the code does not yet have a
8791
stable API. Once we hit `1.0.0`, we will make every effort to maintain a backwards compatible API and use the MAJOR,
@@ -90,6 +94,6 @@ MINOR, and PATCH versions on each release to indicate any incompatibilities.
9094

9195
## License
9296

93-
Please see [LICENSE](/LICENSE) for how the code in this repo is licensed.
97+
Please see [LICENSE](https://github.com/gruntwork-io/terraform-google-sql/blob/master/LICENSE.txt) for how the code in this repo is licensed.
9498

9599
Copyright &copy; 2019 Gruntwork, Inc.

examples/client-certificate/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Creating the certificate while there are other operations ongoing will result in
1313
To run this example, you need to:
1414

1515
1. Install [Terraform](https://www.terraform.io/).
16-
1. Open up `vars.tf` and set secrets at the top of the file as environment variables and fill in any other variables in
16+
1. Open up `variables.tf` and set secrets at the top of the file as environment variables and fill in any other variables in
1717
the file that don't have defaults.
1818
1. `terraform init`.
1919
1. `terraform plan`.

examples/mysql-private-ip/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MySQL Cloud SQL Private IP Example
22

3-
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/)
3+
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/)
44
[MySQL](https://cloud.google.com/sql/docs/mysql/) database instance with a [private IP address](https://cloud.google.com/sql/docs/mysql/private-ip).
55

66
## How do you run this example?
@@ -18,4 +18,4 @@ When the templates are applied, Terraform will output the IP address of the inst
1818
and the instance path for [connecting using the Cloud SQL Proxy](https://cloud.google.com/sql/docs/mysql/connect-admin-proxy).
1919

2020
Note that you cannot connect to the private IP instance from outside Google Cloud Platform.
21-
If you want to experiment with connecting from your own workstation, see the [public IP example](../mysql-public-ip)
21+
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)

examples/mysql-public-ip/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MySQL Cloud SQL Public IP Example
22

3-
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/)
3+
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/)
44
[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).
55

66
## How do you run this example?

examples/mysql-replicas/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# MySQL Cloud SQL HA Example
22

3-
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/)
3+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
4+
relative linking correctly.
5+
-->
6+
7+
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/)
48
[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/).
59

610
## How do you run this example?

examples/postgres-private-ip/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# PostgreSQL Cloud SQL Private IP Example
22

3-
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/)
3+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
4+
relative linking correctly.
5+
-->
6+
7+
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/)
48
[PostgreSQL](https://cloud.google.com/sql/docs/postgres/) database instance with a [private IP address](https://cloud.google.com/sql/docs/postgres/private-ip).
59

610
## How do you run this example?
@@ -18,4 +22,4 @@ When the templates are applied, Terraform will output the IP address of the inst
1822
and the instance path for [connecting using the Cloud SQL Proxy](https://cloud.google.com/sql/docs/postgres/sql-proxy).
1923

2024
Note that you cannot connect to the private IP instance from outside Google Cloud Platform.
21-
If you want to experiment with connecting from your own workstation, see the [public IP example](../postgres-public-ip)
25+
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)

examples/postgres-public-ip/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# PostgreSQL Cloud SQL Public IP Example
22

3-
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/)
3+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
4+
relative linking correctly.
5+
-->
6+
7+
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/)
48
[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).
59

610
## How do you run this example?

examples/postgres-replicas/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# PostgreSQL Cloud SQL HA Example
22

3-
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/)
3+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
4+
relative linking correctly.
5+
-->
6+
7+
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/)
48
[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/).
59

610
## How do you run this example?

modules/cloud-sql/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Cloud SQL Module
22

3+
<!-- NOTE: We use absolute linking here instead of relative linking, because the terraform registry does not support
4+
relative linking correctly.
5+
-->
6+
37
This module creates a [Google Cloud SQL](https://cloud.google.com/sql/) cluster.
48
The cluster is managed by Google, automating backups, replication, patches, and updates.
59

610
This module helps you run [MySQL](https://cloud.google.com/sql/docs/mysql/) and [PostgreSQL](https://cloud.google.com/sql/docs/postgres/) databases in [Google Cloud](https://cloud.google.com/).
711

812
## How do you use this module?
913

10-
See the [examples](/examples) folder for an example.
14+
See the [examples](https://github.com/gruntwork-io/terraform-google-sql/tree/master/examples) folder for an example.
1115

1216
## How do you configure this module?
1317

1418
This module allows you to configure a number of parameters, such as high availability, backup windows, maintenance window and replicas.
15-
For a list of all available variables and their descriptions, see [variables.tf](./variables.tf).
19+
For a list of all available variables and their descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-google-sql/blob/master/modules/cloud-sql/variables.tf).
1620

1721
## How do you connect to the database?
1822

@@ -92,7 +96,7 @@ See https://github.com/terraform-providers/terraform-provider-google/issues/2446
9296

9397
Retrieving and outputting distinct values from list of maps is not possible with resources using `count` prior to `terraform 0.12`.
9498
Instead we have to output the values JSON encoded - for example `read_replica_server_ca_certs`. For full details of the outputs and
95-
their format, see [outputs.tf](./outputs.tf).
99+
their format, see [outputs.tf](https://github.com/gruntwork-io/terraform-google-sql/blob/master/modules/cloud-sql/outputs.tf).
96100

97101
See https://github.com/hashicorp/terraform/issues/17048
98102

0 commit comments

Comments
 (0)