Skip to content

Commit 58b5537

Browse files
Add upgrade guide to README
1 parent d214638 commit 58b5537

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ Then perform the following commands on the root folder:
8989
- `terraform apply` to apply the infrastructure build
9090
- `terraform destroy` to destroy the built infrastructure
9191

92+
## Upgrade to v1.0.0
93+
94+
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.
95+
96+
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
97+
9298
[^]: (autogen_docs_start)
9399

94100
## Inputs

autogen/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ Then perform the following commands on the root folder:
9595
- `terraform apply` to apply the infrastructure build
9696
- `terraform destroy` to destroy the built infrastructure
9797

98+
## Upgrade to v1.0.0
99+
100+
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.
101+
102+
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
103+
98104
[^]: (autogen_docs_start)
99105
[^]: (autogen_docs_end)
100106

modules/private-cluster/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,12 @@ Then perform the following commands on the root folder:
9292
- `terraform apply` to apply the infrastructure build
9393
- `terraform destroy` to destroy the built infrastructure
9494

95+
## Upgrade to v1.0.0
96+
97+
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.
98+
99+
In either case, upgrading to module version `v1.0.0` will trigger a recreation of all node pools in the cluster.
100+
95101
[^]: (autogen_docs_start)
96102

97103
## Inputs

0 commit comments

Comments
 (0)