https://github.com/mineiros-io/terraform-google-service-account
A Terraform module to deploy and manage service accounts in Google Cloud https://cloud.google.com/iam/docs/service-accounts
https://github.com/mineiros-io/terraform-google-service-account
iac mineiros terraform terraform-modules
Last synced: 12 days ago
JSON representation
A Terraform module to deploy and manage service accounts in Google Cloud https://cloud.google.com/iam/docs/service-accounts
- Host: GitHub
- URL: https://github.com/mineiros-io/terraform-google-service-account
- Owner: mineiros-io
- License: apache-2.0
- Created: 2021-09-29T12:00:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-20T14:50:41.000Z (about 1 year ago)
- Last Synced: 2025-03-27T22:22:31.318Z (30 days ago)
- Topics: iac, mineiros, terraform, terraform-modules
- Language: HCL
- Homepage:
- Size: 218 KB
- Stars: 1
- Watchers: 6
- Forks: 4
- Open Issues: 3
-
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-service-account)
[](https://github.com/mineiros-io/terraform-google-service-account/actions)
[](https://github.com/mineiros-io/terraform-google-service-account/releases)
[](https://github.com/hashicorp/terraform/releases)
[](https://github.com/terraform-providers/terraform-provider-google/releases)
[](https://mineiros.io/slack)
# terraform-google-service-account
A [Terraform](https://www.terraform.io) module to create [Google Service Accounts](https://cloud.google.com/iam/docs/service-accounts) on [Google Cloud Services (GCP)](https://cloud.google.com/).
**_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](#module-features)
- [Getting Started](#getting-started)
- [Module Argument Reference](#module-argument-reference)
- [Main Resource Configuration](#main-resource-configuration)
- [Extended Resource Configuration](#extended-resource-configuration)
- [Module Configuration](#module-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_service_account`
and supports additional features of the following modules:
- [mineiros-io/terraform-google-service-account-iam](https://github.com/mineiros-io/terraform-google-service-account-iam)
## Getting Started
Most basic usage just setting required arguments:
```hcl
module "terraform-google-service-account" {
source = "github.com/mineiros-io/terraform-google-service-account?ref=v0.1.1"
account_id = "service-account-id"
display_name = "Service Account"
}
```
## Module Argument Reference
See [variables.tf] and [examples/] for details and use-cases.
### Main Resource Configuration
- [**`account_id`**](#var-account_id): *(**Required** `string`)*
The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. Changing this forces a new service account to be created.
- [**`display_name`**](#var-display_name): *(Optional `string`)*
The display name for the service account. Can be updated without creating a new resource.
- [**`description`**](#var-description): *(Optional `string`)*
A text description of the service account. Must be less than or equal to 256 UTF-8 bytes.
- [**`project`**](#var-project): *(Optional `string`)*
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- [**`projects_access`**](#var-projects_access): *(Optional `list(projects_access)`)*
DEPRECATED: please convert existing access to project level IAM. This will be removed in the next breaking release.
Default is `[]`.
- [**`folders_access`**](#var-folders_access): *(Optional `list(folders_access)`)*
DEPRECATED: please convert existing access to folder level IAM. This will be removed in the next breaking release.
Default is `[]`.
- [**`organization_access`**](#var-organization_access): *(Optional `object(organization_access)`)*
DEPRECATED: please convert existing access to organization level IAM. This will be removed in the next breaking release.
Default is `[]`.
### Extended Resource Configuration
- [**`iam`**](#var-iam): *(Optional `list(iam)`)*
A list of IAM access.
Example:
```hcl
iam = [{
role = "roles/iam.serviceAccountUser"
members = ["user:[email protected]"]
}]
```
Each `iam` object in the list accepts the following attributes:
- [**`members`**](#attr-iam-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.
- `principalSet:{All identities in a group|All identities with a specific attribute value|All identities in a pool}`: Grants a role to all the identities in a workload identity pool, or to specific external identities based on their attributes. For details please see https://cloud.google.com/iam/docs/workload-identity-federation.
- `principal:{Single Identity}:` Grants a role to the specified identitiey in a workload identity pool. For details please see https://cloud.google.com/iam/docs/workload-identity-federation.
- `computed:{identifier}`: An existing key from `var.computed_members_map`.
Default is `[]`.
- [**`role`**](#attr-iam-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}`.
- [**`authoritative`**](#attr-iam-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/iam.serviceAccountUser"
members = ["user:[email protected]"]
condition = {
title = "expires_after_2021_12_31"
description = "Expiring at midnight of 2021-12-31"
expression = "request.time < timestamp(\"2022-01-01T00:00:00Z\")"
}
}]
```
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.
- [**`computed_members_map`**](#var-computed_members_map): *(Optional `map(string)`)*
A map of members to replace in `members` of various IAM settings to handle terraform computed values.
Default is `{}`.
## 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
]
```
## Module Outputs
The following attributes are exported in the outputs of the module:
- [**`iam`**](#output-iam): *(`list(iam)`)*
The `iam` resource objects that define the access to the resources.
- [**`service_account`**](#output-service_account): *(`object(service_account)`)*
All attributes of the created `google_service_account` resource.
- [**`project_iam_member`**](#output-project_iam_member): *(`object(project_iam_member)`)*
DEPRECATED: This will be removed in the next breaking release.
- [**`folder_iam_member`**](#output-folder_iam_member): *(`object(folder_iam_member)`)*
DEPRECATED: This will be removed in the next breaking release.
- [**`organization_iam_member`**](#output-organization_iam_member): *(`object(organization_iam_member)`)*
DEPRECATED: This will be removed in the next breaking release.
## External Documentation
### Google Documentation
- https://cloud.google.com/iam/docs/service-accounts
### Terraform Google Provider Documentation:
- https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_service_account
- https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/google_service_account_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-service-account
[[email protected]]: mailto:[email protected]
[badge-build]: https://github.com/mineiros-io/terraform-google-service-account/workflows/Tests/badge.svg
[badge-semver]: https://img.shields.io/github/v/tag/mineiros-io/terraform-google-service-account.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-service-account/actions
[releases-github]: https://github.com/mineiros-io/terraform-google-service-account/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-service-account/blob/main/variables.tf
[examples/]: https://github.com/mineiros-io/terraform-google-service-account/blob/main/examples
[issues]: https://github.com/mineiros-io/terraform-google-service-account/issues
[license]: https://github.com/mineiros-io/terraform-google-service-account/blob/main/LICENSE
[makefile]: https://github.com/mineiros-io/terraform-google-service-account/blob/main/Makefile
[pull requests]: https://github.com/mineiros-io/terraform-google-service-account/pulls
[contribution guidelines]: https://github.com/mineiros-io/terraform-google-service-account/blob/main/CONTRIBUTING.md