https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam

A Terraform module to manage Identity and Access Management (IAM) for Google Pub/Sub subscriptions in Google Cloud https://cloud.google.com/pubsub
https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam

iac mineiros terraform terraform-modules

Last synced: about 1 month ago
JSON representation

A Terraform module to manage Identity and Access Management (IAM) for Google Pub/Sub subscriptions in Google Cloud https://cloud.google.com/pubsub

Host: GitHub
URL: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam
Owner: mineiros-io
License: apache-2.0
Created: 2021-09-29T12:01:07.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-02-23T11:19:22.000Z (about 1 year ago)
Last Synced: 2025-01-26T09:43:06.382Z (3 months ago)
Topics: iac, mineiros, terraform, terraform-modules
Language: HCL
Homepage:
Size: 138 KB
Stars: 1
Watchers: 7
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        [](https://mineiros.io/?ref=terraform-google-pubsub-subscription-iam)

[![Build Status](https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/workflows/Tests/badge.svg)](https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/actions)

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/mineiros-io/terraform-google-pubsub-subscription-iam.svg?label=latest&sort=semver)](https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/releases)

[![Terraform Version](https://img.shields.io/badge/Terraform-1.x-623CE4.svg?logo=terraform)](https://github.com/hashicorp/terraform/releases)

[![Google Provider Version](https://img.shields.io/badge/google-4-1A73E8.svg?logo=terraform)](https://github.com/terraform-providers/terraform-provider-google/releases)

[![Join Slack](https://img.shields.io/badge/[email protected]?logo=slack)](https://mineiros.io/slack)

# terraform-google-pubsub-subscription-iam

A [Terraform](https://www.terraform.io) module to create a [Google Pubsub Subscription IAM](https://cloud.google.com/pubsub/docs/access-control) on [Google Cloud Services (GCP)](https://cloud.google.com/).

**_This module supports Terraform version 1

and is compatible with the Terraform Google Provider version 3.5_**, 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](#module-features)

- [Getting Started](#getting-started)

- [Module Argument Reference](#module-argument-reference)

  - [Top-level Arguments](#top-level-arguments)

    - [Module Configuration](#module-configuration)

    - [Main Resource Configuration](#main-resource-configuration)

- [Module Outputs](#module-outputs)

- [External Documentation](#external-documentation)

  - [Google Documentation](#google-documentation)

  - [Terraform Google Provider Documentation:](#terraform-google-provider-documentation)

- [Module Versioning](#module-versioning)

  - [Backwards compatibility in `0.0.z` and `0.y.z` version](#backwards-compatibility-in-00z-and-0yz-version)

- [About Mineiros](#about-mineiros)

- [Reporting Issues](#reporting-issues)

- [Contributing](#contributing)

- [Makefile Targets](#makefile-targets)

- [License](#license)

## Module Features

This module implements the following terraform resources:

- `google_pubsub_subscription_iam_binding`

- `google_pubsub_subscription_iam_member`

- `google_pubsub_subscription_iam_policy`

## Getting Started

Most basic usage just setting required arguments:

```hcl

module "terraform-google-pubsub-subscription-iam" {

  source = "github.com/mineiros-io/terraform-google-pubsub-subscription-iam?ref=v0.0.4"

  subscription = "example-subscription"

  role         = "roles/editor"

  members      = ["user:[email protected]"]

}

```

## Module Argument Reference

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

### Top-level Arguments

#### Module Configuration

- [**`module_enabled`**](#var-module_enabled): *(Optional `bool`)*

  Specifies whether resources in the module will be created.

  Default is `true`.

- [**`module_depends_on`**](#var-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:

  ```hcl

  module_depends_on = [

    google_network.network

  ]

  ```

#### Main Resource Configuration

- [**`subscription`**](#var-subscription): *(**Required** `string`)*

  The subscription to apply the IAM role to.

- [**`members`**](#var-members): *(Optional `set(string)`)*

  Identities that will be granted the privilege in role. Each entry can have one of the following values:

  - `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

  - `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

  - `user:{emailid}`: An email address that represents a specific Google account. For example, [email protected] or [email protected].

  - `serviceAccount:{emailid}`: An email address that represents a service account. For example, [email protected].

  - `group:{emailid}`: An email address that represents a Google group. For example, [email protected].

  - `domain:{domain}`: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.

  - `computed:{identifier}`:

    An existing key from var.computed_members_map.

  Default is `[]`.

- [**`computed_members_map`**](#var-computed_members_map): *(Optional `map(string)`)*

  A map of identifiers to identities to be replaced in 'var.members' or in members of `policy_bindings` to handle terraform computed values.

  The format of each value must satisfy the format as described in `var.members`.

  Default is `{}`.

- [**`role`**](#var-role): *(Optional `string`)*

  The role that should be applied. Note that custom roles must be of the format `[projects|organizations]/{parent-name}/roles/{role-name}`.

- [**`project`**](#var-project): *(Optional `string`)*

  The project in which the resource belongs. If it is not provided, the provider project is used.

- [**`authoritative`**](#var-authoritative): *(Optional `bool`)*

  Whether to exclusively set (authoritative mode) or add (non-authoritative/additive mode) members to the role.

  Default is `true`.

- [**`policy_bindings`**](#var-policy_bindings): *(Optional `list(policy_binding)`)*

  A list of IAM policy bindings.

  Example:

  ```hcl

  policy_bindings = [{

    role    = "roles/viewer"

    members = ["user:[email protected]"]

  }]

  ```

  Each `policy_binding` object in the list accepts the following attributes:

  - [**`role`**](#attr-policy_bindings-role): *(**Required** `string`)*

    The role that should be applied.

  - [**`members`**](#attr-policy_bindings-members): *(Optional `set(string)`)*

    Identities that will be granted the privilege in `role`.

    Default is `var.members`.

  - [**`condition`**](#attr-policy_bindings-condition): *(Optional `object(condition)`)*

    An IAM Condition for a given binding.

    Example:

    ```hcl

    condition = {

      expression = "request.time < timestamp(\"2022-01-01T00:00:00Z\")"

      title      = "expires_after_2021_12_31"

    }

    ```

    The `condition` object accepts the following attributes:

    - [**`expression`**](#attr-policy_bindings-condition-expression): *(**Required** `string`)*

      Textual representation of an expression in Common Expression Language syntax.

    - [**`title`**](#attr-policy_bindings-condition-title): *(**Required** `string`)*

      A title for the expression, i.e. a short string describing its purpose.

    - [**`description`**](#attr-policy_bindings-condition-description): *(Optional `string`)*

      An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

## Module Outputs

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

- [**`iam`**](#output-iam): *(`object(iam)`)*

  All attributes of the created `iam_binding` or `iam_member` or

  `iam_policy` resource according to the mode.

## External Documentation

### Google Documentation

- https://cloud.google.com/pubsub/docs/access-control

### Terraform Google Provider Documentation:

- https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/pubsub_subscription_iam

## 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][homepage] 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][slack].

## 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

[![license][badge-license]][apache20]

This module is licensed under the Apache License Version 2.0, January 2004.

Please see [LICENSE] for full details.

Copyright © 2020-2022 [Mineiros GmbH][homepage]

[homepage]: https://mineiros.io/?ref=terraform-google-pubsub-subscription-iam

[[email protected]]: mailto:[email protected]

[badge-build]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/workflows/Tests/badge.svg

[badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-google-pubsub-subscription-iam.svg?label=latest&sort=semver

[badge-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg

[badge-terraform]: https://img.shields.io/badge/Terraform-1.x-623CE4.svg?logo=terraform

[badge-slack]: https://img.shields.io/badge/[email protected]?logo=slack

[build-status]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/actions

[releases-github]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/releases

[releases-terraform]: https://github.com/hashicorp/terraform/releases

[badge-tf-gcp]: https://img.shields.io/badge/google-3.x-1A73E8.svg?logo=terraform

[releases-google-provider]: https://github.com/terraform-providers/terraform-provider-google/releases

[apache20]: https://opensource.org/licenses/Apache-2.0

[slack]: https://mineiros.io/slack

[terraform]: https://www.terraform.io

[gcp]: https://cloud.google.com/

[semantic versioning (semver)]: https://semver.org/

[variables.tf]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/blob/main/variables.tf

[examples/]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/blob/main/examples

[issues]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/issues

[license]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/blob/main/LICENSE

[makefile]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/blob/main/Makefile

[pull requests]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/pulls

[contribution guidelines]: https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam/blob/main/CONTRIBUTING.md

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/mineiros-io/terraform-google-pubsub-subscription-iam

Awesome Lists containing this project

README