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

Intro content for Guides and Build It Yourself #105

Merged
merged 3 commits into from
Dec 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 58 additions & 0 deletions _docs-sources/guides/build-it-yourself/1-overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,63 @@
---
sidebar_label: Overview
pagination_label: Build It Yourself
---

import Card from "/src/components/Card"
import Grid from "/src/components/Grid"

# Build Your Own Architecture

The Gruntwork IaC library empowers you to construct your own bespoke architecture in record time. By mix-and-matching our modules and services you can quickly define a custom architecture to suit your needs, all with the confidence of having world-class, battle-tested code running under the hood. This series of guides aims to teach you how to configure and deploy some of our most popular services. Additional guides will be added over time, but the principles covered extend to the rest of the IaC library. If you have trouble, don’t hesitate to ask questions via our [support channels](/docs/guides/support).

### Follow Our Step-By-Step Guides

<Grid>
<Card
title="Set Up Your AWS Accounts"
href="/docs/guides/build-it-yourself/landing-zone/intro/what-youll-learn-in-this-guide"
>
Set up a multi-account structure using Gruntwork Landing Zone.
</Card>
<Card
title="Configure a CI/CD Pipeline"
href="/docs/guides/build-it-yourself/pipelines/intro/what-youll-learn-in-this-guide"
>
Implement continuous deployment for your infrastructure code with Gruntwork
Pipelines.
</Card>
<Card
title="Deploy a VPC"
href="/docs/guides/build-it-yourself/vpc/intro/what-youll-learn-in-this-guide"
>
Set up your network according to industry best practices using our VPC service.
</Card>
<Card
title="Deploy a Kubernetes Cluster"
href="/docs/guides/build-it-yourself/kubernetes-cluster/intro/what-youll-learn-in-this-guide"
>
Deploy a Kubernetes Cluster to host all of your apps and services.
</Card>
<Card
title="Acheive Compliance"
href="/docs/guides/build-it-yourself/achieve-compliance/intro/what-youll-learn-in-this-guide"
>
Make your infrastructure compliant with the CIS AWS Foundations Benchmark.
</Card>
</Grid>

### Dig Into the Code

<Grid cols={2}>
<Card title="Browse Services" href="/docs/reference/services/intro">
View the API reference for our entire service catalog to learn what’s
available.
</Card>
<Card
title="View the Code in GitHub"
href="https://github.com/orgs/gruntwork-io/repositories"
>
If you're the type who likes to jump straight to the source, this is for
you.
</Card>
</Grid>
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
pagination_label: Build it Yourself - Configure Your Accounts With Landing Zone
sidebar_label: What you’ll learn in this guide
pagination_label: Configure Your Accounts With Landing Zone
---

# What you’ll learn in this guide
# Configure Your Accounts with Landing Zone

This guide will walk you through the process of configuring a production-grade AWS account structure, including how to manage multiple environments, users, permissions, and audit logging. We’ll also discuss how to implement a Landing Zone solution that lets you quickly spin up new AWS accounts that all implement a security baseline that enforces your company’s policies.

This guide consists of four main sections:


<div className="dlist">

#### [Core concepts](../1-core-concepts/0-aws-account.md)
Expand All @@ -31,7 +31,6 @@ solution, including how to manage it all with customizable security baselines de

What to do once you’ve got your AWS account structure configured.


</div>

Feel free to read the guide from start to finish or skip around to whatever part interests you.
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# What you’ll learn in this guide
---
sidebar_label: What you’ll learn in this guide
pagination_label: Set Up an Infrastructure CI/CD Pipeline
---

# Set Up an Infrastructure CI/CD Pipeline

This is a comprehensive guide of how to design, configure, and implement a Continuous Integration and Continuous
Delivery pipeline for your infrastructure code. This guide will walk you through the steps to set up a secure CI/CD
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# What you’ll learn in this guide
---
sidebar_label: What you’ll learn in this guide
pagination_label: Deploy a Production-grade VPC
---

# Deploy a Production-grade VPC

This guide consists of four main sections:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
pagination_label: Deploy a Kubernetes Cluster
sidebar_label: What you’ll learn in this guide
pagination_label: Deploy a Production-grade Kubernetes Cluster
---

# What you’ll learn in this guide
# Deploy a Production-grade Kubernetes Cluster

This guide will walk you through the process of configuring a production-grade Kubernetes cluster on AWS.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
---
sidebar_label: What you’ll learn in this guide
pagination_label: Achieve Compliance With the CIS AWS Foundations Benchmark
---

# What you’ll learn in this guide
# Achieve Compliance With the CIS AWS Foundations Benchmark

:::info

