From 165cc03e5d2edef70cb063963c5aec6aca01cde8 Mon Sep 17 00:00:00 2001 From: Oreoluwa Agunbiade Date: Tue, 23 Sep 2025 17:52:59 -0600 Subject: [PATCH] Make gov cloud docs work with referenced templates --- .../pipelines/installation/addinggitlabrepo.md | 2 +- .../tutorials/deploying-to-aws-gov-cloud.md | 16 +++++++--------- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/2.0/docs/pipelines/installation/addinggitlabrepo.md b/docs/2.0/docs/pipelines/installation/addinggitlabrepo.md index 367ba1d8f..ce6d9f050 100644 --- a/docs/2.0/docs/pipelines/installation/addinggitlabrepo.md +++ b/docs/2.0/docs/pipelines/installation/addinggitlabrepo.md @@ -116,7 +116,7 @@ First, you'll need to install [mise](https://mise.jdx.dev/), a powerful environm 4. Edit the `vars.yaml` file to customize it for your environment. If using a custom GitLab instance, update any custom instance variables. -5. `cd` to the root of where you wish to install Gruntwork Pipelines. Run the boilerplate tool to generate your repository structure: +5. `cd` to the root of where you wish to install Gruntwork Pipelines. Run the boilerplate tool to generate your repository structure: ```bash boilerplate --template-url "git@github.com:gruntwork-io/terraform-aws-architecture-catalog.git//templates/gitlab-pipelines-infrastructure-live-root/?ref=v3.1.0" --output-folder . --var-file vars.yaml --non-interactive ``` diff --git a/docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.md b/docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.md index 05a31d234..2d3c00f44 100644 --- a/docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.md +++ b/docs/2.0/docs/pipelines/tutorials/deploying-to-aws-gov-cloud.md @@ -47,18 +47,13 @@ Fundamentally, there are three places where the GovCloud partition must be set: This section covers the Pipelines configuration required to deploy an AWS S3 bucket to AWS GovCloud. -1. Add the account configuration to the bottom of your root-folder `accounts.yml` file. - - ```hcl title="accounts.yml" - $$ACCOUNT_NAME$$: - id: "$$ACCOUNT_ID$$" - ``` -2. Create a `vars.yaml` file on your local machine with the following content: +1. Create a `vars.yaml` file on your local machine with the following content: ```yaml title="vars.yaml" AccountName: "$$ACCOUNT_NAME$$" + AccountId: "$$ACCOUNT_ID$$" GitHubOrganization: "$$GITHUB_ORGANIZATION$$" GitHubRepository: "$$GITHUB_REPOSITORY$$" DeployBranchName: main # Change this to your default branch from which terragrunt apply should be run by pipelines @@ -71,6 +66,7 @@ This section covers the Pipelines configuration required to deploy an AWS S3 buc ```yaml title="vars.yaml" AccountName: "$$ACCOUNT_NAME$$" + AccountId: "$$ACCOUNT_ID$$" GitLabGroup: "$$GITLAB_GROUP$$" GitLabProject: "$$GITLAB_PROJECT$$" DeployBranchName: main # Change this to your default branch from which terragrunt apply should be run by pipelines @@ -84,15 +80,17 @@ This section covers the Pipelines configuration required to deploy an AWS S3 buc 3. We'll now use that `vars.yaml` file as input to [boilerplate](https://github.com/gruntwork-io/boilerplate) to generate the Terragrunt code for the OIDC Provider and IAM roles. From the root of your repository, run the following command: + + ```bash -boilerplate --template-url "git@github.com:gruntwork-io/terraform-aws-architecture-catalog.git//templates/github-actions-single-account-setup?ref=main" --output-folder . --var-file vars.yaml --non-interactive +boilerplate --template-url "git@github.com:gruntwork-io/terraform-aws-architecture-catalog.git//templates/github-actions-single-account-setup?ref=X.Y.Z" --output-folder . --var-file vars.yaml --non-interactive ``` ```bash -boilerplate --template-url "git@github.com:gruntwork-io/terraform-aws-architecture-catalog.git//templates/gitlab-pipelines-single-account-setup?ref=main" --output-folder . --var-file vars.yaml --non-interactive +boilerplate --template-url "git@github.com:gruntwork-io/terraform-aws-architecture-catalog.git//templates/gitlab-pipelines-single-account-setup?ref=X.Y.Z" --output-folder . --var-file vars.yaml --non-interactive ```