Skip to content

Commit 25ce143

Browse files
authored
Add a pipelines reference config overview page (#2144)
* Add a pipelines reference config overview page * add next steps
1 parent 193d318 commit 25ce143

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

docs/2.0/reference/pipelines/index.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
# Overview
22

3-
This page is under construction.
3+
## Configuration Language Transition
4+
5+
Pipelines configurations are currently undergoing a transition from YAML configurations to new HCL [Configurations as Code](./configurations-as-code.md). These new configurations will offer a richer configuration experience, but are not yet required for use. [YAML configurations](./configurations.md) will continue to work as expected for the time being.
6+
7+
YAML configurations are read by Pipelines when HCL configurations are not present, and the Pipelines binary falls back to interpretting YAML configurations as if they were defined in the HCL configuration system in this scenario.
8+
9+
This means that if you have a `.gruntwork/config.yml` file in your repository, you can continue to use it as you have been, and Pipelines will continue to work as expected.
10+
11+
If you do introduce any HCL configurations into your `.gruntwork` directory or introduce a `gruntwork.hcl` file into a directory, Pipelines will begin to use the HCL configuration system instead of the YAML configuration system.
12+
13+
## Authentication
14+
15+
Core pipelines functionally generally requires only a small amount of configuration. The most critical configuration for the CI/CD pipeline is how to authenticate with AWS, and that is covered in one of two ways:
16+
17+
* With the YAML system pipelines expects each top-level folder in the repository to correspond to an account in `accounts.hcl` and the existance of appropriate OIDC roles to enable pipeliens to assume the respective role for infra changes in those folders. As such, very little of the YAML configuration requires customization.
18+
19+
* With the HCL system users can flexibly configure pipelines to authenticate to various AWS accounts to match arbitrary folder structures. The bulk of the HCL configuration language we define is to support this flexibility.
20+
21+
## Other Configuration
22+
23+
Beyond authentication the main configuration options pertain to customizing Terragrunt execution - for example toggling experimental terragrunt features or configuring when/if to execute a `run` or a `run-all`. A full list of configuration is available in these reference pages for both configuration systems.
24+
25+
## Next Steps
26+
27+
* Review the [YAML Configurations](./configurations.md) Reference
28+
* Review the (Beta) [Configurations as Code](./configurations-as-code.md) Reference

sidebars/reference.js

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,19 @@ const sidebar = [
3131
label: "Gruntwork Pipelines",
3232
type: "category",
3333
collapsed: true,
34-
link: {
35-
type: "generated-index",
36-
title: "Pipelines reference",
37-
slug: "2.0/reference/pipelines",
38-
},
3934
items: [
4035
{
4136
label: "Overview",
4237
type: "doc",
4338
id: "2.0/reference/pipelines/index",
4439
},
4540
{
46-
label: "Configurations",
41+
label: "Configurations (YAML)",
4742
type: "doc",
4843
id: "2.0/reference/pipelines/configurations",
4944
},
5045
{
51-
label: "Configurations as Code (Beta)",
46+
label: "Configurations as Code (HCL - Beta)",
5247
type: "doc",
5348
id: "2.0/reference/pipelines/configurations-as-code",
5449
},

0 commit comments

Comments
 (0)