terraform-google-identity-group

A Terraform module to create and manage a Google Cloud Identity Group.

This module supports Terraform version 1 and is compatible with the Terraform Google Provider version 4. and 5._**

This module is part of our Infrastructure as Code (IaC) framework that enables our users and customers to easily deploy and manage reusable, secure, and production-grade cloud infrastructure.

• Module Features
• Getting Started
• Module Argument Reference
  • Main Resource Configuration
  • Module Configuration
• Module Outputs
• External Documentation
  • Google Documentation
  • Terraform GCP Provider Documentation
• Module Versioning
  • Backwards compatibility in 0.0.z and 0.y.z version
• About Mineiros
• Reporting Issues
• Contributing
• Makefile Targets
• License

Module Features

This module implements the following Terraform resources

• google_cloud_identity_group
• google_cloud_identity_group_membership

Getting Started

Most common usage of the module:

module "terraform-google-identity-group" {
  source = "[email protected]:mineiros-io/terraform-google-identity-group.git?ref=v0.1.0"

  group_key_id = "id-of-entity"
  parent       = "resource-name-of-entity"

  memberships = [
    {
      id    = "[email protected]"
      roles = ["MEMBER"]
    },
    {
      id    = "[email protected]"
      roles = ["MEMBER", "MANAGER"]
    },
    {
      id    = "[email protected]"
      roles = ["MEMBER", "OWNER"]
    }
  ]
}

NOTE: Google Groups are an organization level resource and can only be created and managed with Service Accounts or with a Principal that impersonates a single service account. The Service Account will require to be a Google Groups Admin to be able to create the Google Groups and manage the addition, removal of users/service accounts to and from the group. There are two different ways of enabaling a service account to work with the Google Groups API:

• Authenticating as a service account without domain-wide delegation (recommended)
• Authenticating as a service account with domain-wide delegation Granting a service account access to your organisation's data via domain-wide delegation should be used with caution. It can be reversed by disabling or deleting the service account or by removing access through the Google Workspace admin console.

Module Argument Reference

See variables.tf and examples/ for details and use-cases.

Main Resource Configuration

• group_key_id: (Required string)

  The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.

• parent: (Required string)

  The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.

• labels: (Optional map(string))

  The labels that apply to the Group.Must not contain more than one entry.Must contain the entry cloudidentity.googleapis.com/groups.discussion_forum: '' if the Group is a Google Group or system/groups/external: '' if the Group is an external-identity-mapped group.

  Default is {"cloudidentity.googleapis.com/groups.discussion_forum":""}.

• display_name: (Optional string)

  The display name of the Group.

• description: (Optional string)

  An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.

• initial_group_config: (Optional string)

  The initial configuration options for creating a Group. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.

  Default is "EMPTY".

• group_key_namespace: (Optional string)

  The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

• memberships: (Optional list(membership))

  A list of memberships (id, roles) to get attached to the group resource created.

  Default is [].

  Example:

  memberships = [
    {
      id = "[email protected]"
      roles = ["MEMBER", "MANAGER"]
    }
  ]

  Each membership object in the list accepts the following attributes:

  • id: (Required string)

    The id of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the identity source's requirements.

  • roles: (Optional list(string))

    A list of roles to bind to this Membership. Possible values are OWNER, MANAGER, and MEMBER. Note: The OWNER and MANAGER roles are supplementary roles that require the MEMBER role to be assigned.

    Default is ["MEMBER"].

Module Configuration

• module_enabled: (Optional bool)

  Specifies whether resources in the module will be created.

  Default is true.

• module_timeouts: (Optional map(timeout))

  A map of timeout objects that is keyed by Terraform resource name defining timeouts for create, update and delete Terraform operations. Supported resources are:

  • google_cloud_identity_group
  • google_cloud_identity_group_membership

  Example:

  module_timeouts = {
    google_cloud_identity_group = {
      create = "4m"
      update = "4m"
      delete = "4m"
    }
    google_cloud_identity_group_membership = {
      create = "4m"
      update = "4m"
      delete = "4m"
    }
  }

  Each timeout object in the map accepts the following attributes:

  • create: (Optional string)

    Timeout for create operations.

  • update: (Optional string)

    Timeout for update operations.

  • delete: (Optional string)

    Timeout for delete operations.

• module_depends_on: (Optional list(dependency))

  A list of dependencies. Any object can be assigned to this list to define a hidden external dependency.

  Default is [].

  Example:

  module_depends_on = [
    null_resource.name
  ]

Module Outputs

The following attributes are exported in the outputs of the module:

• group: (object(group))

  All attributes of the created google_cloud_identity_group resource.

• membership: (object(membership))

  All attributes of the created google_cloud_identity_group_membership resource.

• module_enabled: (bool)

  Whether this module is enabled.

External Documentation

Google Documentation

• Identity Overview - https://cloud.google.com/identity/
• Groups API Overview - https://cloud.google.com/identity/docs/groups

Terraform GCP Provider Documentation

• Identity Group - https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloud_identity_group
• Identity Group Membership - https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloud_identity_group_membership

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Given a version number MAJOR.MINOR.PATCH, we increment the:

1. MAJOR version when we make incompatible changes,
2. MINOR version when we add functionality in a backwards compatible manner, and
3. PATCH version when we make backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

• Backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
• Backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

About Mineiros

Mineiros is a remote-first company headquartered in Berlin, Germany that solves development, automation and security challenges in cloud infrastructure.

Our vision is to massively reduce time and overhead for teams to manage and deploy production-grade and secure cloud infrastructure.

We offer commercial support for all of our modules and encourage you to reach out if you have any questions or need help. Feel free to email us at [email protected] or join our Community Slack channel.

Reporting Issues

We use GitHub Issues to track community reported issues and missing features.

Contributing

Contributions are always encouraged and welcome! For the process of accepting changes, we use Pull Requests. If you'd like more information, please see our Contribution Guidelines.

Makefile Targets

This repository comes with a handy Makefile. Run make help to see details on each available target.

License

This module is licensed under the Apache License Version 2.0, January 2004. Please see LICENSE for full details.

Copyright © 2020-2022 Mineiros GmbH