Skip to content

Commit 3c6d5f9

Browse files
committed
Add upgrade guide, CHANGELOG entry for 2.0.0
1 parent 78e451f commit 3c6d5f9

File tree

2 files changed

+74
-2
lines changed

2 files changed

+74
-2
lines changed

CHANGELOG.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10+
## [2.0.0] - 2019-09-26
11+
12+
2.0.0 is a backward incompatible release. Review the
13+
[upgrade guide](docs/upgrading_to_sql_db_2.0.0.md) for more information.
14+
1015
### Added
1116

1217
- `peering_completed` marker to postgresql module [#43]
@@ -19,7 +24,8 @@ project adheres to [Semantic Versioning](http://semver.org/).
1924

2025
### Fixed
2126

22-
- The network reference in the `private_service_access` module uses the self link. [#61]
27+
- The network reference in the `private_service_access` module uses the
28+
self link. [#61]
2329

2430
## [1.2.0] - 2019-07-30
2531

@@ -33,7 +39,8 @@ project adheres to [Semantic Versioning](http://semver.org/).
3339

3440
## [1.0.0] - 2019-02-14
3541

36-
[Unreleased]: https://github.com/terraform-google-modules/terraform-google-sql-db/compare/v1.2.0...HEAD
42+
[Unreleased]: https://github.com/terraform-google-modules/terraform-google-sql-db/compare/v2.0.0...HEAD
43+
[2.0.0]: https://github.com/terraform-google-modules/terraform-google-sql-db/compare/v1.2.0...v2.0.0
3744
[1.2.0]: https://github.com/terraform-google-modules/terraform-google-sql-db/compare/1.1.2...v1.2.0
3845
[1.1.2]: https://github.com/terraform-google-modules/terraform-google-sql-db/compare/1.1.1...1.1.2
3946
[1.1.1]: https://github.com/terraform-google-modules/terraform-google-sql-db/compare/1.1.0...1.1.1

docs/upgrading_to_sql_db_2.0.0.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Upgrading to SQL DB 2.0.0
2+
3+
The 2.0.0 release of SQL DB is a backward incompatible release. This
4+
incompatibility affects any configuration which uses the root module.
5+
6+
## Instructions
7+
8+
Prior to the 1.1.0 release, the root module was the only mechanism to
9+
configure databases:
10+
11+
```hcl
12+
module "sql_db_mysql" {
13+
source = "GoogleCloudPlatform/sql-db/google"
14+
version = "1.0.0"
15+
16+
database_version = "MYSQL_5_6"
17+
name = "mysql-example"
18+
project = "example-project"
19+
region = "us-central1"
20+
}
21+
22+
module "sql_db_postgresql" {
23+
source = "GoogleCloudPlatform/sql-db/google"
24+
version = "1.0.0"
25+
26+
database_version = "POSTGRES_9_6"
27+
name = "postgresql-examlpe"
28+
project = "example-project"
29+
region = "us-central1"
30+
}
31+
```
32+
33+
With the 1.1.0 release, submodules were added for each type of
34+
database. As of the 2.0.0 release, the root module has been removed so
35+
the submodules must be used:
36+
37+
```diff
38+
module "sql_db_mysql" {
39+
- source = "GoogleCloudPlatform/sql-db/google"
40+
+ source = "GoogleCloudPlatform/sql-db/google//modules/mysql"
41+
- version = "1.0.0"
42+
+ version = "~> 2.0"
43+
44+
database_version = "MYSQL_5_6"
45+
name = "mysql-example"
46+
- project = "example-project"
47+
+ project_id = "example-project"
48+
region = "us-central1"
49+
+ zone = "us-central1-a"
50+
}
51+
52+
module "sql_db_postgresql" {
53+
- source = "GoogleCloudPlatform/sql-db/google"
54+
+ source = "GoogleCloudPlatform/sql-db/google//modules/postgresql"
55+
- version = "1.0.0"
56+
+ version = "~> 2.0"
57+
58+
database_version = "POSTGRES_9_6"
59+
name = "postgresql-example"
60+
- project = "example-project"
61+
+ project_id = "example-project"
62+
region = "us-central1"
63+
+ zone = "us-central1-a"
64+
}
65+
```

0 commit comments

Comments
 (0)