Skip to content

A Terraform module for creating Google Cloud Secret Manager ID's and/or secret payload.

License

Notifications You must be signed in to change notification settings

Ferrish07/Google-Cloud-Secret-Manager-Terraform-module

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Secret Manager for Terraform

NOTE: This module is for Terraform 0.13 and newer.

This module provides an opinionated wrapper around creating and managing secret values in GCP Secret Manager with Terraform 0.13 and newer.

This has been "borrowed" from Google's Terraform module and I've just simplified it a bit.

Given a project identifier, the module will create a new secret, or update an existing secret version, so that it contains the value provided. An optional list of IAM user, group, or service account identifiers can be provided and each of the identifiers will be granted roles/secretmanager.secretAccessor.

NOTE: This module can create the Secret Manager payload could be a security risk! The secret payload will be stored in the Terraform state. Please ensure you have the correct security and IAM in place for any remote or local Terraform state.

This module can be refactored to not include the secret payload and just create the Google Cloud Secret Manager ID.

module "secret" {
  source     = "./secret_manager"
  project    = "my-project-id"
  id         = "my-secret"
  secret     = "T0pS3cret!"
  accessors  = ["group:team@example.com"]
}

Omitting the var.secret will use the random_password resource to create a secret with a generated value.

module "secret" {
  source     = "./secret_manager"
  project             = "my-project-id"
  id                  = "my-secret"
  length              = 12
  min_lower_chars     = 5
  min_upper_chars     = 4
  min_numeric_chars   = 2
  min_special_chars   = 1
  accessors  = ["group:team@example.com", "serviceAccount:service-account@project.iam.gserviceaccount.com"]
}

Resources

Name Type
google_secret_manager_secret.secret resource
google_secret_manager_secret_iam_member.secret resource
google_secret_manager_secret_version.secret resource

Inputs

Name Description Type Default Required
accessors An optional list of IAM account identifiers that will be granted accessor (read-only)
permission to the secret.
list(string) [] no
secret_id The secret identifier to create; this value must be unique within the project. string n/a yes
labels An optional map of label key:value pairs to assign to the secret resources.
Default is an empty map.
map(string) {} no
project The GCP project identifier where the secret will be created. string n/a yes
replication_locations An optional list of replication locations for the secret. If the value is an
empty list (default) then an automatic replication policy will be applied. Use
this if you must have replication constrained to specific locations.

E.g. to use automatic replication policy (default)
replication_locations = []

E.g. to force secrets to be replicated only in us-east1 and us-west1 regions:
replication_locations = [ "us-east1", "us-west1" ]
list(string) [] no
secret The secret payload to store in Secret Manager. Binary values should be base64
encoded before use.
string n/a yes
length The length of the random string to generate for secret value. Default is 16. number n/a no
has_lower_chars Include lowercase characters in the generated secret. bool n/a no
min_lower_chars The minimum number of lowercase characters to include in the generated secret. number n/a no
has_upper_chars Include uppercase characters in the generated secret. bool n/a no
min_upper_chars The minimum number of uppercase characters to include in the generated secret. number n/a no
has_numeric_chars Include numeric characters in the generated secret. bool n/a no
min_numeric_chars The minimum number of numeric characters to include in the generated secret. number n/a no
has_special_chars Include special characters in the generated secret. bool n/a no
min_special_chars The minimum number of specialß characters to include in the generated secret. number n/a no

Outputs

Name Description
id The fully-qualified id of the Secret Manager key that contains the secret.
secret_id The project-local id Secret Manager key that contains the secret. Should match
the input id.

About

A Terraform module for creating Google Cloud Secret Manager ID's and/or secret payload.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages