Skip to content

Commit

Permalink
Replace all instances of "Gruntwork Library" with "Gruntwork IaC Libr…
Browse files Browse the repository at this point in the history
…ary" (#2216)

* Replace all instances of "Gruntwork Library" with "Gruntwork IaC Library"

* Rename sidebar label.

* Revert errant file updates.
  • Loading branch information
josh-padnick authored Nov 22, 2024
1 parent 55cafa6 commit b13239b
Show file tree
Hide file tree
Showing 20 changed files with 31 additions and 31 deletions.
4 changes: 2 additions & 2 deletions docs/2.0/docs/accountfactory/architecture/network-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Gruntwork will generate the IaC code you need to set up our standard, recommende

## Extending the standard VPC

You can extend this configuration by using the "building block" modules from the VPC topic in the Gruntwork Library to further extend your VPC, adding functionality such as:
You can extend this configuration by using the "building block" modules from the VPC topic in the Gruntwork IaC Library to further extend your VPC, adding functionality such as:

- [Enabling IPv6](/reference/modules/terraform-aws-vpc/vpc-app/#ipv6-design)
- [Adding a Transit Gateway](/reference/modules/terraform-aws-vpc/transit-gateway/)
- [Enabling DNS forwarding](/reference/modules/terraform-aws-vpc/vpc-dns-forwarder/)
- [Setting up Tailscale](/reference/services/security/tailscale-subnet-router)

This is done by directly working with the Terraform modules from Gruntwork Library to accomplish the particular configuration you need.
This is done by directly working with the OpenTofu/Terraform modules from Gruntwork IaC Library to accomplish the particular configuration you need.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Compatibility with OpenTofu and Terraform

All code in Gruntwork Library is compatible with:
All code in Gruntwork IaC Library is compatible with:

- All versions of [OpenTofu](https://opentofu.org/)
- HashiCorp Terraform versions v1.5.7 and below
Expand All @@ -17,7 +17,7 @@ This is the last version of HashiCorp Terraform that is licensed under the MPLv2

Going forward, we recommend that all Gruntwork customers adopt [OpenTofu](https://opentofu.org/) as a "drop-in" replacement for HashiCorp Terraform. We will be developing against OpenTofu releases, testing for compatibility with OpenTofu, and offering full support for any issues you experience with our modules and OpenTofu.

## As a user of Gruntwork Library, do I need to change anything?
## As a user of Gruntwork IaC Library, do I need to change anything?

No. You can continue using any version of HashiCorp Terraform up to and including v1.5.7.

Expand Down
2 changes: 1 addition & 1 deletion docs/2.0/docs/library/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The code in the `terraform-aws-service-catalog` repo is organized into three pri

<OpenTofuNotice />

Gruntwork Library has been created using the following tools:
Gruntwork IaC Library has been created using the following tools:

1. [Terraform](https://www.terraform.io/). The Library contains nearly 300 Terraform modules that cover a range of common use cases in AWS. All library modules can be used with vanilla [Terraform](https://www.terraform.io/)[Terragrunt](https://terragrunt.gruntwork.io/), or third-party Terraform pipeline tools such as [Terraform Cloud](https://www.hashicorp.com/blog/announcing-terraform-cloud/) and [Terraform Enterprise](https://www.terraform.io/docs/enterprise/index.html).

Expand Down
6 changes: 3 additions & 3 deletions docs/2.0/docs/library/concepts/overview.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import OpenTofuNotice from "/src/components/OpenTofuNotice"

# Gruntwork Library
# Gruntwork IaC Library

Gruntwork Library (formerly known as the "Gruntwork IaC Library") is a collection of reusable Infrastructure as Code (IaC) modules that enables you to deploy and manage infrastructure quickly and reliably.
Gruntwork IaC Library is a collection of reusable Infrastructure as Code (IaC) modules that enables you to deploy and manage infrastructure quickly and reliably.

It promotes code reusability, modularity, and consistency in infrastructure deployments. Essentially, we’ve taken the thousands of hours we spent building infrastructure on AWS and condensed all that experience and code into pre-built modules you can deploy into your own infrastructure.

## Two types of modules

Gruntwork Library contains two types of modules:
Gruntwork IaC Library contains two types of modules:

### "Building block" modules

Expand Down
4 changes: 2 additions & 2 deletions docs/2.0/docs/library/guides/contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Gruntwork Library
# Contributing to Gruntwork IaC Library

Contributions to Gruntwork Library are welcome and appreciated! In fact, Gruntwork receives over 1,000 customer [pull requests](https://help.github.com/articles/about-pull-requests/) per year.
Contributions to Gruntwork IaC Library are welcome and appreciated! In fact, Gruntwork receives over 1,000 customer [pull requests](https://help.github.com/articles/about-pull-requests/) per year.

You can contribute to the library in several ways:

Expand Down
6 changes: 3 additions & 3 deletions docs/2.0/docs/library/guides/integrate-tfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This section will cover how to use Gruntwork in conjunction with two popular HashiCorp products: [Terraform Cloud (TFC)](https://www.terraform.io/docs/cloud/index.html) and [Terraform Enterprise (TFE)](https://www.terraform.io/docs/enterprise/index.html). Although the open source edition of Terraform is quite powerful and flexible as a standalone project, many organizations turn to TFC/TFE for the CLI/UI integration, approval-based workflow capabilities, Sentinel policy framework, and more. At its core, Terraform Enterprise is basically Terraform Cloud repackaged for a self-hosted environment. We’ll use "TFC" as short hand for both Terraform Cloud and Enterprise throughout this guide.

In our guide on [Customizing Modules](/2.0/docs/library/tutorials/customizing-modules) we describe how to use Gruntwork with two VCS repositories: `infrastructure-modules`, containing your Terraform code that wraps the modules from Gruntwork Library, and `infrastructure-live`, containing Terragrunt configurations that enable you to manage Terraform easily across multiple accounts and environments. When using Gruntwork with TFC, you have two choices regarding these repositories:
In our guide on [Customizing Modules](/2.0/docs/library/tutorials/customizing-modules) we describe how to use Gruntwork with two VCS repositories: `infrastructure-modules`, containing your OpenTofu/Terraform code that wraps the modules from Gruntwork IaC Library, and `infrastructure-live`, containing Terragrunt configurations that enable you to manage Terraform easily across multiple accounts and environments. When using Gruntwork with TFC, you have two choices regarding these repositories:

<div className="dlist">

Expand Down Expand Up @@ -159,9 +159,9 @@ commit to a file in the working directory that you set up when configuring works

![TFC run results](/img/guides/working-with-code/tfc/tfc-run.png)

### Final thoughts on integrating TFC with the Gruntwork library
### Final thoughts on integrating TFC with the Gruntwork IaC Library

It’s easy to use TFC with the Gruntwork library. When using the `infrastructure-modules` approach outlined in this
It’s easy to use TFC with the Gruntwork IaC Library. When using the `infrastructure-modules` approach outlined in this
guide, all of your Terraform wrapper modules will be in one place. You can configure one workspace per module, and you
can link modules together with the [`remote_state`
data source](https://www.terraform.io/docs/providers/terraform/d/remote_state.html). Note that you’ll need to set up the AWS credentials and SSH key within each workspace.
Expand Down
6 changes: 3 additions & 3 deletions docs/2.0/docs/library/guides/self-hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

:::caution

Self-hosting Gruntwork Library is only available with a Gruntwork Enterprise subscription.
Self-hosting Gruntwork IaC Library is only available with a Gruntwork Enterprise subscription.

:::

We recommend accessing Gruntwork Library directly through our private repos hosted at https://github.com/gruntwork-io. However if your company requires that all Terraform modules are hosted internally, we offer a tool called [repo-copier](https://github.com/gruntwork-io/repo-copier) to support this use case.
We recommend accessing Gruntwork IaC Library directly through our private repos hosted at https://github.com/gruntwork-io. However if your company requires that all Terraform modules are hosted internally, we offer a tool called [repo-copier](https://github.com/gruntwork-io/repo-copier) to support this use case.

## What is repo-copier?

Repo Copier is a CLI tool that copies all the data in our private GitHub repos (including code, GitHub issues, GitHub pull requests, and releases) to a version control system operated by you, the customer. This gives you full access to Gruntwork Library without having to use GitHub.com directly. To learn more, see https://github.com/gruntwork-io/repo-copier.
Repo Copier is a CLI tool that copies all the data in our private GitHub repos (including code, GitHub issues, GitHub pull requests, and releases) to a version control system operated by you, the customer. This gives you full access to Gruntwork IaC Library without having to use GitHub.com directly. To learn more, see https://github.com/gruntwork-io/repo-copier.

## What version control systems are supported?

Expand Down
2 changes: 1 addition & 1 deletion docs/2.0/docs/overview/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ As part of your Pipelines installation, you will now have Gruntwork Account Fact

### Step 6: Start Using DevOps Foundations

Thats it! You're ready to [build with Gruntwork Library](/2.0/docs/library/tutorials/deploying-your-first-gruntwork-module) automatically [plan and apply IaC changes with Pipelines](/2.0/docs/pipelines/guides/running-plan-apply), [vend new AWS Accounts with Account Factory](/2.0/docs/accountfactory/guides/vend-aws-account), and [keep your infrastructure up to date with Patcher](/2.0/docs/patcher/concepts/).
Thats it! You're ready to [build with Gruntwork IaC Library](/2.0/docs/library/tutorials/deploying-your-first-gruntwork-module) automatically [plan and apply IaC changes with Pipelines](/2.0/docs/pipelines/guides/running-plan-apply), [vend new AWS Accounts with Account Factory](/2.0/docs/accountfactory/guides/vend-aws-account), and [keep your infrastructure up to date with Patcher](/2.0/docs/patcher/concepts/).
2 changes: 1 addition & 1 deletion docs/2.0/docs/patcher/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Gruntwork Patcher helps you automatically keep your infrastructure code ([Terrag

Without Patcher, the manual process of discovering updates and determining if they can be safely applied can take hours of an engineer's time for each module dependency.

You can use Patcher to maintain your dependencies on the Gruntwork Library which includes patches for recent breaking changes to Gruntwork modules. Patcher can also be used to update dependencies on your own modules and dependencies on open source modules using semantic versioning to decide which versions can be safely updated and which require manual intervention.
You can use Patcher to maintain your dependencies on the Gruntwork IaC Library which includes patches for recent breaking changes to Gruntwork modules. Patcher can also be used to update dependencies on your own modules and dependencies on open source modules using semantic versioning to decide which versions can be safely updated and which require manual intervention.

Gruntwork Patcher provides a straightforward README driven workflow for use when applying breaking changes that don't have patches. Patcher updates the dependency to the version with a breaking changes, generates a README file into the folder that contains the file that has been updated, and then stops. The README will contain the release note for the breaking change. The user reads the README file, takes any action that is required and then deletes the README file before running Patcher again.
2 changes: 1 addition & 1 deletion docs/2.0/docs/pipelines/architecture/security-controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This encourages a dialogue between the individuals responsible for defining crit

Gruntwork Pipelines (when setup via Machine Users and not the GitHub App) uses a series of GitHub Personal Access Tokens (PAT) to allow cross-repository code and workflow access. This approach ensures that each token has the minimal required permissions to perform its tasks. The full list of tokens and required permissions are listed below.

- `PIPELINES_READ_TOKEN` - A [classic PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) with repository read access to your `infrastructure-live` and `infrastructure-modules` repositories, as well as Gruntwork Library modules and the Pipelines CLI.
- `PIPELINES_READ_TOKEN` - A [classic PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) with repository read access to your `infrastructure-live` and `infrastructure-modules` repositories, as well as Gruntwork IaC Library modules and the Pipelines CLI.
- `INFRA_ROOT_WRITE_TOKEN` - A [fine-grained PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) that has read and write access to your `infrastructure-live-root` repository. This token is used in Pipelines to create pull requests after code generation and add pull request comments.
- `ORG_REPO_ADMIN_TOKEN` - A fine-grained PAT that can update all repositories in your GitHub organization. It is used by Pipelines to do the following:
- Bootstrap repositories during DevOps Foundations setup. If you are a DevOps Foundations Teams customer, you can delete this token once it is no longer needed.
Expand Down
4 changes: 2 additions & 2 deletions docs/2.0/docs/pipelines/installation/viamachineusers.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,9 @@ Create the following access tokens in the `ci-user`'s GitHub account:

### ci-read-only-user

This user is created to download private software within GitHub Actions Workflows. The `ci-read-only-user` is used to access Gruntwork Library modules, your own `infrastructure-modules` repository, any other custom module repositories that are private and the Pipelines CLI itself.
This user is created to download private software within GitHub Actions Workflows. The `ci-read-only-user` is used to access Gruntwork IaC Library modules, your own `infrastructure-modules` repository, any other custom module repositories that are private and the Pipelines CLI itself.

The `ci-read-only-user` should have a single classic [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) with read permissions. Classic PATs have coarse granularity, we recommend putting this user in a GitHub team that only has READ access to `infrastructure-live-root` and any relevant module repositories in your own GitHub Organization. By adding this user to the Gruntwork Developer portal, they will automatically gain access to the Gruntwork Library.
The `ci-read-only-user` should have a single classic [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) with read permissions. Classic PATs have coarse granularity, we recommend putting this user in a GitHub team that only has READ access to `infrastructure-live-root` and any relevant module repositories in your own GitHub Organization. By adding this user to the Gruntwork Developer portal, they will automatically gain access to the Gruntwork IaC Library.

**Invite the `ci-read-only-user` to your repository**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ changes look like, please refer to these pull requests in the Acme CIS Reference

To update to the CIS AWS Foundations Benchmark v1.3.0, you need to update your references to the Gruntwork
Infrastructure as Code Library to use compatible versions. We (Gruntwork) have reviewed and updated all the library modules for compatibility with the new version of the Benchmark. As a customer, you need to update to
the proper versions of the Gruntwork library to pick up the fixes/changes made to be compatible. Refer to
the proper versions of the Gruntwork IaC Library to pick up the fixes/changes made to be compatible. Refer to
[the
"Updating to new versions" section of "Stay Up to Date"](/library/stay-up-to-date/updating) for instructions on how to update the
versions in your code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Update references to the Gruntwork Infrastructure as Code Library
To update to the CIS AWS Foundations Benchmark v1.4.0, you need to update your references to the Gruntwork
Infrastructure as Code Library to use compatible versions. We (Gruntwork) have reviewed and updated all the library
modules for compatibility with the new version of the benchmark. As a customer, you need to update to
the proper versions of the Gruntwork library to pick up the fixes/changes made to be compatible. Refer to our ["Updating to new versions"](/library/stay-up-to-date/updating) guide for instructions on how to update the
the proper versions of the Gruntwork IaC Library to pick up the fixes/changes made to be compatible. Refer to our ["Updating to new versions"](/library/stay-up-to-date/updating) guide for instructions on how to update the
versions in your code.

Gruntwork follows
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Update references to the Gruntwork Infrastructure as Code Library
To update to the CIS AWS Foundations Benchmark v1.5.0, you need to update your references to the Gruntwork
Infrastructure as Code Library to use compatible versions. We (Gruntwork) have reviewed and updated all the library
modules for compatibility with the new version of the benchmark. As a customer, you need to update to the correct
versions of the Gruntwork library to pick up the changes necessary for your infrastructure to be compatible.
versions of the Gruntwork IaC Library to pick up the changes necessary for your infrastructure to be compatible.

The following table provides a summary of all the relevant Gruntwork AWS modules and the respective versions that are
compatible with CIS AWS v1.5.0:
Expand Down Expand Up @@ -65,7 +65,7 @@ compatible with CIS AWS v1.5.0:
## 2A Updating with Patcher

Beginning with CIS AWS Foundations Benchmark v1.5.0, Gruntwork is providing an automated way update to the correct
versions of Gruntwork's CIS Reference Architecture (part of the Gruntwork library) using a tool we call Patcher.
versions of Gruntwork's CIS Reference Architecture (part of the Gruntwork IaC Library) using a tool we call Patcher.

<a id="patcher-compatibility-table" class="snap-top"></a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
In order to take advantage of the Terraform AWS provider version 3, you need to update your references to the Gruntwork
Infrastructure as Code Library to use a compatible version. We (Gruntwork) have gone through all our modules in the
library to test and update the code to be compatible with AWS provider version 3. As a customer, you need to update to
the proper versions of the Gruntwork library to pick up the fixes/changes that were made to be compatible. Be sure to
the proper versions of the Gruntwork IaC Library to pick up the fixes/changes that were made to be compatible. Be sure to
read the release notes to know what changes need to be made to update to that version.

Refer to our ["Updating to new versions"](/library/stay-up-to-date/updating) guide
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
In order to take advantage of the Terraform AWS provider version 4, you need to update your references to the Gruntwork
Infrastructure as Code Library to use a compatible version. We (Gruntwork) have gone through all our modules in the
library to test and update the code to be compatible with AWS provider version 4. As a customer, you need to update to
the proper versions of the Gruntwork library to pick up the fixes/changes that were made to be compatible. Be sure to
the proper versions of the Gruntwork IaC Library to pick up the fixes/changes that were made to be compatible. Be sure to
read the release notes to know what changes need to be made to update to that version.

Refer to our guide on ["Updating to new versions"](/library/stay-up-to-date/updating)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to take advantage of the Terraform 1.1, you need to update your
references to the Gruntwork Infrastructure as Code Library to use a compatible
version. We (Gruntwork) have gone through all our modules in the library to test
and update the code to be compatible with Terraform 1.1. As a customer, you need
to update to the proper versions of the Gruntwork library to pick up the
to update to the proper versions of the Gruntwork IaC Library to pick up the
fixes/changes that we made to be compatible. Refer to [Updating Modules](/2.0/docs/library/guides/updating-modules)
for instructions on how to update the versions in your code.

Expand Down
Loading

0 comments on commit b13239b

Please sign in to comment.