Skip to content
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.

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

Pipelines-section-4 : Changes to Pipelines / Guides files #2309

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
0daf25d
Update running-plan-apply.md
EdifyContent Jan 9, 2025
95704f6
Update managing-secrets.md
EdifyContent Jan 9, 2025
5faa554
Update updating-pipelines.md
EdifyContent Jan 9, 2025
35ae7ab
Update extending-pipelines.md
EdifyContent Jan 9, 2025
157b98f
Update installing-drift-detection.md
EdifyContent Jan 9, 2025
f4f5c9d
Update running-drift-detection.md
EdifyContent Jan 9, 2025
04c6b86
Update terragrunt-env-vars.md
EdifyContent Jan 9, 2025
a9b18fe
Update setup-delegated-repo.mdx
EdifyContent Jan 9, 2025
34bee95
Update upgrading-from-ecs-deploy-runner.md
EdifyContent Jan 9, 2025
6b69c74
Update upgrading-from-ecs-deploy-runner.md
EdifyContent Jan 9, 2025
f035c73
Update upgrading-from-ecs-deploy-runner.md
EdifyContent Jan 9, 2025
0fbc478
Update setup-delegated-repo.mdx
EdifyContent Jan 15, 2025
c92a12a
Update terragrunt-env-vars.md
EdifyContent Jan 15, 2025
3898dcc
Update running-drift-detection.md
EdifyContent Jan 15, 2025
8d404ca
Update running-drift-detection.md
EdifyContent Jan 15, 2025
4106b58
Update running-drift-detection.md
EdifyContent Jan 15, 2025
da48f75
Update running-drift-detection.md
EdifyContent Jan 15, 2025
1c73d39
Update managing-secrets.md
EdifyContent Jan 15, 2025
721d1db
Update running-plan-apply.md
EdifyContent Jan 15, 2025
ce0ce23
Update running-plan-apply.md
EdifyContent Jan 15, 2025
46954a3
Update extending-pipelines.md
EdifyContent Jan 16, 2025
758c9ee
Update extending-pipelines.md
EdifyContent Jan 16, 2025
9364a1b
Update extending-pipelines.md
EdifyContent Jan 16, 2025
640614c
Update installing-drift-detection.md
EdifyContent Jan 16, 2025
b00c93b
Update delegated-repositories.md
EdifyContent Jan 16, 2025
0f58187
Update index.md
EdifyContent Jan 16, 2025
7885123
Update modify-account.md
EdifyContent Jan 16, 2025
6bb3a04
Update remove-account.md
EdifyContent Jan 16, 2025
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
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Using this pattern core platform teams have the ability to:
* Enforce least-privilege access to IaC, restricting teams to have access only to IaC and deployment capability / role assumptions for resources that they are responsible for.

## Delegated Repository Creation
Delegated repositories are optionally created by [Account Factory](/2.0/docs/accountfactory/concepts) during account creation. A delegated account vend follows the following (automated) workflow:
Delegated repositories are optionally created by [Account Factory](/2.0/docs/accountfactory/concepts) during account creation. A delegated account vend follows the following (automated) workflow:

