Skip to content

PF-119: Account Factory should be able to vend in a subdirectory #3139

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
gruntwork-ci wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PF-119: Account Factory should be able to vend in a subdirectory #3139

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/accountfactory/architecture/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Account Factory uses Gruntwork's [AWS Control Tower Multi Account Factory](/refe

In your `infrastructure-live-root` repository, the `_new-account-requests` directory acts as input for the Gruntwork Control Tower Module. The module, functioning within your management account, employs AWS Control Tower to efficiently provision new accounts and manage existing ones.

Pipelines tracks each provisioned account as a new base directory containing Terragrunt units in your `infrastructure-live-root` repository.
Pipelines tracks each provisioned account as a new base directory containing Terragrunt units in your `infrastructure-live-root` repository. By default, newly vended accounts live directly at the repository root (`{repo_root}/{account_name}/…`). You can place them under a subdirectory instead by setting the [`new_account_parent_path`](/2.0/reference/accountfactory/configurations-as-code#new_account_parent_path) attribute on the `account_factory` block; for example, `new_account_parent_path = "aws"` will vend accounts at `{repo_root}/aws/{account_name}/…`. The `_new-account-requests/` request directory and the `accounts.yml` file remain at the repository root regardless of this setting.

![Architecture Overview Diagram](/img/accountfactory/architecture.png)

Expand Down
23 changes: 23 additions & 0 deletions docs/2.0/reference/accountfactory/configurations-as-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,29 @@ account_factory {
</HclListItemDescription>
</HclListItem>

### new_account_parent_path

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

A repo-relative subdirectory under which newly vended accounts are created. When set to a value such as `"aws"`, Account Factory will vend new AWS accounts into `{repo_root}/aws/{account_name}/…` instead of `{repo_root}/{account_name}/…`. The default is `""`, meaning new accounts are vended at the repository root (today's behavior).
<br />
This setting affects only newly vended accounts. Existing accounts are not relocated, and the `_new-account-requests/` directory and the `accounts.yml` file continue to live at the repository root.
<br />
The value must be a relative subpath. Leading and trailing slashes are stripped silently (`"/aws/"` is equivalent to `"aws"`). Paths containing `..` segments are rejected at config-load time.

</HclListItemDescription>
<HclListItemExample>

```hcl
account_factory {
new_account_parent_path = "aws"
}
```
Comment on lines +306 to +319
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix Markdown code-block style to satisfy MD046 in this new section.

The newly added example snippets are being parsed as indented-style blocks by markdownlint. Please switch them to explicit fenced style in this section so doc lint stays clean.

Suggested adjustment 
-    A repo-relative subdirectory under which newly vended accounts are created. When set to a value such as `"aws"`, Account Factory will vend new AWS accounts into `{repo_root}/aws/{account_name}/…` instead of `{repo_root}/{account_name}/…`. The default is `""`, meaning new accounts are vended at the repository root (today's behavior).
+    A repo-relative subdirectory under which newly vended accounts are created. When set to a value such as `"aws"`, Account Factory will vend new AWS accounts into `{repo_root}/aws/{account_name}/…` instead of `{repo_root}/{account_name}/…`. The default is `""`, meaning new accounts are vended at the repository root (today's behavior).

@@
-    ```hcl
-    account_factory {
-      new_account_parent_path = "aws"
-    }
-    ```
+```hcl
+account_factory {
+  new_account_parent_path = "aws"
+}
+```
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 306-306: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

[warning] 315-315: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/2.0/reference/accountfactory/configurations-as-code.md` around lines 306
- 319, The example HCL block under the new_account_parent_path description is
currently indented and parsed as an indented code block; replace it with a
fenced code block using the language tag "hcl" and unindented contents so
markdownlint rule MD046 is satisfied—for example, wrap the account_factory {
new_account_parent_path = "aws" } snippet in ```hcl ... ``` and ensure the block
uses the exact symbol names account_factory and new_account_parent_path as
shown.


</HclListItemExample>
</HclListItem>

### pipelines_read_token_name

<HclListItem name="pipelines_read_token_name" requirement="optional" type="string">
Expand Down