-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add example of a Workload Identity Pool configuration for GitHub Acti…
…ons (#11936) (#813) [upstream:47f6ff1f4da285bf47ffbb0584a4cf476324f18e] Signed-off-by: Modular Magician <[email protected]>
- Loading branch information
1 parent
5715640
commit 685156c
Showing
4 changed files
with
127 additions
and
0 deletions.
There are no files selected for viewing
15 changes: 15 additions & 0 deletions
15
iam_workload_identity_pool_provider_github_actions/backing_file.tf
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,15 @@ | ||
# This file has some scaffolding to make sure that names are unique and that | ||
# a region and zone are selected when you try to create your Terraform resources. | ||
|
||
locals { | ||
name_suffix = "${random_pet.suffix.id}" | ||
} | ||
|
||
resource "random_pet" "suffix" { | ||
length = 2 | ||
} | ||
|
||
provider "google" { | ||
region = "us-central1" | ||
zone = "us-central1-c" | ||
} |
26 changes: 26 additions & 0 deletions
26
iam_workload_identity_pool_provider_github_actions/main.tf
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,26 @@ | ||
resource "google_iam_workload_identity_pool" "pool" { | ||
workload_identity_pool_id = "example-pool-${local.name_suffix}" | ||
} | ||
|
||
resource "google_iam_workload_identity_pool_provider" "example" { | ||
workload_identity_pool_id = google_iam_workload_identity_pool.pool.workload_identity_pool_id | ||
workload_identity_pool_provider_id = "example-prvdr-${local.name_suffix}" | ||
display_name = "Name of provider" | ||
description = "GitHub Actions identity pool provider for automated test" | ||
disabled = true | ||
attribute_condition = <<EOT | ||
assertion.repository_owner_id == "123456789" && | ||
attribute.repository == "gh-org/gh-repo" && | ||
assertion.ref == "refs/heads/main" && | ||
assertion.ref_type == "branch" | ||
EOT | ||
attribute_mapping = { | ||
"google.subject" = "assertion.sub" | ||
"attribute.actor" = "assertion.actor" | ||
"attribute.aud" = "assertion.aud" | ||
"attribute.repository" = "assertion.repository" | ||
} | ||
oidc { | ||
issuer_uri = "https://token.actions.githubusercontent.com" | ||
} | ||
} |
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,7 @@ | ||
=== | ||
|
||
These examples use real resources that will be billed to the | ||
Google Cloud Platform project you use - so make sure that you | ||
run "terraform destroy" before quitting! | ||
|
||
=== |
79 changes: 79 additions & 0 deletions
79
iam_workload_identity_pool_provider_github_actions/tutorial.md
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,79 @@ | ||
# Iam Workload Identity Pool Provider Github Actions - Terraform | ||
|
||
## Setup | ||
|
||
<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="iam_workload_identity_pool_provider_github_actions" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author> | ||
|
||
Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform. | ||
|
||
<walkthrough-project-billing-setup></walkthrough-project-billing-setup> | ||
|
||
Terraform provisions real GCP resources, so anything you create in this session will be billed against this project. | ||
|
||
## Terraforming! | ||
|
||
Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command | ||
to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up | ||
the project name from the environment variable. | ||
|
||
```bash | ||
export GOOGLE_CLOUD_PROJECT={{project-id}} | ||
``` | ||
|
||
After that, let's get Terraform started. Run the following to pull in the providers. | ||
|
||
```bash | ||
terraform init | ||
``` | ||
|
||
With the providers downloaded and a project set, you're ready to use Terraform. Go ahead! | ||
|
||
```bash | ||
terraform apply | ||
``` | ||
|
||
Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan. | ||
|
||
```bash | ||
yes | ||
``` | ||
|
||
|
||
## Post-Apply | ||
|
||
### Editing your config | ||
|
||
Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed. | ||
|
||
```bash | ||
terraform plan | ||
``` | ||
|
||
So let's make a change! Try editing a number, or appending a value to the name in the editor. Then, | ||
run a 'plan' again. | ||
|
||
```bash | ||
terraform plan | ||
``` | ||
|
||
Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes | ||
at the 'yes' prompt. | ||
|
||
```bash | ||
terraform apply | ||
``` | ||
|
||
```bash | ||
yes | ||
``` | ||
|
||
## Cleanup | ||
|
||
Run the following to remove the resources Terraform provisioned: | ||
|
||
```bash | ||
terraform destroy | ||
``` | ||
```bash | ||
yes | ||
``` |