Skip to content

Commit fc3fc6a

Browse files
committed
Move old upgrading guide references to CHANGELOG
1 parent dc90055 commit fc3fc6a

File tree

2 files changed

+14
-16
lines changed

2 files changed

+14
-16
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ The v5.0.0 module requires using the [2.12 version](https://github.com/terraform
4848
* Supported version of Terraform is 0.12. [#177]
4949

5050
## [v3.0.0] - 2019-07-08
51+
v3.0.0 is a breaking release. Refer to the
52+
[Upgrading to v3.0 guide][upgrading-to-v3.0] for details.
5153

5254
### Added
5355

@@ -88,6 +90,8 @@ The v5.0.0 module requires using the [2.12 version](https://github.com/terraform
8890
2.3. [#148]
8991

9092
## [v2.0.0] - 2019-04-12
93+
v2.0.0 is a breaking release. Refer to the
94+
[Upgrading to v2.0 guide][upgrading-to-v2.0] for details.
9195

9296
### Added
9397

@@ -119,6 +123,10 @@ The v5.0.0 module requires using the [2.12 version](https://github.com/terraform
119123
* Fix empty zone list. [#132]
120124

121125
## [v1.0.0] - 2019-03-25
126+
Version 1.0.0 of this module introduces a breaking change: adding the `disable-legacy-endpoints` metadata field to all node pools. This metadata is required by GKE and [determines whether the `/0.1/` and `/v1beta1/` paths are available in the nodes' metadata server](https://cloud.google.com/kubernetes-engine/docs/how-to/protecting-cluster-metadata#disable-legacy-apis). If your applications do not require access to the node's metadata server, you can leave the default value of `true` provided by the module. If your applications require access to the metadata server, be sure to read the linked documentation to see if you need to set the value for this field to `false` to allow your applications access to the above metadata server paths.
127+
128+
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
129+
122130
### Added
123131
* Allow creation of service accounts. [#80]
124132
* Add support for private clusters via submodule. [#69]
@@ -251,3 +259,9 @@ The v5.0.0 module requires using the [2.12 version](https://github.com/terraform
251259
[#15]: https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/issues/15
252260
[#10]: https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/10
253261
[#9]: https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/pull/9
262+
263+
[upgrading-to-v2.0]: docs/upgrading_to_v2.0.md
264+
[upgrading-to-v3.0]: docs/upgrading_to_v3.0.md
265+
[terraform-provider-google]: https://github.com/terraform-providers/terraform-provider-google
266+
[3.0.0]: https://registry.terraform.io/modules/terraform-google-modules/kubernetes-engine/google/3.0.0
267+
[terraform-0.12-upgrade]: https://www.terraform.io/upgrade-guides/0-12.html

README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -108,22 +108,6 @@ Then perform the following commands on the root folder:
108108
- `terraform apply` to apply the infrastructure build
109109
- `terraform destroy` to destroy the built infrastructure
110110

111-
## Upgrade to v3.0.0
112-
113-
v3.0.0 is a breaking release. Refer to the
114-
[Upgrading to v3.0 guide][upgrading-to-v3.0] for details.
115-
116-
## Upgrade to v2.0.0
117-
118-
v2.0.0 is a breaking release. Refer to the
119-
[Upgrading to v2.0 guide][upgrading-to-v2.0] for details.
120-
121-
## Upgrade to v1.0.0
122-
123-
Version 1.0.0 of this module introduces a breaking change: adding the `disable-legacy-endpoints` metadata field to all node pools. This metadata is required by GKE and [determines whether the `/0.1/` and `/v1beta1/` paths are available in the nodes' metadata server](https://cloud.google.com/kubernetes-engine/docs/how-to/protecting-cluster-metadata#disable-legacy-apis). If your applications do not require access to the node's metadata server, you can leave the default value of `true` provided by the module. If your applications require access to the metadata server, be sure to read the linked documentation to see if you need to set the value for this field to `false` to allow your applications access to the above metadata server paths.
124-
125-
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
126-
127111
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
128112
## Inputs
129113

0 commit comments

Comments
 (0)