Skip to content

Commit 7407947

Browse files
authored
[APT-1620] Migrate How to Use Gruntwork Guide (#130)
* Replace links to legacy guide with links to new or updated sections in the docs site
1 parent d6d612f commit 7407947

File tree

64 files changed

+2023
-207
lines changed

Some content is hidden

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

64 files changed

+2023
-207
lines changed

_docs-sources/guides/build-it-yourself/2-landing-zone/3-deployment-walkthrough/0-pre-requisites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This walkthrough has the following pre-requisites:
1414

1515
This guide uses code from the [Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), as it
1616
implements most of the production-grade design for you out of the box. Make sure to read
17-
[How to use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
17+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
1818

1919
</div>
2020

@@ -31,7 +31,7 @@ You must be a <span className="js-subscribe-cta">Gruntwork subscriber</span> to
3131
This guide uses [Terraform](https://www.terraform.io/) to define and manage all the infrastructure as code. If you’re
3232
not familiar with Terraform, check out [A
3333
Comprehensive Guide to Terraform](https://blog.gruntwork.io/a-comprehensive-guide-to-terraform-b3d32832baca), [A Crash Course on Terraform](https://training.gruntwork.io/p/terraform), and
34-
[How to use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
34+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
3535

3636
#### Terragrunt
3737

_docs-sources/guides/build-it-yourself/2-landing-zone/3-deployment-walkthrough/1-prepare-your-infrastructure-live-repository.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
This guide uses [Terragrunt](https://github.com/gruntwork-io/terragrunt) and its associated file and folder
66
structure to deploy Terraform modules. Please note that **Terragrunt is NOT required for using Terraform modules from
7-
the Gruntwork Infrastructure as Code Library.** Check out [How to use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library)
7+
the Gruntwork Infrastructure as Code Library.** Check out our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork)
88
for instructions on alternative options, such as
9-
[deploying with plain Terraform](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#deploy_using_plain_terraform).
9+
[deploying with plain Terraform](/docs/intro/first-deployment/deploy#deploy-using-plain-terraform).
1010

1111
:::
1212

_docs-sources/guides/build-it-yourself/3-pipelines/3-deployment-walkthrough/0-pre-requisites.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This walkthrough has the following pre-requisites:
88

99
This guide uses code from the [Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), as it
1010
implements most of the production-grade design for you out of the box. Make sure to read
11-
[How to use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
11+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
1212

1313
</div>
1414

@@ -25,7 +25,7 @@ You must be a <span className="js-subscribe-cta">Gruntwork subscriber</span> to
2525
This guide uses [Terraform](https://www.terraform.io/) to define and manage all the infrastructure as code. If you’re
2626
not familiar with Terraform, check out [A
2727
Comprehensive Guide to Terraform](https://blog.gruntwork.io/a-comprehensive-guide-to-terraform-b3d32832baca), [A Crash Course on Terraform](https://training.gruntwork.io/p/terraform), and
28-
[How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library)
28+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork)
2929

3030
#### CircleCI
3131

@@ -44,12 +44,14 @@ for instructions.
4444

4545
#### Repository structure
4646

47-
This guide assumes your infrastructure code is organized in a manner similar to that covered in the
48-
[Using
49-
Terraform Modules section of the How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library/#using_terraform_modules) guide. This means that you
50-
should have two repositories for your infrastructure code, `infrastructure-modules` and `infrastructure-live`. Make
51-
sure that the `infrastructure-live` repository is locked down as recommended in [Lock down VCS systems](../2-production-grade-design/7-lock-down-vcs-systems.md). This guide
52-
will assume that `master` is the protected branch where infrastructure is deployed from.
47+
This guide assumes your infrastructure code is organized in a manner similar to
48+
that covered in the [Prepare Your Module](/docs/intro/first-deployment/using-terraform-modules) introduction section. This means
49+
that you should have two repositories for your infrastructure code,
50+
`infrastructure-modules` and `infrastructure-live`. Make sure that the
51+
`infrastructure-live` repository is locked down as recommended in [Lock down VCS
52+
systems](../2-production-grade-design/7-lock-down-vcs-systems.md). This guide
53+
will assume that `master` is the protected branch where infrastructure is
54+
deployed from.
5355

5456
</div>
5557

@@ -58,8 +60,8 @@ will assume that `master` is the protected branch where infrastructure is deploy
5860
This guide will use [Terragrunt](https://github.com/gruntwork-io/terragrunt) and its associated file and folder
5961
structure to deploy Terraform modules. Please note that **Terragrunt is NOT required for using Terraform modules from
6062
the Gruntwork Infrastructure as Code Library.** Check out
61-
[How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library/) for instructions
63+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork) for instructions
6264
on alternative options, such as how to
63-
[Deploy using plain Terraform](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library/#deploy_using_plain_terraform).
65+
[Deploy using plain Terraform](/docs/intro/first-deployment/deploy#deploy-using-plain-terraform).
6466

6567
:::

_docs-sources/guides/build-it-yourself/3-pipelines/3-deployment-walkthrough/2-deploy-the-ecs-deploy-runner.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ output "url" {
125125
```
126126

127127
At this point, you’ll want to test your code. See
128-
[Manual tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#manual_tests_terraform)
128+
[Manual tests for Terraform code](/docs/intro/first-deployment/testing#manual-tests-for-terraform-code)
129129
and
130-
[Automated tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#automated_tests_terraform)
130+
[Automated tests for Terraform code](/docs/intro/first-deployment/testing#automated-tests-for-terraform-code)
131131
for instructions.
132132

133133
Once your `ecr-repo` module is working the way you want, submit a pull request, get your changes merged into the

_docs-sources/guides/build-it-yourself/4-vpc/3-deployment-walkthrough/0-pre-requisites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This walkthrough has the following pre-requisites:
1212

1313
This guide uses code from the [Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), as it
1414
implements most of the production-grade design for you out of the box. Make sure to read
15-
[How to use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
15+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
1616

1717
</div>
1818

@@ -29,7 +29,7 @@ You must be a <span className="js-subscribe-cta">Gruntwork subscriber</span> to
2929
This guide uses [Terraform](https://www.terraform.io/) to define and manage all the infrastructure as code. If you’re
3030
not familiar with Terraform, check out [A
3131
Comprehensive Guide to Terraform](https://blog.gruntwork.io/a-comprehensive-guide-to-terraform-b3d32832baca), [A Crash Course on Terraform](https://training.gruntwork.io/p/terraform), and
32-
[How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library)
32+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork)
3333

3434
#### AWS accounts
3535

_docs-sources/guides/build-it-yourself/4-vpc/3-deployment-walkthrough/1-deploy-a-management-vpc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ file for reference.
103103

104104
## Test your wrapper module
105105

106-
At this point, you’ll want to test your code. See [Manual tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#manual_tests_terraform)
107-
and [Automated tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#automated_tests_terraform)
106+
At this point, you’ll want to test your code. See [Manual tests for Terraform code](/docs/intro/first-deployment/testing#manual-tests-for-terraform-code)
107+
and [Automated tests for Terraform code](/docs/intro/first-deployment/testing#automated-tests-for-terraform-code)
108108
for instructions.
109109

110110
## Merge and release your wrapper module
@@ -149,9 +149,9 @@ route table entries, more bastion hosts, and more credentials.
149149

150150
This guide will use [Terragrunt](https://github.com/gruntwork-io/terragrunt) and its associated file and folder
151151
structure to deploy Terraform modules. Please note that **Terragrunt is NOT required for using Terraform modules from
152-
the Gruntwork Infrastructure as Code Library.** Check out [How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library)
152+
the Gruntwork Infrastructure as Code Library.** Check out our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork)
153153
for instructions on alternative options, such as how to
154-
[deploy using plain terraform](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#deploy_using_plain_terraform).
154+
[deploy using plain terraform](/docs/intro/first-deployment/deploy#deploy-using-plain-terraform).
155155

156156
:::
157157

_docs-sources/guides/build-it-yourself/4-vpc/3-deployment-walkthrough/2-deploy-application-vp-cs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ file for reference.
171171

172172
## Test your wrapper module
173173

174-
At this point, you’ll want to test your code. See [Manual tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#manual_tests_terraform)
175-
and [Automated tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#automated_tests_terraform)
174+
At this point, you’ll want to test your code. See [Manual tests for Terraform code](/docs/intro/first-deployment/testing#manual-tests-for-terraform-code)
175+
and [Automated tests for Terraform code](/docs/intro/first-deployment/testing#automated-tests-for-terraform-code)
176176
for instructions.
177177

178178
## Merge and release your wrapper module

_docs-sources/guides/build-it-yourself/5-kubernetes-cluster/3-deployment-walkthrough/0-pre-requisites.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This walkthrough has the following pre-requisites:
1414

1515
This guide uses code from the [Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), as it
1616
implements most of the production-grade design for you out of the box. Make sure to read
17-
[How to use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
17+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
1818

1919
</div>
2020

@@ -31,7 +31,7 @@ You must be a <span className="js-subscribe-cta">Gruntwork subscriber</span> to
3131
This guide uses [Terraform](https://www.terraform.io/) to define and manage all the infrastructure as code. If you’re
3232
not familiar with Terraform, check out [A
3333
Comprehensive Guide to Terraform](https://blog.gruntwork.io/a-comprehensive-guide-to-terraform-b3d32832baca), [A Crash Course on Terraform](https://training.gruntwork.io/p/terraform), and
34-
[How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
34+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
3535

3636
#### Python and Kubergrunt
3737

@@ -44,7 +44,7 @@ Python and `kubergrunt` installed on any computer where you will be running Terr
4444
This guide assumes you are deploying a Kubernetes cluster for use with [Docker](https://www.docker.com). The guide also
4545
uses [Packer](https://www.packer.io) to build VM images. If you’re not familiar with Docker or Packer, check out
4646
[A Crash Course on Docker and Packer](https://training.gruntwork.io/p/a-crash-course-on-docker-packer) and
47-
[How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library).
47+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork).
4848

4949
#### AWS accounts
5050

_docs-sources/guides/build-it-yourself/5-kubernetes-cluster/3-deployment-walkthrough/1-deploy-the-vpc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ module "dns_mgmt_to_app" {
107107
```
108108

109109
At this point, you’ll want to test your code. See
110-
[Manual tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#manual_tests_terraform)
110+
[Manual tests for Terraform code](/docs/intro/first-deployment/testing#manual-tests-for-terraform-code)
111111
and
112-
[Automated tests for Terraform code](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#automated_tests_terraform)
112+
[Automated tests for Terraform code](/docs/intro/first-deployment/testing#automated-tests-for-terraform-code)
113113
for instructions.
114114

115115
Once your updated `vpc-app` wrapper module is working the way you want, submit a pull request, get your changes merged
@@ -126,9 +126,9 @@ git push --follow-tags
126126
This guide will use [Terragrunt](https://github.com/gruntwork-io/terragrunt) and its associated file and folder
127127
structure to deploy Terraform modules. Please note that **Terragrunt is NOT required for using Terraform modules from
128128
the Gruntwork Infrastructure as Code Library.** Check out
129-
[How to Use the Gruntwork Infrastructure as Code Library](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library) for instructions
129+
our [Introduction to Gruntwork](/docs/intro/overview/intro-to-gruntwork) for instructions
130130
on alternative options, such as how to
131-
[Deploy using plain Terraform](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library#deploy_using_plain_terraform).
131+
[Deploy using plain Terraform](/docs/intro/first-deployment/deploy#deploy-using-plain-terraform).
132132

133133
:::
134134

_docs-sources/guides/build-it-yourself/6-achieve-compliance/2-production-grade-design/0-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pagination_label: Production-grade Design
66

77
In [core concepts](../1-core-concepts/0-intro.md) we discussed the basics of the AWS Foundations Benchmark. Although it's possible to achieve
88
compliance with the Benchmark by manually configuring each setting in the web console or entering the CLI commands, we
9-
strongly discourage this approach. It precludes [the myriad benefits of using code to manage infrastructure](https://gruntwork.io/guides/foundations/how-to-use-gruntwork-infrastructure-as-code-library/#infrastructure-as-code).
9+
strongly discourage this approach. It precludes [the myriad benefits of using code to manage infrastructure](/docs/intro/core-concepts/infrastructure-as-code).
1010

1111
Instead, we advise using [Terraform](https://www.terraform.io) (or similar tools, such as
1212
[CloudFormation](https://aws.amazon.com/cloudformation/) or [Pulumi](https://www.pulumi.com/) to configure cloud

0 commit comments

Comments
 (0)