Simple Cloud KMS module that allows managing a keyring, zero or more keys in the keyring, and IAM role bindings on individual keys.
The resources/services/activations/deletions that this module will create/trigger are:
- Create a KMS keyring in the provided project
- Create zero or more keys in the keyring
- Create IAM role bindings for owners, encrypters, decrypters
This module is meant for use with Terraform 0.12. If you haven't upgraded and need a Terraform 0.11.x-compatible version of this module, the last released version intended for Terraform 0.11.x is v0.1.0.
Basic usage of this module is as follows:
module "kms" {
source = "terraform-google-modules/kms/google"
version = "~> 1.2"
project_id = "<PROJECT ID>"
location = "europe"
keyring = "sample-keyring"
keys = ["foo", "spam"]
set_owners_for = ["foo", "spam"]
owners = [
"group:[email protected],group:[email protected]",
"group:[email protected]",
]
}Functional examples are included in the examples directory.
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| decrypters | List of comma-separated owners for each key declared in set_decrypters_for. | list(string) | <list> |
no |
| encrypters | List of comma-separated owners for each key declared in set_encrypters_for. | list(string) | <list> |
no |
| key_algorithm | The algorithm to use when creating a version based on this template. See the https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm for possible inputs. | string | "GOOGLE_SYMMETRIC_ENCRYPTION" |
no |
| key_protection_level | The protection level to use when creating a version based on this template. Default value: "SOFTWARE" Possible values: ["SOFTWARE", "HSM"] | string | "SOFTWARE" |
no |
| key_rotation_period | string | "100000s" |
no | |
| keyring | Keyring name. | string | n/a | yes |
| keys | Key names. | list(string) | <list> |
no |
| labels | Labels, provided as a map | map(string) | <map> |
no |
| location | Location for the keyring. | string | n/a | yes |
| owners | List of comma-separated owners for each key declared in set_owners_for. | list(string) | <list> |
no |
| prevent_destroy | Set the prevent_destroy lifecycle attribute on keys. | string | "true" |
no |
| project_id | Project id where the keyring will be created. | string | n/a | yes |
| set_decrypters_for | Name of keys for which decrypters will be set. | list(string) | <list> |
no |
| set_encrypters_for | Name of keys for which encrypters will be set. | list(string) | <list> |
no |
| set_owners_for | Name of keys for which owners will be set. | list(string) | <list> |
no |
| Name | Description |
|---|---|
| keyring | Self link of the keyring. |
| keyring_name | Name of the keyring. |
| keyring_resource | Keyring resource. |
| keys | Map of key name => key self link. |
These sections describe requirements for using this module.
The following dependencies must be available:
- Terraform v0.12
- Terraform Provider for GCP plugin v3.0
A service account with one of the following roles must be used to provision the resources of this module:
- Cloud KMS Admin:
roles/cloudkms.adminor - Owner:
roles/owner
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:
- Google Cloud Key Management Service:
cloudkms.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.