Skip to content

Commit 14a3786

Browse files
committed
docs: Restructured initial setup to avoid assuming AWS
docs: Splitting up different cloud providers wip: Progress on stacks
1 parent 5500c53 commit 14a3786

File tree

4 files changed

+465
-29
lines changed

4 files changed

+465
-29
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Adding Account Factory to a new repository
2+
3+
To configure Gruntwork Account Factory in a new GitHub repository, the following steps are required (and will be explained in detail below):
4+
5+
1. Create your `infrastructure-live-root` repository using Gruntwork's GitHub template.
6+
2. Configure the Gruntwork.io GitHub App to authorize your `infrastructure-live-root` repository, or ensure that the appropriate machine user tokens are set up as repository or organization secrets.
7+
3. Update the Bootstrap Workflow to configure your AWS settings.
8+
4. Execute the Bootstrap Workflow in your `infrastructure-live-root` repository to generate pull requests and additional repositories.
9+
10+
## Creating the infrastructure-live-root repository
11+
12+
Gruntwork provides a pre-configured git repository template that incorporates best practices while allowing for customization.
13+
14+
[infrastructure-live-root-template](https://github.com/gruntwork-io/infrastructure-live-root-template)
15+
16+
This template generates an `infrastructure-live-root` repository with a bootstrap workflow designed to scaffold a best-practices Terragrunt configuration. It includes patterns for module defaults, global variables, and account baselines. Additionally, it integrates Gruntwork Pipelines, which can be removed if not required.
17+
18+
The workflow can optionally scaffold the `infrastructure-live-access-control` and `infrastructure-catalog` repositories.
19+
20+
Navigate to the template repository and select **Use this template** -> **Create a new Repository**. Choose your organization as the owner, add a description if desired, set the repository to **private**, and click **Create repository**.
21+
22+
## Configuring Gruntwork app settings
23+
24+
Use the Gruntwork.io GitHub App to [add the repository as an Infra Root repository](/2.0/docs/pipelines/installation/viagithubapp#configuration).
25+
26+
If using the [machine user model](/2.0/docs/pipelines/installation/viamachineusers.md), ensure the `INFRA_ROOT_WRITE_TOKEN` (and `ORG_REPO_ADMIN_TOKEN` for enterprise customers) is added to the repository as a secret or configured as an organization secret.
27+
28+
## Updating the Bootstrap Workflow
29+
30+
Return to your `infrastructure-live-root` repository and follow the `README` instructions to update the bootstrap workflow for IaC Foundations. Provide details about your AWS organization, accounts, and default values for new account provisioning.
31+
32+
## Running the workflow
33+
34+
Follow the instructions in your `infrastructure-live-root` repository to execute the Bootstrap Workflow. Gruntwork support is available to address any questions that arise. During the workflow execution, you can choose to create the `infrastructure-live-access-control` and `infrastructure-catalog` repositories. These repositories will be created in your GitHub organization using values defined in the workflow configuration.
35+
36+
### Infrastructure live access control
37+
38+
This repository is primarily for Enterprise customers but is recommended for all users. When running the Bootstrap Workflow in your `infrastructure-live-root` repository, select the option to "Bootstrap the infrastructure-access-control repository."
39+
40+
### Infrastructure catalog
41+
42+
The Bootstrap Workflow also creates an empty `infrastructure-catalog` repository. This repository is used to store Terraform/OpenTofu modules authored by your organization for internal use. During the Bootstrap Workflow execution in your `infrastructure-live-root` repository, select the option to "Bootstrap the infrastructure-catalog repository."
43+
44+
## Completing instructions in Bootstrap Pull Requests
45+
46+
Each of your repositories will contain a Bootstrap Pull Request. Follow the instructions in these Pull Requests to finalize the setup of your IaC repositories.
47+
48+
:::info
49+
50+
The bootstrapping pull requests include pre-configured files, such as a `.mise.toml` file that specifies versions of OpenTofu and Terragrunt. Ensure you review and update these configurations to align with your organization's requirements.
51+
:::

docs/2.0/docs/accountfactory/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
Account Factory is automatically integrated into [new Pipelines root repositories](/2.0/docs/pipelines/installation/addingnewrepo) during the bootstrapping process.
5+
Account Factory is automatically integrated into [new Pipelines root repositories](/2.0/docs/accountfactory/installation/addingnewrepo) during the bootstrapping process.
66

77
By default, Account Factory includes the following components:
88

0 commit comments

Comments
 (0)