Skip to content

Commit b7b0769

Browse files
coryodanielaaron-lane
authored andcommitted
Added upgrade guide v1.0
* Set basic auth to disabled by default
1 parent 78f44d2 commit b7b0769

File tree

3 files changed

+37
-2
lines changed

3 files changed

+37
-2
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ Extending the adopted spec, each change should have a link to its corresponding
4444
* Added `disable_legacy_metadata_endpoints` parameter. [#114]
4545

4646
### Changed
47-
* Set `horizontal_pod_autoscaling` to `true` by default. Fixes [#42]. [#54]
47+
48+
* Set `horizontal_pod_autoscaling` to `true` by default.
49+
Fixes [#42]. [#54]
4850
* Update simple-zonal example GKE version to supported version. [#49]
4951
* Drop explicit version from simple_zonal example. [#74]
5052
* Remove explicit versions from test cases and examples. [#62]

docs/upgrading_to_v1.0.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Upgrading to terraform-google-kubernetes-engine v1.0
2+
3+
The v1.0 release of terraform-google-kubernetes-engine is a backwards incompatible release.
4+
5+
## Migration Instructions
6+
7+
### Re-enabling Kubernetes Basic Authentication
8+
9+
Starting with version 1.12, clusters will have basic authentication and client certificate issuance disabled by default in GKE. In previous versions of *terraform-google-kubernetes-engine* basic auth was silently enabled. It is now disabled by default.
10+
11+
**Re-enabling Kubernetes basic authentication:**
12+
13+
**Note:** enabling basic auth will cause terraform to store your basic auth credentials in state file. It is important to use a backend that supports encryption at rest. [Read more](https://www.terraform.io/docs/state/sensitive-data.html)
14+
15+
```hcl
16+
module "enabling-basic-auth" {
17+
source = "terraform-google-modules/kubernetes-engine/google"
18+
project_id = "${var.project_id}"
19+
name = "cluster-with-basic-auth"
20+
21+
enable_basic_auth = "true"
22+
basic_auth_username = "admin"
23+
basic_auth_password = "s3crets!"
24+
25+
regional = "true"
26+
region = "${var.region}"
27+
network = "${var.network}"
28+
subnetwork = "${var.subnetwork}"
29+
ip_range_pods = "${var.ip_range_pods}"
30+
ip_range_services = "${var.ip_range_services}"
31+
service_account = "${var.compute_engine_service_account}"
32+
}
33+
```

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ variable "service_account" {
219219

220220
variable "enable_basic_auth" {
221221
description = "Basic authentication allows a user to authenticate to the cluster with a username and password. To maximize the security of your cluster, disable this option. Basic authentication is not recommended because it provides no confidentiality protection for transmitted credentials"
222-
default = "true"
222+
default = "false"
223223
}
224224

225225
variable "basic_auth_username" {

0 commit comments

Comments
 (0)