Skip to content

Commit c0be695

Browse files
committed
Add reference to migration guide and regenerate
1 parent 185e6c4 commit c0be695

File tree

7 files changed

+45
-19
lines changed

7 files changed

+45
-19
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ 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 v2.0.0
93+
94+
v2.0.0 is a breaking release. Refer to the
95+
[Upgrading to v2.0 guide][upgrading-to-v2.0] for details.
96+
9297
## Upgrade to v1.0.0
9398

9499
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.
@@ -342,3 +347,5 @@ is a compiled language so there is no standard linter.
342347
* Terraform - terraform has a built-in linter in the 'terraform validate'
343348
command.
344349
* Dockerfiles - hadolint. Can be found in homebrew
350+
351+
[upgrading-to-v2.0]: docs/upgrading_to_v2.0.md

autogen/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,11 @@ Then perform the following commands on the root folder:
9999
- `terraform apply` to apply the infrastructure build
100100
- `terraform destroy` to destroy the built infrastructure
101101

102+
## Upgrade to v2.0.0
103+
104+
v2.0.0 is a breaking release. Refer to the
105+
[Upgrading to v2.0 guide][upgrading-to-v2.0] for details.
106+
102107
## Upgrade to v1.0.0
103108

104109
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.
@@ -290,3 +295,9 @@ is a compiled language so there is no standard linter.
290295
* Terraform - terraform has a built-in linter in the 'terraform validate'
291296
command.
292297
* Dockerfiles - hadolint. Can be found in homebrew
298+
299+
{% if private_cluster %}
300+
[upgrading-to-v2.0]: ../../docs/upgrading_to_v2.0.md
301+
{% else %}
302+
[upgrading-to-v2.0]: docs/upgrading_to_v2.0.md
303+
{% endif %}

modules/private-cluster/README.md

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

97+
## Upgrade to v2.0.0
98+
99+
v2.0.0 is a breaking release. Refer to the
100+
[Upgrading to v2.0 guide][upgrading-to-v2.0] for details.
101+
97102
## Upgrade to v1.0.0
98103

99104
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.
@@ -350,3 +355,5 @@ is a compiled language so there is no standard linter.
350355
* Terraform - terraform has a built-in linter in the 'terraform validate'
351356
command.
352357
* Dockerfiles - hadolint. Can be found in homebrew
358+
359+
[upgrading-to-v2.0]: ../../docs/upgrading_to_v2.0.md

modules/private-cluster/outputs.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,5 @@ output "node_pools_versions" {
110110

111111
output "service_account" {
112112
description = "The service account to default running nodes as if not overridden in `node_pools`."
113-
value = "${local.service_account}"
114-
}
113+
value = "${local.service_account}"
114+
}

modules/private-cluster/variables.tf

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ variable "disable_legacy_metadata_endpoints" {
129129
default = "true"
130130
}
131131

132+
132133
variable "node_pools" {
133134
type = "list"
134135
description = "List of maps containing node pools"
@@ -216,33 +217,32 @@ variable "service_account" {
216217
description = "The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account. May also specify `create` to automatically create a cluster-specific service account"
217218
default = ""
218219
}
219-
220220
variable "enable_private_endpoint" {
221-
description = "(Beta) Whether the master's internal IP address is used as the cluster endpoint"
222-
default = false
221+
description = "(Beta) Whether the master's internal IP address is used as the cluster endpoint"
222+
default = false
223223
}
224224

225225
variable "enable_private_nodes" {
226-
description = "(Beta) Whether nodes have internal IP addresses only"
227-
default = false
226+
description = "(Beta) Whether nodes have internal IP addresses only"
227+
default = false
228228
}
229229

230230
variable "master_ipv4_cidr_block" {
231-
description = "(Beta) The IP range in CIDR notation to use for the hosted master network"
232-
default = "10.0.0.0/28"
231+
description = "(Beta) The IP range in CIDR notation to use for the hosted master network"
232+
default = "10.0.0.0/28"
233233
}
234234

235235
variable "basic_auth_username" {
236236
description = "The username to be used with Basic Authentication. An empty value will disable Basic Authentication, which is the recommended configuration."
237-
default = ""
237+
default = ""
238238
}
239239

240240
variable "basic_auth_password" {
241241
description = "The password to be used with Basic Authentication."
242-
default = ""
242+
default = ""
243243
}
244244

245245
variable "issue_client_certificate" {
246246
description = "Issues a client certificate to authenticate to the cluster endpoint. To maximize the security of your cluster, leave this option disabled. Client certificates don't automatically rotate and aren't easily revocable. WARNING: changing this after cluster creation is destructive!"
247-
default = "false"
248-
}
247+
default = "false"
248+
}

outputs.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,5 @@ output "node_pools_versions" {
110110

111111
output "service_account" {
112112
description = "The service account to default running nodes as if not overridden in `node_pools`."
113-
value = "${local.service_account}"
114-
}
113+
value = "${local.service_account}"
114+
}

variables.tf

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ variable "disable_legacy_metadata_endpoints" {
129129
default = "true"
130130
}
131131

132+
132133
variable "node_pools" {
133134
type = "list"
134135
description = "List of maps containing node pools"
@@ -219,15 +220,15 @@ variable "service_account" {
219220

220221
variable "basic_auth_username" {
221222
description = "The username to be used with Basic Authentication. An empty value will disable Basic Authentication, which is the recommended configuration."
222-
default = ""
223+
default = ""
223224
}
224225

225226
variable "basic_auth_password" {
226227
description = "The password to be used with Basic Authentication."
227-
default = ""
228+
default = ""
228229
}
229230

230231
variable "issue_client_certificate" {
231232
description = "Issues a client certificate to authenticate to the cluster endpoint. To maximize the security of your cluster, leave this option disabled. Client certificates don't automatically rotate and aren't easily revocable. WARNING: changing this after cluster creation is destructive!"
232-
default = "false"
233-
}
233+
default = "false"
234+
}

0 commit comments

Comments
 (0)