Skip to content

Commit 2282354

Browse files
ebeneliasonebeneliason
authored
[APT-1980] [WIP] Add links to our CLI tools (#552)
* Add a tools page with links to (some of) our CLI tools
1 parent 8370b89 commit 2282354

File tree

9 files changed

+136
-32
lines changed

9 files changed

+136
-32
lines changed

‎_docs-sources/intro/tool-fundamentals/terragrunt.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Terragrunt
22

3-
[Terragrunt](https://github.com/gruntwork-io/terragrunt) is a thin, open source wrapper for Terraform. It is designed to
3+
[Terragrunt](https://terragrunt.gruntwork.io) is a thin, open source wrapper for Terraform. It is designed to
44
fill in some missing features in Terraform, such as allowing you to define your Terraform backend configuration in
55
one `terragrunt.hcl` file, rather than having to copy/paste the same config over and over again:
66

@@ -22,13 +22,10 @@ Once you've created your `terragrunt.hcl` configuration, you can run all the usu
2222
[Terragrunt: how to keep your Terraform code DRY and maintainable](https://blog.gruntwork.io/terragrunt-how-to-keep-your-terraform-code-dry-and-maintainable-f61ae06959d8)
2323
for a thorough introduction.
2424

25-
2625
:::note
2726

2827
While the Gruntwork Reference Architecture relies on Terragrunt as one of its opinionated tools, the
2928
Gruntwork Infrastructure as Code Library does NOT require Terragrunt; you can use the Terraform modules in the Gruntwork
3029
Infrastructure as Code Library with plain Terraform, Terraform Enterprise, Atlantis, Terragrunt, or any other tools you prefer.
3130

3231
:::
33-
34-

‎_docs-sources/reference/tools/stub.md

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

‎_docs-sources/tools.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
hide_table_of_contents: true
3+
hide_title: true
4+
---
5+
6+
import Card from "/src/components/Card"
7+
import CardGroup from "/src/components/CardGroup"
8+
import CenterLayout from "/src/components/CenterLayout"
9+
10+
<CenterLayout>
11+
12+
# Gruntwork Tools
13+
14+
Gruntwork provides a suite of CLI tools to make working with Gruntwork and its IaC library modules easier.
15+
16+
<CardGroup cols={2}>
17+
18+
<Card
19+
title="Gruntwork CLI"
20+
href="https://github.com/gruntwork-io/gruntwork">
21+
The Gruntwork CLI will help you set up your Reference Architecture including creating AWS accounts, registering domain names, and setting up VCS tokens in AWS Secrets Manager.
22+
</Card>
23+
<Card
24+
title="Gruntwork Installer"
25+
href="https://github.com/gruntwork-io/gruntwork-installer">
26+
The Gruntwork Installer provides conveniences for downloading and installing Gruntwork modules.
27+
</Card>
28+
<Card
29+
title="Terragrunt"
30+
href="https://terragrunt.gruntwork.io">
31+
Terragrunt is a thin wrapper that provides extra tools for keeping your Terraform configurations DRY, working with multiple modules, and managing remote state.
32+
</Card>
33+
<Card
34+
title="Terratest"
35+
href="https://terratest.gruntwork.io">
36+
Terratest is a Go library that provides patterns and helper functions for testing infrastructure, with 1st-class support for Terraform, Packer, Docker, Kubernetes, AWS, GCP, and more.
37+
</Card>
38+
<Card
39+
title="Repo Copier"
40+
href="https://github.com/gruntwork-io/repo-copier"
41+
tags={["enterprise"]}>
42+
Repo Copier is a CLI tool to copy repository data (including code, issues, PRs, releases, etc) from Gruntwork's GitHub organization to a customer's version control system.
43+
</Card>
44+
45+
</CardGroup>
46+
47+
</CenterLayout>

‎docs/intro/tool-fundamentals/terragrunt.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Terragrunt
22

3-
[Terragrunt](https://github.com/gruntwork-io/terragrunt) is a thin, open source wrapper for Terraform. It is designed to
3+
[Terragrunt](https://terragrunt.gruntwork.io) is a thin, open source wrapper for Terraform. It is designed to
44
fill in some missing features in Terraform, such as allowing you to define your Terraform backend configuration in
55
one `terragrunt.hcl` file, rather than having to copy/paste the same config over and over again:
66

@@ -22,7 +22,6 @@ Once you've created your `terragrunt.hcl` configuration, you can run all the usu
2222
[Terragrunt: how to keep your Terraform code DRY and maintainable](https://blog.gruntwork.io/terragrunt-how-to-keep-your-terraform-code-dry-and-maintainable-f61ae06959d8)
2323
for a thorough introduction.
2424

25-
2625
:::note
2726

2827
While the Gruntwork Reference Architecture relies on Terragrunt as one of its opinionated tools, the
@@ -32,11 +31,9 @@ Infrastructure as Code Library with plain Terraform, Terraform Enterprise, Atlan
3231
:::
3332

3433

35-
36-
3734
<!-- ##DOCS-SOURCER-START
3835
{
3936
"sourcePlugin": "local-copier",
40-
"hash": "e917fe5423fd33a6c7c528e404a75f40"
37+
"hash": "66b4546e1b2cacd7b6bdb6db216d5bf9"
4138
}
4239
##DOCS-SOURCER-END -->

‎docs/reference/tools/stub.md

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

‎docs/tools.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
hide_table_of_contents: true
3+
hide_title: true
4+
---
5+
6+
import Card from "/src/components/Card"
7+
import CardGroup from "/src/components/CardGroup"
8+
import CenterLayout from "/src/components/CenterLayout"
9+
10+
<CenterLayout>
11+
12+
# Gruntwork Tools
13+
14+
Gruntwork provides a suite of CLI tools to make working with Gruntwork and its IaC library modules easier.
15+
16+
<CardGroup cols={2}>
17+
18+
<Card
19+
title="Gruntwork CLI"
20+
href="https://github.com/gruntwork-io/gruntwork">
21+
The Gruntwork CLI will help you set up your Reference Architecture including creating AWS accounts, registering domain names, and setting up VCS tokens in AWS Secrets Manager.
22+
</Card>
23+
<Card
24+
title="Gruntwork Installer"
25+
href="https://github.com/gruntwork-io/gruntwork-installer">
26+
The Gruntwork Installer provides conveniences for downloading and installing Gruntwork modules.
27+
</Card>
28+
<Card
29+
title="Terragrunt"
30+
href="https://terragrunt.gruntwork.io">
31+
Terragrunt is a thin wrapper that provides extra tools for keeping your Terraform configurations DRY, working with multiple modules, and managing remote state.
32+
</Card>
33+
<Card
34+
title="Terratest"
35+
href="https://terratest.gruntwork.io">
36+
Terratest is a Go library that provides patterns and helper functions for testing infrastructure, with 1st-class support for Terraform, Packer, Docker, Kubernetes, AWS, GCP, and more.
37+
</Card>
38+
<Card
39+
title="Repo Copier"
40+
href="https://github.com/gruntwork-io/repo-copier"
41+
tags={["enterprise"]}>
42+
Repo Copier is a CLI tool to copy repository data (including code, issues, PRs, releases, etc) from Gruntwork's GitHub organization to a customer's version control system.
43+
</Card>
44+
45+
</CardGroup>
46+
47+
</CenterLayout>
48+
49+
50+
<!-- ##DOCS-SOURCER-START
51+
{
52+
"sourcePlugin": "local-copier",
53+
"hash": "9163aa4a6f27ddea984ff8f78e22e44b"
54+
}
55+
##DOCS-SOURCER-END -->

‎docusaurus.config.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ const config = {
106106
label: "Service Catalog API",
107107
docId: "reference/services/intro/overview",
108108
},
109+
{ to: "/tools", label: "Tools", position: "left" },
109110
{ to: "/courses", label: "Courses", position: "left" },
110111
{
111112
href: "https://github.com/gruntwork-io/knowledge-base/discussions",
@@ -204,6 +205,14 @@ const config = {
204205
label: "DevOps Checklist",
205206
href: "https://gruntwork.io/devops-checklist/",
206207
},
208+
{
209+
label: "Terragrunt",
210+
href: "https://terragrunt.gruntwork.io",
211+
},
212+
{
213+
label: "Terratest",
214+
href: "https://terratest.gruntwork.io",
215+
},
207216
{
208217
label: "Support",
209218
href: "/support",

‎sidebars/api-reference.js

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ const sidebars = {
1414
label: "Module APIs",
1515
id: "reference/modules/stub",
1616
},
17-
{
18-
type: "ref",
19-
label: "Tools",
20-
id: "reference/tools/stub",
21-
},
2217
],
2318
modulesSidebar: [{ type: "autogenerated", dirName: "reference/modules" }],
2419
servicesSidebar: [

‎src/pages/index.tsx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,28 @@ export default function Home(): JSX.Element {
102102
</Card>
103103
</CardGroup>
104104
</div>
105+
<div className="container" style={{ margin: "6rem auto" }}>
106+
<h2>Learn New Tools</h2>
107+
<CardGroup commonCardProps={{ appearance: "invisible" }}>
108+
<Card title="Terragrunt" href="https://terragrunt.gruntwork.io">
109+
Terragrunt is a thin wrapper that provides extra tools for
110+
keeping your Terraform configurations DRY, working with multiple
111+
modules, and managing remote state.
112+
</Card>
113+
<Card title="Terratest" href="https://terratest.gruntwork.io">
114+
Terratest is a Go library that provides patterns and helper
115+
functions for testing infrastructure, with 1st-class support for
116+
Terraform, Packer, Docker, Kubernetes, AWS, GCP, and more.
117+
</Card>
118+
<Card
119+
title="Gruntwork Installer"
120+
href="https://github.com/gruntwork-io/gruntwork-installer"
121+
>
122+
The Gruntwork Installer provides conveniences for downloading
123+
and installing Gruntwork modules.
124+
</Card>
125+
</CardGroup>
126+
</div>
105127
</section>
106128
</main>
107129
</Layout>

0 commit comments

Comments
 (0)