diff --git a/_docs-sources/guides/build-it-yourself/1-overview.md b/_docs-sources/guides/build-it-yourself/1-overview.md index f52130f9b..160c1bde6 100644 --- a/_docs-sources/guides/build-it-yourself/1-overview.md +++ b/_docs-sources/guides/build-it-yourself/1-overview.md @@ -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 + + + + Set up a multi-account structure using Gruntwork Landing Zone. + + + Implement continuous deployment for your infrastructure code with Gruntwork + Pipelines. + + + Set up your network according to industry best practices using our VPC service. + + + Deploy a Kubernetes Cluster to host all of your apps and services. + + + Make your infrastructure compliant with the CIS AWS Foundations Benchmark. + + + +### Dig Into the Code + + + + View the API reference for our entire service catalog to learn what’s + available. + + + If you're the type who likes to jump straight to the source, this is for + you. + + diff --git a/_docs-sources/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md b/_docs-sources/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md index 07565b501..85d2e0339 100644 --- a/_docs-sources/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md +++ b/_docs-sources/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md @@ -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: -
#### [Core concepts](../1-core-concepts/0-aws-account.md) @@ -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. -
Feel free to read the guide from start to finish or skip around to whatever part interests you. diff --git a/_docs-sources/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md b/_docs-sources/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md index f668a1ccf..d5e66ac74 100644 --- a/_docs-sources/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md +++ b/_docs-sources/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md @@ -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 diff --git a/_docs-sources/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md b/_docs-sources/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md index ba226ae6d..1a09016ef 100644 --- a/_docs-sources/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md +++ b/_docs-sources/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md @@ -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: diff --git a/_docs-sources/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md b/_docs-sources/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md index 94b06c397..ccfff6e0d 100644 --- a/_docs-sources/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md +++ b/_docs-sources/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md @@ -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. diff --git a/_docs-sources/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md b/_docs-sources/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md index 922f0db70..662ad79f9 100644 --- a/_docs-sources/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md +++ b/_docs-sources/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md @@ -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, @@ -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) @@ -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. - 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. - -::: diff --git a/_docs-sources/guides/welcome.md b/_docs-sources/guides/welcome.md index 55b6d9815..88801bd10 100644 --- a/_docs-sources/guides/welcome.md +++ b/_docs-sources/guides/welcome.md @@ -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 \ No newline at end of file +# 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. + + + + Learn how to use and administer a Reference Architecture which Gruntwork has + deployed for you. + + + Learn how to utilize our service modules to construct a world-class + architecture on your own. + + diff --git a/_docs-sources/intro/next-steps.mdx b/_docs-sources/intro/next-steps.mdx index 381e0704a..3bb98a352 100644 --- a/_docs-sources/intro/next-steps.mdx +++ b/_docs-sources/intro/next-steps.mdx @@ -11,11 +11,11 @@ Now that your foundational knowledge is in place and your workspace is configure - 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. + + Set up a multi-account structure using Gruntwork Landing Zone. + + + Implement continuous deployment for your infrastructure code with Gruntwork + Pipelines. + + + Set up your network according to industry best practices using our VPC service. + + + Deploy a Kubernetes Cluster to host all of your apps and services. + + + Make your infrastructure compliant with the CIS AWS Foundations Benchmark. + + + +### Dig Into the Code + + + + View the API reference for our entire service catalog to learn what’s + available. + + + If you're the type who likes to jump straight to the source, this is for + you. + + + diff --git a/docs/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md b/docs/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md index 0f7685200..9a4389d10 100644 --- a/docs/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md +++ b/docs/guides/build-it-yourself/2-landing-zone/0-intro/0-what-youll-learn-in-this-guide.md @@ -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: -
#### [Core concepts](../1-core-concepts/0-aws-account.md) @@ -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. -
Feel free to read the guide from start to finish or skip around to whatever part interests you. diff --git a/docs/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md b/docs/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md index 30461b138..ae84243b9 100644 --- a/docs/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md +++ b/docs/guides/build-it-yourself/3-pipelines/0-intro/0-what-youll-learn-in-this-guide.md @@ -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 @@ -38,5 +43,5 @@ What to do once you’ve got your CI/CD pipeline set up. diff --git a/docs/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md b/docs/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md index 39979761d..91a3c2ed3 100644 --- a/docs/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md +++ b/docs/guides/build-it-yourself/4-vpc/0-intro/0-what-youll-learn-in-this-guide.md @@ -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: @@ -28,5 +33,5 @@ Feel free to read the guide from start to finish or skip around to whatever part diff --git a/docs/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md b/docs/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md index 398a7f106..7cd118d17 100644 --- a/docs/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md +++ b/docs/guides/build-it-yourself/5-kubernetes-cluster/0-intro/0-what-youll-learn-in-this-guide.md @@ -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. @@ -37,5 +38,5 @@ Feel free to read the guide from start to finish or skip around to whatever part diff --git a/docs/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md b/docs/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md index 56f3c42e2..2ff895d39 100644 --- a/docs/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md +++ b/docs/guides/build-it-yourself/6-achieve-compliance/0-intro/0-what-youll-learn-in-this-guide.md @@ -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, @@ -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) @@ -42,20 +51,11 @@ How to measure and maintain compliance. A reference table that maps each Benchmark recommendation to the corresponding section in the deployment walkthrough. - 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. - -::: - diff --git a/docs/guides/welcome.md b/docs/guides/welcome.md index 401c10473..cbea9b57b 100644 --- a/docs/guides/welcome.md +++ b/docs/guides/welcome.md @@ -3,10 +3,31 @@ "sidebar_position": 1 --- -# Welcome +import Card from "/src/components/Card" +import Grid from "/src/components/Grid" + +# 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. + + + + Learn how to use and administer a Reference Architecture which Gruntwork has + deployed for you. + + + Learn how to utilize our service modules to construct a world-class + architecture on your own. + + -This is an introduction to the guides section diff --git a/docs/intro/next-steps.mdx b/docs/intro/next-steps.mdx index 95687ab1c..6e19c8215 100644 --- a/docs/intro/next-steps.mdx +++ b/docs/intro/next-steps.mdx @@ -11,11 +11,11 @@ Now that your foundational knowledge is in place and your workspace is configure - 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.