This module helps create several folders under the same parent, enforcing consistent permissions, and with a common naming convention.

The resources/services/activations/deletions that this module will create/trigger are:

• Create folders with the provided names
• Assign the defined permissions to the provided list of users or groups.

This module is meant for use with Terraform 0.13+ and tested using Terraform 1.0+. If you find incompatibilities using Terraform >=0.13, please open an issue. If you haven't upgraded and need a Terraform 0.12.x-compatible version of this module, the last released version intended for Terraform 0.12.x is 2.0.2.

Basic usage of this module is as follows:

module "folders" {
  source  = "terraform-google-modules/folders/google"
  version = "~> 5.0"

  parent  = "folders/65552901371"

  names = [
    "dev",
    "staging",
    "production",
  ]

  set_roles = true

  per_folder_admins = {
    dev = {
      members = [
        "group:gcp-developers@domain.com"
      ],
    },
    staging = {
      members = [
        "group:gcp-qa@domain.com"
      ],
    }
    production = {
      members = [
        "group:gcp-ops@domain.com"
      ],
    }
  }

  all_folder_admins = [
    "group:gcp-security@domain.com",
  ]
}

Functional examples are included in the examples directory.

[
  "roles/owner",
  "roles/resourcemanager.folderViewer",
  "roles/resourcemanager.projectCreator",
  "roles/compute.networkAdmin"
]

map(object({
    members = list(string)
    roles   = optional(list(string))
  }))

These sections describe requirements for using this module.

The following dependencies must be available:

• Terraform v1.3+
• Terraform Provider for GCP plugin v6

A service account with the following roles must be used to provision the resources of this module:

• Folder Creator: roles/resourcemanager.folderCreator

The Project Factory module and the IAM module may be used in combination to provision a service account with the necessary roles applied.

A project with the following APIs enabled must be used to host the resources of this module:

• Cloud Resource Manager API: cloudresourcemanager.googleapis.com

The Project Factory module can be used to provision a project with the necessary APIs enabled.

Refer to the contribution guidelines for information on contributing to this module.