-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* add iam workload identity pool provider * Apply suggestions from code review Co-authored-by: Scott Suarez <[email protected]> * make clear that name and self_link contain project number, not id * fixed wrong file naming * sync provider docs to pool docs * add tests for provider * workload identity resources have no self_link * treat delete state as gone Co-authored-by: Scott Suarez <[email protected]> Signed-off-by: Modular Magician <[email protected]> Co-authored-by: Scott Suarez <[email protected]>
- Loading branch information
1 parent
265aa85
commit 669026c
Showing
7 changed files
with
362 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ```release-note:new-resource | ||
| `google_iam_workload_identity_pool_provider` | ||
| ``` |
File renamed without changes.
1 change: 1 addition & 0 deletions
1
google/resource_iam_beta_workload_identity_pool_provider_id_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| package google |
1 change: 1 addition & 0 deletions
1
google/resource_iam_beta_workload_identity_pool_provider_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| package google |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
344 changes: 344 additions & 0 deletions
344
website/docs/r/iam_workload_identity_pool_provider.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,344 @@ | ||
| --- | ||
| # ---------------------------------------------------------------------------- | ||
| # | ||
| # *** AUTO GENERATED CODE *** AUTO GENERATED CODE *** | ||
| # | ||
| # ---------------------------------------------------------------------------- | ||
| # | ||
| # This file is automatically generated by Magic Modules and manual | ||
| # changes will be clobbered when the file is regenerated. | ||
| # | ||
| # Please read more about how to change this file in | ||
| # .github/CONTRIBUTING.md. | ||
| # | ||
| # ---------------------------------------------------------------------------- | ||
| subcategory: "Cloud IAM" | ||
| layout: "google" | ||
| page_title: "Google: google_iam_workload_identity_pool_provider" | ||
| sidebar_current: "docs-google-iam-workload-identity-pool-provider" | ||
| description: |- | ||
| A configuration for an external identity provider. | ||
| --- | ||
|
|
||
| # google\_iam\_workload\_identity\_pool\_provider | ||
|
|
||
| A configuration for an external identity provider. | ||
|
|
||
| ~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. | ||
| See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources. | ||
|
|
||
| To get more information about WorkloadIdentityPoolProvider, see: | ||
|
|
||
| * [API documentation](https://cloud.google.com/iam/docs/reference/rest/v1beta/projects.locations.workloadIdentityPools.providers) | ||
| * How-to Guides | ||
| * [Managing workload identity providers](https://cloud.google.com/iam/docs/manage-workload-identity-pools-providers#managing_workload_identity_providers) | ||
|
|
||
| <div class = "oics-button" style="float: right; margin: 0 0 -15px"> | ||
| <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=iam_workload_identity_pool_provider_aws_basic&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> | ||
| <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> | ||
| </a> | ||
| </div> | ||
| ## Example Usage - Iam Workload Identity Pool Provider Aws Basic | ||
|
|
||
|
|
||
| ```hcl | ||
| resource "google_iam_workload_identity_pool" "pool" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = "example-pool" | ||
| } | ||
| resource "google_iam_workload_identity_pool_provider" "example" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id | ||
| workload_identity_pool_provider_id = "example-prvdr" | ||
| aws { | ||
| account_id = "999999999999" | ||
| } | ||
| } | ||
| ``` | ||
| <div class = "oics-button" style="float: right; margin: 0 0 -15px"> | ||
| <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=iam_workload_identity_pool_provider_aws_full&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> | ||
| <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> | ||
| </a> | ||
| </div> | ||
| ## Example Usage - Iam Workload Identity Pool Provider Aws Full | ||
|
|
||
|
|
||
| ```hcl | ||
| resource "google_iam_workload_identity_pool" "pool" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = "example-pool" | ||
| } | ||
| resource "google_iam_workload_identity_pool_provider" "example" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id | ||
| workload_identity_pool_provider_id = "example-prvdr" | ||
| display_name = "Name of provider" | ||
| description = "AWS identity pool provider for automated test" | ||
| disabled = true | ||
| attribute_condition = "attribute.aws_role==\"arn:aws:sts::999999999999:assumed-role/stack-eu-central-1-lambdaRole\"" | ||
| attribute_mapping = { | ||
| "google.subject" = "assertion.arn" | ||
| "attribute.aws_account" = "assertion.account" | ||
| "attribute.environment" = "assertion.arn.contains(\":instance-profile/Production\") ? \"prod\" : \"test\"" | ||
| } | ||
| aws { | ||
| account_id = "999999999999" | ||
| } | ||
| } | ||
| ``` | ||
| <div class = "oics-button" style="float: right; margin: 0 0 -15px"> | ||
| <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=iam_workload_identity_pool_provider_oidc_basic&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> | ||
| <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> | ||
| </a> | ||
| </div> | ||
| ## Example Usage - Iam Workload Identity Pool Provider Oidc Basic | ||
|
|
||
|
|
||
| ```hcl | ||
| resource "google_iam_workload_identity_pool" "pool" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = "example-pool" | ||
| } | ||
| resource "google_iam_workload_identity_pool_provider" "example" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id | ||
| workload_identity_pool_provider_id = "example-prvdr" | ||
| attribute_mapping = { | ||
| "google.subject" = "assertion.sub" | ||
| } | ||
| oidc { | ||
| issuer_uri = "https://sts.windows.net/azure-tenant-id" | ||
| } | ||
| } | ||
| ``` | ||
| <div class = "oics-button" style="float: right; margin: 0 0 -15px"> | ||
| <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=iam_workload_identity_pool_provider_oidc_full&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank"> | ||
| <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;"> | ||
| </a> | ||
| </div> | ||
| ## Example Usage - Iam Workload Identity Pool Provider Oidc Full | ||
|
|
||
|
|
||
| ```hcl | ||
| resource "google_iam_workload_identity_pool" "pool" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = "example-pool" | ||
| } | ||
| resource "google_iam_workload_identity_pool_provider" "example" { | ||
| provider = google-beta | ||
| workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id | ||
| workload_identity_pool_provider_id = "example-prvdr" | ||
| display_name = "Name of provider" | ||
| description = "OIDC identity pool provider for automated test" | ||
| disabled = true | ||
| attribute_condition = "\"e968c2ef-047c-498d-8d79-16ca1b61e77e\" in assertion.groups" | ||
| attribute_mapping = { | ||
| "google.subject" = "\"azure::\" + assertion.tid + \"::\" + assertion.sub" | ||
| "attribute.tid" = "assertion.tid" | ||
| "attribute.managed_identity_name" = <<EOT | ||
| { | ||
| "8bb39bdb-1cc5-4447-b7db-a19e920eb111":"workload1", | ||
| "55d36609-9bcf-48e0-a366-a3cf19027d2a":"workload2" | ||
| }[assertion.oid] | ||
| EOT | ||
| } | ||
| oidc { | ||
| allowed_audiences = ["https://example.com/gcp-oidc-federation", "example.com/gcp-oidc-federation"] | ||
| issuer_uri = "https://sts.windows.net/azure-tenant-id" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Argument Reference | ||
|
|
||
| The following arguments are supported: | ||
|
|
||
|
|
||
| * `workload_identity_pool_id` - | ||
| (Required) | ||
| The ID used for the pool, which is the final component of the pool resource name. This | ||
| value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix | ||
| `gcp-` is reserved for use by Google, and may not be specified. | ||
|
|
||
| * `workload_identity_pool_provider_id` - | ||
| (Required) | ||
| The ID for the provider, which becomes the final component of the resource name. This | ||
| value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix | ||
| `gcp-` is reserved for use by Google, and may not be specified. | ||
|
|
||
|
|
||
| - - - | ||
|
|
||
|
|
||
| * `display_name` - | ||
| (Optional) | ||
| A display name for the provider. Cannot exceed 32 characters. | ||
|
|
||
| * `description` - | ||
| (Optional) | ||
| A description for the provider. Cannot exceed 256 characters. | ||
|
|
||
| * `disabled` - | ||
| (Optional) | ||
| Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. | ||
| However, existing tokens still grant access. | ||
|
|
||
| * `attribute_mapping` - | ||
| (Optional) | ||
| Maps attributes from authentication credentials issued by an external identity provider | ||
| to Google Cloud attributes, such as `subject` and `segment`. | ||
| Each key must be a string specifying the Google Cloud IAM attribute to map to. | ||
| The following keys are supported: | ||
| * `google.subject`: The principal IAM is authenticating. You can reference this value | ||
| in IAM bindings. This is also the subject that appears in Cloud Logging logs. | ||
| Cannot exceed 127 characters. | ||
| * `google.groups`: Groups the external identity belongs to. You can grant groups | ||
| access to resources using an IAM `principalSet` binding; access applies to all | ||
| members of the group. | ||
| You can also provide custom attributes by specifying `attribute.{custom_attribute}`, | ||
| where `{custom_attribute}` is the name of the custom attribute to be mapped. You can | ||
| define a maximum of 50 custom attributes. The maximum length of a mapped attribute key | ||
| is 100 characters, and the key may only contain the characters [a-z0-9_]. | ||
| You can reference these attributes in IAM policies to define fine-grained access for a | ||
| workload to Google Cloud resources. For example: | ||
| * `google.subject`: | ||
| `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` | ||
| * `google.groups`: | ||
| `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` | ||
| * `attribute.{custom_attribute}`: | ||
| `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` | ||
| Each value must be a [Common Expression Language](https://opensource.google/projects/cel) | ||
| function that maps an identity provider credential to the normalized attribute specified | ||
| by the corresponding map key. | ||
| You can use the `assertion` keyword in the expression to access a JSON representation of | ||
| the authentication credential issued by the provider. | ||
| The maximum length of an attribute mapping expression is 2048 characters. When evaluated, | ||
| the total size of all mapped attributes must not exceed 8KB. | ||
| For AWS providers, the following rules apply: | ||
| - If no attribute mapping is defined, the following default mapping applies: | ||
| ``` | ||
| { | ||
| "google.subject":"assertion.arn", | ||
| "attribute.aws_role": | ||
| "assertion.arn.contains('assumed-role')" | ||
| " ? assertion.arn.extract('{account_arn}assumed-role/')" | ||
| " + 'assumed-role/'" | ||
| " + assertion.arn.extract('assumed-role/{role_name}/')" | ||
| " : assertion.arn", | ||
| } | ||
| ``` | ||
| - If any custom attribute mappings are defined, they must include a mapping to the | ||
| `google.subject` attribute. | ||
| For OIDC providers, the following rules apply: | ||
| - Custom attribute mappings must be defined, and must include a mapping to the | ||
| `google.subject` attribute. For example, the following maps the `sub` claim of the | ||
| incoming credential to the `subject` attribute on a Google token. | ||
| ``` | ||
| {"google.subject": "assertion.sub"} | ||
| ``` | ||
| * `attribute_condition` - | ||
| (Optional) | ||
| [A Common Expression Language](https://opensource.google/projects/cel) expression, in | ||
| plain text, to restrict what otherwise valid authentication credentials issued by the | ||
| provider should not be accepted. | ||
| The expression must output a boolean representing whether to allow the federation. | ||
| The following keywords may be referenced in the expressions: | ||
| * `assertion`: JSON representing the authentication credential issued by the provider. | ||
| * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. | ||
| * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. | ||
| The maximum length of the attribute condition expression is 4096 characters. If | ||
| unspecified, all valid authentication credential are accepted. | ||
| The following example shows how to only allow credentials with a mapped `google.groups` | ||
| value of `admins`: | ||
| ``` | ||
| "'admins' in google.groups" | ||
| ``` | ||
| * `aws` - | ||
| (Optional) | ||
| An Amazon Web Services identity provider. Not compatible with the property oidc. | ||
| Structure is documented below. | ||
| * `oidc` - | ||
| (Optional) | ||
| An OpenId Connect 1.0 identity provider. Not compatible with the property aws. | ||
| Structure is documented below. | ||
| * `project` - (Optional) The ID of the project in which the resource belongs. | ||
| If it is not provided, the provider project is used. | ||
| The `aws` block supports: | ||
| * `account_id` - | ||
| (Required) | ||
| The AWS account ID. | ||
| The `oidc` block supports: | ||
| * `allowed_audiences` - | ||
| (Optional) | ||
| Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange | ||
| requests are rejected if the token audience does not match one of the configured | ||
| values. Each audience may be at most 256 characters. A maximum of 10 audiences may | ||
| be configured. | ||
| If this list is empty, the OIDC token audience must be equal to the full canonical | ||
| resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. | ||
| For example: | ||
| ``` | ||
| //iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> | ||
| https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> | ||
| ``` | ||
| * `issuer_uri` - | ||
| (Required) | ||
| The OIDC issuer URL. | ||
| ## Attributes Reference | ||
| In addition to the arguments listed above, the following computed attributes are exported: | ||
| * `id` - an identifier for the resource with format `projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}/providers/{{workload_identity_pool_provider_id}}` | ||
| * `state` - | ||
| The state of the provider. | ||
| * STATE_UNSPECIFIED: State unspecified. | ||
| * ACTIVE: The provider is active, and may be used to validate authentication credentials. | ||
| * DELETED: The provider is soft-deleted. Soft-deleted providers are permanently deleted | ||
| after approximately 30 days. You can restore a soft-deleted provider using | ||
| UndeleteWorkloadIdentityPoolProvider. You cannot reuse the ID of a soft-deleted provider | ||
| until it is permanently deleted. | ||
| * `name` - | ||
| The resource name of the provider as | ||
| `projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}`. | ||
| ## Timeouts | ||
| This resource provides the following | ||
| [Timeouts](/docs/configuration/resources.html#timeouts) configuration options: | ||
| - `create` - Default is 4 minutes. | ||
| - `update` - Default is 4 minutes. | ||
| - `delete` - Default is 4 minutes. | ||
| ## Import | ||
| WorkloadIdentityPoolProvider can be imported using any of these accepted formats: | ||
| ``` | ||
| $ terraform import google_iam_workload_identity_pool_provider.default projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}/providers/{{workload_identity_pool_provider_id}} | ||
| $ terraform import google_iam_workload_identity_pool_provider.default {{project}}/{{workload_identity_pool_id}}/{{workload_identity_pool_provider_id}} | ||
| $ terraform import google_iam_workload_identity_pool_provider.default {{workload_identity_pool_id}}/{{workload_identity_pool_provider_id}} | ||
| ``` | ||
| ## User Project Overrides | ||
| This resource supports [User Project Overrides](https://www.terraform.io/docs/providers/google/guides/provider_reference.html#user_project_override). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters