You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/2.0/docs/accountfactory/guides/vend-aws-account.md
+40-11Lines changed: 40 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,37 +1,66 @@
1
+
import Tabs from '@theme/Tabs';
2
+
import TabItem from '@theme/TabItem';
3
+
1
4
# Using the Account Factory Workflow
2
5
3
-
## Introduction
6
+
## Generate the account-request file
4
7
5
-
The Account Factory Workflow in your `infrastructure-live-root` repository can be used to create new AWS accounts. It requires a single input—a JSON payload—generated from the `account-factory-inputs.html` web page.
8
+
There are currently two ways to generate the account-request file:
6
9
7
-
The JSON payload approach provides greater flexibility for account vending, overcoming the GitHub workflow restriction of a 10-input maximum.
10
+
1. Using the [Gruntwork Developer Portal](/2.0/docs/accountfactory/guides/vend-aws-account?account-creation-method=ui#using-the-gruntwork-developer-portal) (**GitLab and GitHub non-enterprise customers**)
11
+
2. Using the [Account Factory workflow in your repository](/2.0/docs/accountfactory/guides/vend-aws-account?account-creation-method=workflow#using-the-account-factory-workflow-in-your-repository) (**GitHub only**)
1. Navigate to the [Account Request](https://app.gruntwork.io/account-factory/request-generator) page in the Gruntwork Developer Portal, as an authenticated user, to access the request generator UI.
This guide focuses on non-delegated repositories. Enterprise customers can also [use Account Factory to create new Delegated Repositories](/2.0/docs/accountfactory/guides/delegated-repositories).
23
+
1. If the form is disabled for filling out, request that an Admin in your Gruntwork Developer Account configures the Account factory settings.
24
+
1. Fill out the form with the required information and click on the "Generate Account Request" button.
25
+
1. Use the "Download" button to download the account-request file or the "Copy" button to copy the account-request file to your clipboard.
26
+
1. Navigate to your repository and create a new branch.
27
+
1. Create a new file in the `_new-account-requests` directory by moving the downloaded file to the directory or by creating a new file with the content of your clipboard. If copying content, ensure that the file is created with the correct name displayed in the generator output.
28
+
1. Commit your changes and open a Pull Request to the main branch.
12
29
30
+
</TabItem>
31
+
<TabItemvalue="workflow"label="Using Workflow in Repo">
32
+
33
+
### Using the Account Factory workflow in your repository
34
+
35
+
:::info
36
+
Only available for GitHub customers. This guide focuses on non-delegated repositories. Enterprise GitHub customers can also [use Account Factory to create new Delegated Repositories](/2.0/docs/accountfactory/guides/delegated-repositories).
13
37
:::
14
38
39
+
The Account Factory Workflow in your `infrastructure-live-root` repository can be used to create new AWS accounts. It requires a single input—a JSON payload—generated from the `account-factory-inputs.html` web page.
15
40
16
-
### Step 1 - Download the file
41
+
The JSON payload approach provides greater flexibility for account vending, overcoming the GitHub workflow restriction of a 10-input maximum.
42
+
43
+
#### Step 1 - Download the file
17
44
18
45
Locate the inputs web page in your `infrastructure-live-root` repository at `.github/workflows/account-factory-inputs.html` and download it to your local machine.
19
46
20
-
### Step 2 - Populate the values
47
+
####Step 2 - Populate the values
21
48
22
49
Open the downloaded `account-factory-inputs.html` file in a web browser and populate the input fields as required.
23
50
24
51
Once all values are filled, click "Generate" and copy the resulting JSON output to your clipboard.
25
52
26
-
### Step 3 - Run the Account Factory workflow
53
+
####Step 3 - Run the Account Factory workflow
27
54
28
55
Access the Actions tab in your `infrastructure-live-root` repository on GitHub and select `Account factory` from the left-hand pane.
29
56
30
57
Click "Run workflow" on the right, paste the generated JSON payload into the dropdown, and click the green "Run workflow" button to initiate the workflow.
58
+
After the workflow is complete, a new Pull Request will be created in the `infrastructure-live-root` repository. This PR will add an account request to the `_new-account-requests` directory.
31
59
32
-
### Step 4 - Merge the account request PR
60
+
</TabItem>
61
+
</Tabs>
33
62
34
-
After the workflow is complete, a new Pull Request will be created in the `infrastructure-live-root` repository. This PR will add an account request to the `_new-account-requests` directory.
63
+
## Review and merge the account request PR
35
64
36
65
Review and merge the Pull Request to begin the account creation process.
37
66
@@ -43,7 +72,7 @@ Once the account request PR merges into the main branch, Pipelines will initiate
43
72
44
73
When the account is successfully created, Pipelines will open another Pull Request to baseline the account.
45
74
46
-
### Step 5 - Merge the Account Baseline PR
75
+
##Review and merge the Account Baseline PR
47
76
48
77
Review and merge the Account Baseline Pull Request. This PR contains essential infrastructure for enabling your delegated repository to plan and apply infrastructure changes in AWS. It also includes account baselines and configured account-specific infrastructure, such as a VPC.
Copy file name to clipboardExpand all lines: docs/2.0/docs/pipelines/installation/addinggitlabrepo.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
import CustomizableValue from '/src/components/CustomizableValue';
2
2
3
-
# Adding Pipelines to a GitLab Project
3
+
# Adding Pipelines to an existing GitLab Project
4
4
5
5
This guide walks you through the process of adding Gruntwork Pipelines to a GitLab project. By the end, you'll have a fully configured GitLab CI/CD pipeline that can deploy infrastructure changes automatically.
6
6
@@ -11,7 +11,7 @@ Before you begin, make sure you have:
11
11
- Basic familiarity with Git, GitLab, and infrastructure as code concepts
12
12
- Access to one (or many) AWS account(s) where you have permission to create IAM roles and OIDC providers
13
13
- Completed the [Pipelines Auth setup for GitLab](/2.0/docs/pipelines/installation/viamachineusers#gitlab) and setup a machine user with appropriate PAT tokens
14
-
- Local access to Gruntwork's GitHub repositories, specifically [boilerplate](https://github.com/gruntwork-io/boilerplate) and the [architecture catalog](https://github.com/gruntwork-io/terraform-aws-architecture-catalog/)
14
+
- Local access to Gruntwork's GitHub repositories, specifically the [architecture catalog](https://github.com/gruntwork-io/terraform-aws-architecture-catalog/)
0 commit comments