```mermaid
sequenceDiagram
Expand Down
2 changes: 1 addition & 1 deletion docs/2.0/docs/accountfactory/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Account Factory is automatically added to [new Pipelines root repositories](/2.0

Out of the box Account Factory has the following components:

- 📋 An HTML form for generating workflow inputs: `.github/workflows/account-factory-inputs.html`
- 📋 An HTML form for generating workflow inputs: `.github/workflows/account-factory-inputs.html`

- 🏭 A workflow for generating new requests: `.github/workflows/account-factory.yml`

Expand Down
2 changes: 0 additions & 2 deletions docs/2.0/docs/accountfactory/tutorials/modify-account.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# Modifying an AWS Account

Over time you will need to run various operations on your AWS accounts such as requesting new accounts, creating new accounts, renaming accounts, etc. With the Gruntwork Account Factory, some AWS account management operations should only be done using IaC, some can only be done using ClickOps, and some can be done using either.
Expand Down
4 changes: 1 addition & 3 deletions docs/2.0/docs/accountfactory/tutorials/remove-account.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# Removing an AWS Account

## Prerequisites
Expand All @@ -15,7 +13,7 @@ We recommend following a two step procedure to close AWS Accounts managed by Dev
1. [Cleanup Infrastructure Code](#1-cleanup-infrastructure-code) and modify OpenTofu/Terraform state for the Control Tower module.
1. [Close Account with Clickops](#2-close-the-accounts-in-aws-organizations)

We are recommending that accounts be closed with ClickOps instead of using Gruntwork Pipelines. Removing the account via pipelines by deleting the account request file can and often does work, however the underlying AWS Service Catalog that we use to interact with Control Tower and deprovision the account is not (https://github.com/hashicorp/terraform-provider-aws/issues/31705) and often returns spurious errors that can require multiple retries to complete successfully. The procedure here is fundamentally about working around that unreliability.
We are recommending that accounts be closed with ClickOps instead of using Gruntwork Pipelines. Removing the account via pipelines by deleting the account request file can and often does work, however the underlying AWS Service Catalog that we use to interact with Control Tower and deprovision the account is not (https://github.com/hashicorp/terraform-provider-aws/issues/31705) and often returns spurious errors that can require multiple retries to complete successfully. The procedure here is fundamentally about working around that unreliability.

### 1. Cleanup Infrastructure Code

Expand Down
86 changes: 45 additions & 41 deletions docs/2.0/docs/pipelines/guides/extending-pipelines.md

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/2.0/docs/pipelines/guides/installing-drift-detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,26 @@
import PersistentCheckbox from '/src/components/PersistentCheckbox';

:::note
Pipelines Drift Detection is only available to Devops Foundations Enterprise customers.
Pipelines Drift Detection is exclusively available to DevOps Foundations Enterprise customers.
:::

If you're creating new pipelines repositories using the latest version of Pipelines, then Drift Detection will be installed automatically without any action on your part.
For new pipelines repositories using the latest version of Pipelines, Drift Detection is installed automatically and requires no additional action.

If you want to upgrade an older repository to add Drift Detection perform the following steps:
To upgrade an existing repository and enable Drift Detection, follow these steps:

### Step 1 - Ensure the GitHub App is Installed
### Step 1 - Ensure the GitHub App is installed

Ensure you are using the [GitHub App](/2.0/docs/pipelines/installation/viagithubapp) in this repository. Drift Detection requires permissions from the GitHub App and is not available via machine user tokens.
Verify that the [GitHub App](/2.0/docs/pipelines/installation/viagithubapp) is installed and in use for this repository. Drift Detection relies on permissions granted by the GitHub App and is not compatible with machine user tokens.

<PersistentCheckbox id="install-drift-1" label="GitHub App In Use" />

### Step 2 - Setup the Workflow file
### Step 2 - Set up the workflow file

Create a new workflow file in your repository at `.github/workflows/pipelines-drift-detection.yml`
Create a new workflow file in your repository at `.github/workflows/pipelines-drift-detection.yml`.

This is the same directory where your other Pipelines workflows are located.
This directory is the same location as your other Pipelines workflows.

Add the following content to the workflow
Add the following content to the workflow:

```yml
name: Pipelines Drift Detection
Expand Down Expand Up @@ -51,7 +51,7 @@ jobs:
branch-name: ${{ inputs.branch-name }}
```

Commit the changes to the repository. If you are using [branch protection](/2.0/docs/pipelines/installation/branch-protection) (highly recommended) you will need to create a new pull request to add the workflow.
Commit the changes to the repository. If [branch protection](/2.0/docs/pipelines/installation/branch-protection) is enabled—which is strongly recommended—you must create a new pull request to incorporate the workflow into your repository.

<PersistentCheckbox id="install-drift-2" label="Workflow File Created" />

Expand Down
Loading