README.md

Google Cloud Identity Group Factory

This module allows creation and management of Cloud Identity Groups by defining them in well formatted yaml files.

Yaml abstraction for Groups can simplify groups creation and members management. Yaml can be simpler and clearer comparing to HCL.

Example

Terraform code

module "groups" {
  source      = "./fabric/blueprints/factories/cloud-identity-group-factory"
  customer_id = "customers/C0xxxxxxx"
  data_dir    = "data"
}
# tftest modules=2 resources=3 files=group1 inventory=example.yaml

# tftest-file id=group1 path=data/[email protected]
display_name: Group 1
description: Group 1
members:
  - [email protected]
managers:
  - [email protected]

Configuration Structure

Groups configuration should be placed in a set of yaml files. The name of the file identify the name of the group.

├── data
    ├── [email protected]
    ├── [email protected]

Group definition format and structure

Within each file, the group entry structure is following:

display_name: Group 1 # Group display name.
description: Group 1 description # Group description.
members:  # List of group members.
  - [email protected]
  - [email protected]  
managers: # List of group managers.
  - [email protected]

Variables

name	description	type	required	default
customer_id	Directory customer ID in the form customers/C0xxxxxxx.	string	✓
data_dir	Relative path for the folder storing configuration data.	string	✓

Outputs

name	description	sensitive
group_id	Group name => Group ID mapping.