This guide was last updated on 6th September 2021, and it covers CIS 1.4.0 Benchmark recommendations. We aim to keep
it up to date with our infrastructure-as-code modules with the latest CIS Benchmark that has been released.
If you need to access older versions, please [get in touch](/docs/guides/support) with us.

:::

This is a complete guide to help you achieve compliance with the
[CIS AWS Foundations Benchmark](https://www.cisecurity.org/benchmark/amazon_web_services/). By following this guide,
Expand All @@ -11,8 +20,8 @@ compliant state over time because all of the infrastructure is defined as code.

Previously, we supported versions 1.3.0 and 1.2.0 of the Benchmark. If you are looking to upgrade from an older version please follow these in order:

* To upgrade from v1.2.0 to v1.3.0, please follow [this upgrade guide](../../../stay-up-to-date/1-cis/1-how-to-update-to-cis-13/0-intro.md);
* To upgrade from v1.3.0 to v1.4.0, please follow [this upgrade guide](../../../stay-up-to-date/1-cis/0-how-to-update-to-cis-14/0-intro.md).
- To upgrade from v1.2.0 to v1.3.0, please follow [this upgrade guide](../../../stay-up-to-date/1-cis/1-how-to-update-to-cis-13/0-intro.md);
- To upgrade from v1.3.0 to v1.4.0, please follow [this upgrade guide](../../../stay-up-to-date/1-cis/0-how-to-update-to-cis-14/0-intro.md).

![CIS Benchmark Architecture](/img/guides/build-it-yourself/achieve-compliance/cis-account-architecture.png)

Expand Down Expand Up @@ -42,15 +51,6 @@ How to measure and maintain compliance.
A reference table that maps each Benchmark recommendation to the corresponding section in the deployment
walkthrough.


</div>

Feel free to read the guide from start to finish or skip around to whatever part interests you!

:::info

This guide was last updated on 6th September 2021, and it covers CIS 1.4.0 Benchmark recommendations. We aim to keep
it up to date with our infrastructure-as-code modules with the latest CIS Benchmark that has been released.
If you need to access older versions, please get in touch with us.

:::
24 changes: 22 additions & 2 deletions _docs-sources/guides/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@
"sidebar_position": 1
---

# Welcome
import Card from "/src/components/Card"
import Grid from "/src/components/Grid"

This is an introduction to the guides section
# Gruntwork Guides

As a Gruntwork subscriber, you have two primary ways to engage with our library. Whichever approach you choose, our guides provide step-by-step instructions to help you deploy your infrastructure with confidence. We also offer detailed upgrade guides to ensure that your infrastructure remains up-to-date with the latest security patches, compliance requirements, and DevOps best practices.
eak12913 marked this conversation as resolved.
Show resolved Hide resolved

<Grid cols={2}>
<Card
title="Set Up Your Reference Architecture"
href="/docs/guides/reference-architecture/overview/overview"
>
Learn how to use and administer a Reference Architecture which Gruntwork has
deployed for you.
</Card>
<Card
title="Build Your Own Architecture"
href="/docs/guides/build-it-yourself/overview"
>
Learn how to utilize our service modules to construct a world-class
architecture on your own.
</Card>
</Grid>
6 changes: 3 additions & 3 deletions _docs-sources/intro/next-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Now that your foundational knowledge is in place and your workspace is configure

<Grid cols={2}>
<Card
title="Deploy a Reference Architecture"
title="Set Up Your Reference Architecture"
href="/docs/guides/reference-architecture/overview/overview"
>
Learn how to deploy and utilize your Gruntwork Reference Architecture, step
by step.
Learn how to use and administer a Reference Architecture which Gruntwork has
deployed for you.
</Card>
<Card
title="Build Your Own Architecture"
Expand Down
60 changes: 59 additions & 1 deletion docs/guides/build-it-yourself/1-overview.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,68 @@
---
sidebar_label: Overview
pagination_label: Build It Yourself
---

import Card from "/src/components/Card"
import Grid from "/src/components/Grid"

# Build Your Own Architecture

The Gruntwork IaC library empowers you to construct your own bespoke architecture in record time. By mix-and-matching our modules and services you can quickly define a custom architecture to suit your needs, all with the confidence of having world-class, battle-tested code running under the hood. This series of guides aims to teach you how to configure and deploy some of our most popular services. Additional guides will be added over time, but the principles covered extend to the rest of the IaC library. If you have trouble, don’t hesitate to ask questions via our [support channels](/docs/guides/support).

### Follow Our Step-By-Step Guides

<Grid>
<Card
title="Set Up Your AWS Accounts"
href="/docs/guides/build-it-yourself/landing-zone/intro/what-youll-learn-in-this-guide"
>
Set up a multi-account structure using Gruntwork Landing Zone.
</Card>
<Card
title="Configure a CI/CD Pipeline"
href="/docs/guides/build-it-yourself/pipelines/intro/what-youll-learn-in-this-guide"
>
Implement continuous deployment for your infrastructure code with Gruntwork
Pipelines.
</Card>
<Card
title="Deploy a VPC"
href="/docs/guides/build-it-yourself/vpc/intro/what-youll-learn-in-this-guide"
>
Set up your network according to industry best practices using our VPC service.
</Card>
<Card
title="Deploy a Kubernetes Cluster"
href="/docs/guides/build-it-yourself/kubernetes-cluster/intro/what-youll-learn-in-this-guide"
>
Deploy a Kubernetes Cluster to host all of your apps and services.
</Card>
<Card
title="Acheive Compliance"
href="/docs/guides/build-it-yourself/achieve-compliance/intro/what-youll-learn-in-this-guide"
>
Make your infrastructure compliant with the CIS AWS Foundations Benchmark.
</Card>
</Grid>

### Dig Into the Code

<Grid cols={2}>
<Card title="Browse Services" href="/docs/reference/services/intro">
View the API reference for our entire service catalog to learn what’s
available.
</Card>
<Card
title="View the Code in GitHub"
href="https://github.com/orgs/gruntwork-io/repositories"
>
If you're the type who likes to jump straight to the source, this is for
you.
</Card>
</Grid>


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"13d419b5803a910f53b358e0b309d8fe"}
{"sourcePlugin":"Local File Copier","hash":"21204454b6914ebf2ad140d7efa79ba3"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
pagination_label: Build it Yourself - Configure Your Accounts With Landing Zone
sidebar_label: What you’ll learn in this guide
pagination_label: Configure Your Accounts With Landing Zone
---

# What you’ll learn in this guide
# Configure Your Accounts with Landing Zone

This guide will walk you through the process of configuring a production-grade AWS account structure, including how to manage multiple environments, users, permissions, and audit logging. We’ll also discuss how to implement a Landing Zone solution that lets you quickly spin up new AWS accounts that all implement a security baseline that enforces your company’s policies.

This guide consists of four main sections:


<div className="dlist">

#### [Core concepts](../1-core-concepts/0-aws-account.md)
Expand All @@ -31,12 +31,11 @@ solution, including how to manage it all with customizable security baselines de

What to do once you’ve got your AWS account structure configured.


</div>

Feel free to read the guide from start to finish or skip around to whatever part interests you.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"13ce0bbfb0d0a9120d194242d1fb3430"}
{"sourcePlugin":"Local File Copier","hash":"b9e8fa0e9a793984a9cf7e9ed8eb431b"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# What you’ll learn in this guide
---
sidebar_label: What you’ll learn in this guide
pagination_label: Set Up an Infrastructure CI/CD Pipeline
---

# Set Up an Infrastructure CI/CD Pipeline

This is a comprehensive guide of how to design, configure, and implement a Continuous Integration and Continuous
Delivery pipeline for your infrastructure code. This guide will walk you through the steps to set up a secure CI/CD
Expand Down Expand Up @@ -38,5 +43,5 @@ What to do once you’ve got your CI/CD pipeline set up.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"e1dca32970bbcb9d9f8f5c1b7f07a4df"}
{"sourcePlugin":"Local File Copier","hash":"bf8091f18c65b6c08ea348daed589419"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# What you’ll learn in this guide
---
sidebar_label: What you’ll learn in this guide
pagination_label: Deploy a Production-grade VPC
---

# Deploy a Production-grade VPC

This guide consists of four main sections:

Expand Down Expand Up @@ -28,5 +33,5 @@ Feel free to read the guide from start to finish or skip around to whatever part


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"4ae2802a409a764054df57d2f29bcbe9"}
{"sourcePlugin":"Local File Copier","hash":"d90dcaaf7e8d3e252208d40feaecdbb4"}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
pagination_label: Deploy a Kubernetes Cluster
sidebar_label: What you’ll learn in this guide
pagination_label: Deploy a Production-grade Kubernetes Cluster
---

# What you’ll learn in this guide
# Deploy a Production-grade Kubernetes Cluster

This guide will walk you through the process of configuring a production-grade Kubernetes cluster on AWS.

Expand Down Expand Up @@ -37,5 +38,5 @@ Feel free to read the guide from start to finish or skip around to whatever part


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"2b505c805dc485e884d0752c6d6554b5"}
{"sourcePlugin":"Local File Copier","hash":"b74a95f5f490bd7761c2455442930a7f"}
##DOCS-SOURCER-END -->
Loading