terraform-google-project-iam-custom-role

A Terraform module to create a Google Project IAM custom role on Google Cloud Services (GCP).

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

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
  • Top-level Arguments
    • Module Configuration
    • Main Resource Configuration
• Module Outputs
• External Documentation
  • Google Documentation:
  • Terraform Google 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

A Terraform base module for creating a google_project_iam_custom_role resources that allows management of a customized Cloud IAM project role.

Getting Started

Most basic usage just setting required arguments:

module "terraform-google-project-iam-custom-role" {
  source = "github.com/mineiros-io/terraform-google-project-iam-custom-role.git?ref=v0.0.2"

  role_id     = "myCustomRole"
  title       = "My Custom Role"
  description = "A description"
  permissions = ["iam.roles.list", "iam.roles.create", "iam.roles.delete"]
}

Module Argument Reference

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

Top-level Arguments

Module Configuration

• module_enabled: (Optional bool)

  Specifies whether resources in the module will be created.

  Default is true.

• module_depends_on: (Optional list(dependency))

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

  Example:

  module_depends_on = [
    google_network.network
  ]

Main Resource Configuration

• role_id: (Required string)

  The camelCaseRoleId to use for this role. Cannot contain - characters.

• title: (Required string)

  A human-readable title for the role.

• permissions: (Required set(string))

  The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.

• stage: (Optional string)

  The current launch stage of the role. For more stages visit this link https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles#Role.RoleLaunchStage.

  Default is "GA".

• description: (Optional string)

  A human-readable description for the role.

Module Outputs

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

• module_enabled: (bool)

  Whether this module is enabled.

• google_project_iam_custom_role: (object(google_project_iam_custom_role))

  A map of outputs of the created google_project_iam_custom_role resource.

External Documentation

Google Documentation:

• Project IAM Custom Roles: https://cloud.google.com/iam/docs/understanding-custom-roles

Terraform Google Provider Documentation:

• https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_project_iam_custom_role

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 hello@mineiros.io 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