Skip to content

Commit 5e3d29d

Browse files
authored
Final tweaks to latest docs release (#1132)
Add additional details on DevOps components overview Add page on "setup order" for DevOps components Make all product names consistent with the DevOps components paradigm Add overview pages for all DevOps components sections Improve readability and structure of Landing Zone docs Improve readability and structure of Pipelines docs
1 parent 5023a1b commit 5e3d29d

File tree

43 files changed

+805
-525
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+805
-525
lines changed

_docs-sources/foundations/accounts/index.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

_docs-sources/foundations/accounts/manage-accounts.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

_docs-sources/foundations/ci-cd/index.md

Lines changed: 0 additions & 68 deletions
This file was deleted.
File renamed without changes.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# About IaC Foundations
2+
3+
The IaC Foundations component is focused on:
4+
5+
- Teaching you the considerations to think about when coming up with your foundational Terraform/OpenTofu and Terragrunt patterns
6+
- Giving you a fully configured set of git repositories with an initial folder structure
7+
8+
## What's included
9+
10+
- **Strategy.** We recommend core patterns your Terragrunt and Terraform/OpenTofu git repo needs to incorporate to scale effectively.
11+
- **IaC Modules.** No IaC modules are needed for this component.
12+
- **Tooling.** We recommend Terragrunt to effectively use Terraform/OpenTofu at scale.
13+
- **Setup.** We grant you access to a sophisticated git repo template that includes customization options and generates your repo code.
14+
- **Updates.** We publish ongoing updates to IaC foundational patterns and will write [patches](/patcher) if applicable to adopt those changes.
15+
16+
## IaC foundations considerations
17+
18+
When creating your initial Terraform/OpenTofu and Terragrunt infrastructure, there are a number of patterns you need to consider how to solve, including:
19+
20+
- How to create the backend (e.g. S3 bucket) for storing Terraform state
21+
- How to structure your folder hierarchy
22+
- How to handle tagging and labels
23+
- Whether to use branches per environment
24+
- How to handle global variables
25+
- How to handle module default values
26+
27+
This component includes either pre-baked implementations that address these considerations, or written guidance on how to incorporate them yourself.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Initial setup
2+
3+
To set up IaC Foundations, we use three pre-configured git repository templates that include best practices and also allow for customization.
4+
5+
For each repository below, navigate to the template repository and select **Use this template** -> **Create a new Repository**. This will initiate repository creation. You should select your org as the owner, add a description if you like, make sure you are creating a **private** repo, and click **Create repository**.
6+
7+
The repository template will be created, and you can follow the instructions in the `README` to bootstrap your IaC Foundations. Gruntwork is available to assist with questions around other patterns as they arise.
8+
9+
### Infrastructure Live Template
10+
11+
_[https://github.com/gruntwork-io/infrastructure-live-template](https://github.com/gruntwork-io/infrastructure-live-template)_
12+
13+
This template creates an infrastructure-live repository with scaffolding for a best practices Terragrunt configuration, including patterns for module defaults, global variables, and account baselines. It also configures Gruntwork Pipelines, which is easy to remove if you don't want it.
14+
15+
### Infrastructure Modules Template
16+
17+
_[https://github.com/gruntwork-io/infrastructure-modules-template](https://github.com/gruntwork-io/infrastructure-modules-template)_
18+
19+
This template creates an empty infrastructure-modules repository that will be used to store Terraform/OpenTofu modules that your organization has authored and intends to use within your organization.
20+
21+
### Infrastructure Pipelines Template
22+
23+
_[https://github.com/gruntwork-io/infrastructure-pipelines-template](https://github.com/gruntwork-io/infrastructure-pipelines-template)_
24+
25+
This template is only necessary if you plan on implementing [Gruntwork Pipelines](../pipelines).
26+
27+
File renamed without changes.
File renamed without changes.
File renamed without changes.

_docs-sources/foundations/iac/index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)