Skip to content

Commit

Permalink
Merge pull request #80 from terraform-google-modules/feature/allow-cr…
Browse files Browse the repository at this point in the history
…eation-of-service-accounts

Allow creation of service accounts
  • Loading branch information
morgante committed Feb 20, 2019
2 parents 6189fef + 567e29a commit 8205618
Show file tree
Hide file tree
Showing 20 changed files with 191 additions and 34 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Then perform the following commands on the root folder:
| region | The region to host the cluster in (required) | string | - | yes |
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no |
| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account | string | `` | no |
| service_account | 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 | string | `` | no |
| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `<map>` | no |
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
Expand Down Expand Up @@ -179,6 +179,7 @@ following project roles:
- roles/compute.viewer
- roles/container.clusterAdmin
- roles/container.developer
- roles/iam.serviceAccountAdmin
- roles/iam.serviceAccountUser

### Enable APIs
Expand Down
3 changes: 2 additions & 1 deletion autogen/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terraform Kubernetes Engine Module

This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc. {% if private_cluster %}This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters){% endif %}
This module handles opinionated Google Cloud Platform Kubernetes Engine cluster creation and configuration with Node Pools, IP MASQ, Network Policy, etc.{% if private_cluster %} This particular submodule creates a [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters){% endif %}

The resources/services/activations/deletions that this module will create/trigger are:
- Create a GKE cluster with the provided addons
Expand Down Expand Up @@ -189,6 +189,7 @@ following project roles:
- roles/compute.viewer
- roles/container.clusterAdmin
- roles/container.developer
- roles/iam.serviceAccountAdmin
- roles/iam.serviceAccountUser

### Enable APIs
Expand Down
4 changes: 2 additions & 2 deletions autogen/cluster_regional.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "google_container_cluster" "primary" {
name = "default-pool"

node_config {
service_account = "${lookup(var.node_pools[0], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[0], "service_account", local.service_account)}"
}
}
{% if private_cluster %}
Expand Down Expand Up @@ -127,7 +127,7 @@ resource "google_container_node_pool" "pools" {

disk_size_gb = "${lookup(var.node_pools[count.index], "disk_size_gb", 100)}"
disk_type = "${lookup(var.node_pools[count.index], "disk_type", "pd-standard")}"
service_account = "${lookup(var.node_pools[count.index], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[count.index], "service_account", local.service_account)}"
preemptible = "${lookup(var.node_pools[count.index], "preemptible", false)}"

oauth_scopes = [
Expand Down
4 changes: 2 additions & 2 deletions autogen/cluster_zonal.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "google_container_cluster" "zonal_primary" {
name = "default-pool"

node_config {
service_account = "${lookup(var.node_pools[0], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[0], "service_account", local.service_account)}"
}
}
{% if private_cluster %}
Expand Down Expand Up @@ -127,7 +127,7 @@ resource "google_container_node_pool" "zonal_pools" {

disk_size_gb = "${lookup(var.node_pools[count.index], "disk_size_gb", 100)}"
disk_type = "${lookup(var.node_pools[count.index], "disk_type", "pd-standard")}"
service_account = "${lookup(var.node_pools[count.index], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[count.index], "service_account", local.service_account)}"
preemptible = "${lookup(var.node_pools[count.index], "preemptible", false)}"

oauth_scopes = [
Expand Down
50 changes: 50 additions & 0 deletions autogen/sa.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

{{ autogeneration_note }}

locals {
service_account_list = "${compact(concat(google_service_account.cluster_service_account.*.email, list("dummy")))}"
service_account = "${var.service_account == "create" ? element(local.service_account_list, 0) : var.service_account}"
}

resource "google_service_account" "cluster_service_account" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${var.project_id}"
account_id = "tf-gke-${substr(var.name, 0, 20)}"
display_name = "Terraform-managed service account for cluster ${var.name}"
}

resource "google_project_iam_member" "cluster_service_account-log_writer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_service_account.cluster_service_account.project}"
role = "roles/logging.logWriter"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}

resource "google_project_iam_member" "cluster_service_account-metric_writer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_project_iam_member.cluster_service_account-log_writer.project}"
role = "roles/monitoring.metricWriter"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}

resource "google_project_iam_member" "cluster_service_account-monitoring_viewer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_project_iam_member.cluster_service_account-metric_writer.project}"
role = "roles/monitoring.viewer"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}
2 changes: 1 addition & 1 deletion autogen/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ variable "monitoring_service" {
}

variable "service_account" {
description = "The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account"
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"
default = ""
}
{% if private_cluster %}
Expand Down
4 changes: 2 additions & 2 deletions cluster_regional.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "google_container_cluster" "primary" {
name = "default-pool"

node_config {
service_account = "${lookup(var.node_pools[0], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[0], "service_account", local.service_account)}"
}
}

Expand Down Expand Up @@ -121,7 +121,7 @@ resource "google_container_node_pool" "pools" {

disk_size_gb = "${lookup(var.node_pools[count.index], "disk_size_gb", 100)}"
disk_type = "${lookup(var.node_pools[count.index], "disk_type", "pd-standard")}"
service_account = "${lookup(var.node_pools[count.index], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[count.index], "service_account", local.service_account)}"
preemptible = "${lookup(var.node_pools[count.index], "preemptible", false)}"

oauth_scopes = [
Expand Down
4 changes: 2 additions & 2 deletions cluster_zonal.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "google_container_cluster" "zonal_primary" {
name = "default-pool"

node_config {
service_account = "${lookup(var.node_pools[0], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[0], "service_account", local.service_account)}"
}
}

Expand Down Expand Up @@ -121,7 +121,7 @@ resource "google_container_node_pool" "zonal_pools" {

disk_size_gb = "${lookup(var.node_pools[count.index], "disk_size_gb", 100)}"
disk_type = "${lookup(var.node_pools[count.index], "disk_type", "pd-standard")}"
service_account = "${lookup(var.node_pools[count.index], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[count.index], "service_account", local.service_account)}"
preemptible = "${lookup(var.node_pools[count.index], "preemptible", false)}"

oauth_scopes = [
Expand Down
1 change: 0 additions & 1 deletion examples/simple_zonal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ This example illustrates how to create a simple cluster.
| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| cluster_name_suffix | A suffix to append to the default cluster name | string | `` | no |
| compute_engine_service_account | Service account to associate to the nodes in the cluster | string | - | yes |
| credentials_path | The path to the GCP credentials JSON file | string | - | yes |
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
Expand Down
2 changes: 1 addition & 1 deletion examples/simple_zonal/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module "gke" {
subnetwork = "${var.subnetwork}"
ip_range_pods = "${var.ip_range_pods}"
ip_range_services = "${var.ip_range_services}"
service_account = "${var.compute_engine_service_account}"
service_account = "create"
}

data "google_client_config" "default" {}
4 changes: 0 additions & 4 deletions examples/simple_zonal/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,3 @@ variable "ip_range_pods" {
variable "ip_range_services" {
description = "The secondary ip range to use for pods"
}

variable "compute_engine_service_account" {
description = "Service account to associate to the nodes in the cluster"
}
3 changes: 2 additions & 1 deletion modules/private-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Then perform the following commands on the root folder:
| region | The region to host the cluster in (required) | string | - | yes |
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
| remove_default_node_pool | Remove default node pool while setting up the cluster | string | `false` | no |
| service_account | The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account | string | `` | no |
| service_account | 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 | string | `` | no |
| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `<map>` | no |
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
Expand Down Expand Up @@ -185,6 +185,7 @@ following project roles:
- roles/compute.viewer
- roles/container.clusterAdmin
- roles/container.developer
- roles/iam.serviceAccountAdmin
- roles/iam.serviceAccountUser

### Enable APIs
Expand Down
4 changes: 2 additions & 2 deletions modules/private-cluster/cluster_regional.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "google_container_cluster" "primary" {
name = "default-pool"

node_config {
service_account = "${lookup(var.node_pools[0], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[0], "service_account", local.service_account)}"
}
}

Expand Down Expand Up @@ -127,7 +127,7 @@ resource "google_container_node_pool" "pools" {

disk_size_gb = "${lookup(var.node_pools[count.index], "disk_size_gb", 100)}"
disk_type = "${lookup(var.node_pools[count.index], "disk_type", "pd-standard")}"
service_account = "${lookup(var.node_pools[count.index], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[count.index], "service_account", local.service_account)}"
preemptible = "${lookup(var.node_pools[count.index], "preemptible", false)}"

oauth_scopes = [
Expand Down
4 changes: 2 additions & 2 deletions modules/private-cluster/cluster_zonal.tf
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ resource "google_container_cluster" "zonal_primary" {
name = "default-pool"

node_config {
service_account = "${lookup(var.node_pools[0], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[0], "service_account", local.service_account)}"
}
}

Expand Down Expand Up @@ -127,7 +127,7 @@ resource "google_container_node_pool" "zonal_pools" {

disk_size_gb = "${lookup(var.node_pools[count.index], "disk_size_gb", 100)}"
disk_type = "${lookup(var.node_pools[count.index], "disk_type", "pd-standard")}"
service_account = "${lookup(var.node_pools[count.index], "service_account", var.service_account)}"
service_account = "${lookup(var.node_pools[count.index], "service_account", local.service_account)}"
preemptible = "${lookup(var.node_pools[count.index], "preemptible", false)}"

oauth_scopes = [
Expand Down
50 changes: 50 additions & 0 deletions modules/private-cluster/sa.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// This file was automatically generated from a template in ./autogen

locals {
service_account_list = "${compact(concat(google_service_account.cluster_service_account.*.email, list("dummy")))}"
service_account = "${var.service_account == "create" ? element(local.service_account_list, 0) : var.service_account}"
}

resource "google_service_account" "cluster_service_account" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${var.project_id}"
account_id = "tf-gke-${substr(var.name, 0, 20)}"
display_name = "Terraform-managed service account for cluster ${var.name}"
}

resource "google_project_iam_member" "cluster_service_account-log_writer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_service_account.cluster_service_account.project}"
role = "roles/logging.logWriter"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}

resource "google_project_iam_member" "cluster_service_account-metric_writer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_project_iam_member.cluster_service_account-log_writer.project}"
role = "roles/monitoring.metricWriter"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}

resource "google_project_iam_member" "cluster_service_account-monitoring_viewer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_project_iam_member.cluster_service_account-metric_writer.project}"
role = "roles/monitoring.viewer"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}
2 changes: 1 addition & 1 deletion modules/private-cluster/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ variable "monitoring_service" {
}

variable "service_account" {
description = "The service account to default running nodes as if not overridden in `node_pools`. Defaults to the compute engine default service account"
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"
default = ""
}

Expand Down
50 changes: 50 additions & 0 deletions sa.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// This file was automatically generated from a template in ./autogen

locals {
service_account_list = "${compact(concat(google_service_account.cluster_service_account.*.email, list("dummy")))}"
service_account = "${var.service_account == "create" ? element(local.service_account_list, 0) : var.service_account}"
}

resource "google_service_account" "cluster_service_account" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${var.project_id}"
account_id = "tf-gke-${substr(var.name, 0, 20)}"
display_name = "Terraform-managed service account for cluster ${var.name}"
}

resource "google_project_iam_member" "cluster_service_account-log_writer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_service_account.cluster_service_account.project}"
role = "roles/logging.logWriter"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}

resource "google_project_iam_member" "cluster_service_account-metric_writer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_project_iam_member.cluster_service_account-log_writer.project}"
role = "roles/monitoring.metricWriter"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}

resource "google_project_iam_member" "cluster_service_account-monitoring_viewer" {
count = "${var.service_account == "create" ? 1 : 0}"
project = "${google_project_iam_member.cluster_service_account-metric_writer.project}"
role = "roles/monitoring.viewer"
member = "serviceAccount:${google_service_account.cluster_service_account.email}"
}
19 changes: 9 additions & 10 deletions test/fixtures/simple_zonal/example.tf
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,13 @@
module "example" {
source = "../../../examples/simple_zonal"

project_id = "${var.project_id}"
credentials_path = "${local.credentials_path}"
cluster_name_suffix = "-${random_string.suffix.result}"
region = "${var.region}"
zones = ["${slice(var.zones,0,1)}"]
network = "${google_compute_network.main.name}"
subnetwork = "${google_compute_subnetwork.main.name}"
ip_range_pods = "${google_compute_subnetwork.main.secondary_ip_range.0.range_name}"
ip_range_services = "${google_compute_subnetwork.main.secondary_ip_range.1.range_name}"
compute_engine_service_account = "${var.compute_engine_service_account}"
project_id = "${var.project_id}"
credentials_path = "${local.credentials_path}"
cluster_name_suffix = "-${random_string.suffix.result}"
region = "${var.region}"
zones = ["${slice(var.zones,0,1)}"]
network = "${google_compute_network.main.name}"
subnetwork = "${google_compute_subnetwork.main.name}"
ip_range_pods = "${google_compute_subnetwork.main.secondary_ip_range.0.range_name}"
ip_range_services = "${google_compute_subnetwork.main.secondary_ip_range.1.range_name}"
}
10 changes: 10 additions & 0 deletions test/integration/simple_zonal/controls/gcloud.rb
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,16 @@
describe "node pool" do
let(:node_pools) { data['nodePools'].reject { |p| p['name'] == "default-pool" } }

it "uses an automatically created service account" do
expect(node_pools).to include(
including(
"config" => including(
"serviceAccount" => starting_with("tf-gke-simple-zonal-cluster@"),
),
),
)
end

it "has autoscaling enabled" do
expect(node_pools).to include(
including(
Expand Down
Loading

0 comments on commit 8205618

Please sign in to comment.