Skip to content

feat(pipelines): document aws_partition field for aws_oidc block #3082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZachGoldberg wants to merge 1 commit into
base: dev-1433
Choose a base branch
from
Open

feat(pipelines): document aws_partition field for aws_oidc block #3082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ This tutorial should take approximately 30 minutes to complete.
Adding a new GovCloud account to Gruntwork Pipelines, similar to a regular AWS account, requires bootstrapping Pipelines's ability to authenticate with AWS and assume appropriate IAM roles. A key distinction for GovCloud accounts is that the AWS partition is `aws-us-gov` instead of `aws`. This guide will walk you through executing a template to generate Terragrunt code for an OIDC Provider and IAM roles, configured to use the `aws-us-gov` partition, and then plan/applying that code to authorize pipelines. We'll then create a new S3 bucket in the GovCloud account and verify the bucket was created successfully by Gruntwork Pipelines.

Fundamentally, there are three places where the GovCloud partition must be set:
1. The `aws-us-gov` partition must be present in the ARN for the plan/apply roles configured in [aws_oidc](/2.0/reference/pipelines/configurations-as-code/api#aws_oidc-block-attributes) block for the account, typically in the `.gruntwork/`<CustomizableValue id="ACCOUNT_NAME"/>.hcl file.
1. The `aws-us-gov` partition must be present in the ARN for the plan/apply roles configured in the [aws_oidc](/2.0/reference/pipelines/configurations-as-code/api#aws_oidc-block-attributes) block for the account, typically in the `.gruntwork/`<CustomizableValue id="ACCOUNT_NAME"/>.hcl file. The [`aws_partition`](/2.0/reference/pipelines/configurations-as-code/api#aws_oidc-block-attributes) field must also be set to `aws-us-gov` in the same block.
2. A valid GovCloud region must be present in the <CustomizableValue id="ACCOUNT_NAME"/>`/_global/region.hcl` file
3. The `aws-us-gov` partition in the plan/apply IAM policies in the <CustomizableValue id="ACCOUNT_NAME"/>`/_global/pipelines-plan-role/terragrunt.hcl` and <CustomizableValue id="ACCOUNT_NAME"/>`/_global/pipelines-apply-role/terragrunt.hcl` files

Expand Down
9 changes: 9 additions & 0 deletions docs/2.0/reference/pipelines/configurations-as-code/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,15 @@ The duration in seconds that the AWS session will be valid for.
<HclListItemDefaultValue defaultValue="3600"/>
</HclListItem>

<HclListItem name="aws_partition" requirement="optional" type="string">
<HclListItemDescription>

The AWS partition to use when constructing IAM role ARNs. Must be one of `aws`, `aws-cn`, or `aws-us-gov`. Required when using a role name override (e.g. via the `AWSRoleName` workflow parameter) in non-commercial AWS partitions such as GovCloud or China.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="aws"/>
</HclListItem>

### `azure_oidc` block attributes

<HclListItem name="tenant_id" requirement="required" type="string">
Expand Down