-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement FAQ page and categories (#202)
* Implement FAQ page and categories * Remove extraneous header * Hide table of contents on FAQ index * Rephrase all items as questions. Add back button
- Loading branch information
1 parent
4f904b2
commit 47818c8
Showing
22 changed files
with
503 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# DevOps Best Practices FAQ | ||
|
||
## App development | ||
|
||
- [ Can you recommend some best practices for app development? Where can I find a decent 12-factor sample app?](https://github.com/gruntwork-io/knowledge-base/discussions/62) | ||
|
||
## Secrets management | ||
|
||
- [Do you have a recommended strategy for secrets management?](https://github.com/gruntwork-io/knowledge-base/discussions/62) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# EKS FAQ | ||
|
||
## General questions | ||
|
||
- [How do I share Secrets Manager secrets with Kubernetes Pods through Terragrunt / Terraform?](https://github.com/gruntwork-io/knowledge-base/discussions/213) | ||
- [How do I upgrade the Kubernetes version of the EKS cluster?](https://github.com/gruntwork-io/knowledge-base/discussions/143) | ||
- [Do the Gruntwork EKS modules support spot instances?](https://github.com/gruntwork-io/knowledge-base/discussions/134) | ||
- [How to change EKS cluster managed workers auto scaling group (ASG) name?](https://github.com/gruntwork-io/knowledge-base/discussions/131) | ||
|
||
## Errors | ||
|
||
- [Error when trying to create node labels with eks-cluster](https://github.com/gruntwork-io/knowledge-base/discussions/202) | ||
- [AWS CNI prefix not propagated to nodes](https://github.com/gruntwork-io/knowledge-base/discussions/196) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Infrastructure as Code (IaC) FAQ | ||
|
||
## Destroying | ||
|
||
- [How do I destroy a module that has errors?](https://github.com/gruntwork-io/knowledge-base/discussions/144) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import Card from "/src/components/Card" | ||
import Grid from "/src/components/Grid" | ||
|
||
# Gruntwork FAQs | ||
|
||
Get answers to frequently asked questions, organized by category. | ||
|
||
<Grid cols={2}> | ||
<Card | ||
title="Reference Architecture Pre-Deployment" | ||
href="/faq/ref-arch-predeployment" | ||
> | ||
Preparing for a deployment? We've got answers to common questions here. | ||
</Card> | ||
<Card | ||
title="Reference Architecture" | ||
href="/faq/ref-arch" | ||
> | ||
Questions about working with a deployed Reference Architecture. | ||
</Card> | ||
<Card | ||
title="DevOps Best Practices" | ||
href="/faq/devops-general" | ||
> | ||
Common advice, strategies, tooling, tips and tricks. | ||
</Card> | ||
<Card | ||
title="Service Catalog FAQ" | ||
href="/faq/service-catalog" | ||
> | ||
Common questions about working with the Gruntwork Service Catalog | ||
</Card> | ||
<Card | ||
title="Terragrunt" | ||
href="/faq/terragrunt" | ||
> | ||
Common questions about Gruntwork's open-source library, Terragrunt | ||
</Card> | ||
<Card | ||
title="Terratest" | ||
href="/faq/terratest" | ||
> | ||
Common questions about Gruntwork's open-source library, Terratest | ||
</Card> | ||
<Card | ||
title="Pipelines" | ||
href="/faq/pipelines" | ||
> | ||
Common questions about Gruntwork's continuous integration and delivery (CI/CD) product, Pipelines. | ||
</Card> | ||
<Card | ||
title="EKS" | ||
href="/faq/eks" | ||
> | ||
Common questions about Gruntwork's EKS modules, best practices and common tasks. | ||
</Card> | ||
<Card | ||
title="Infrastructure as Code (IaC) and modules" | ||
href="/faq/iac-general" | ||
> | ||
Common questions about working with modules, Infrastructure as code best practices, tips and tricks. | ||
</Card> | ||
|
||
</Grid> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Pipelines FAQ | ||
|
||
## General questions | ||
|
||
- [Why does `terraform-update-variable` default to skipping CI?](https://github.com/gruntwork-io/knowledge-base/discussions/200) | ||
- [How do I handle ECS Deploy Runner permissions errors for new modules?](https://github.com/gruntwork-io/knowledge-base/discussions/180) | ||
- [Can we run ECS Deploy Runner in multiple regions?](https://github.com/gruntwork-io/knowledge-base/discussions/181) | ||
- [How do I apply changes to common.hcl or other root files?](https://github.com/gruntwork-io/knowledge-base/discussions/133) | ||
|
||
## Errors | ||
|
||
- [How to handle "Provided value for option repo does not match regex" in Pipelines?](https://github.com/gruntwork-io/knowledge-base/discussions/219) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Reference Architecture Pre-deployment FAQ | ||
|
||
## General questions | ||
|
||
- [What are the steps to have a Reference Architecture deployed?](https://github.com/gruntwork-io/knowledge-base/discussions/203) | ||
|
||
## AWS accounts | ||
|
||
- [Can we use existing AWS accounts and organizations?](https://github.com/gruntwork-io/knowledge-base/discussions/207) | ||
- [What is the breakdown of accounts in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/57) | ||
- [Can I get a single account Reference Architecture?](https://github.com/gruntwork-io/knowledge-base/discussions/99) | ||
- [Why does the Ref Arch require us to create AWS accounts?](https://github.com/gruntwork-io/knowledge-base/discussions/20) | ||
|
||
## Regions | ||
|
||
- [Can we use a different primary region per environment?](https://github.com/gruntwork-io/knowledge-base/discussions/216) | ||
|
||
## CIS Benchmark compliant Reference Architecture | ||
|
||
- [What are the acceptable CIDRs / IP addresses for IPAllowList?](https://github.com/gruntwork-io/knowledge-base/discussions/206) | ||
- [Why does the CIS AWS Foundations Benchmark package cost additional money?](https://github.com/gruntwork-io/knowledge-base/discussions/69) | ||
|
||
## Gruntwork modules | ||
|
||
- [How do Gruntwork modules differ from the modules already available via the Terraform community?](https://github.com/gruntwork-io/knowledge-base/discussions/117) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Reference Architecture FAQ | ||
|
||
## Behaviors and practices | ||
|
||
- [What is the tagging strategy for resources in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/54) | ||
- [How does the Ref Arch handle IPv6?](https://github.com/gruntwork-io/knowledge-base/discussions/54) | ||
- [How to best create a new IAM group with a specific role assigned?](https://github.com/gruntwork-io/knowledge-base/discussions/212) | ||
- [What do I need to understand about Service Quotas and Limits?](https://github.com/gruntwork-io/knowledge-base/discussions/211) | ||
- [What are OpenVPN best practices in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/194) | ||
- [How do I switch accounts when working with the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/162) | ||
- [How do I deploy the same module in multiple regions?](https://github.com/gruntwork-io/knowledge-base/discussions/182) | ||
- [What's the best way to deploy KMS keys in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/189) | ||
- [How do I debug Security Checks failing in the CIS Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/135) | ||
|
||
## Versions and flavors | ||
|
||
- [How can I migrate from a single-account to a multi-accont Ref Arch in the future?](https://github.com/gruntwork-io/knowledge-base/discussions/101) | ||
- [What are the differences between Ref Arch 2.0 vs Ref Arch 1.0?](https://github.com/gruntwork-io/knowledge-base/discussions/3) | ||
- [Can I follow a guide to build the Ref Arch from scratch?](https://github.com/gruntwork-io/knowledge-base/discussions/58) | ||
- [How do I lock the Terraform version being used in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/187) | ||
|
||
## Components and integrations | ||
|
||
- [Is Elasticsearch included in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/56) | ||
- [Do you support ECS service discovery and App Mesh?](https://github.com/gruntwork-io/knowledge-base/discussions/53) | ||
- [Do you have modules for Code pipelines or do you rely on CircleCI?](https://github.com/gruntwork-io/knowledge-base/discussions/60) | ||
- [How do I forward CloudTrail logs to Datadog?](https://github.com/gruntwork-io/knowledge-base/discussions/179) | ||
|
||
## Errors | ||
|
||
- [ Specified ReservedConcurrentExecutions for function descreased account's UnreservedConcurrentExecution below its minimum value of [x]](https://github.com/gruntwork-io/knowledge-base/discussions/215) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Service Catalog FAQ | ||
|
||
## Core concepts | ||
|
||
- [Where can I get a comprehensive introduction to modules, the service catalog and how they fit together?](https://github.com/gruntwork-io/knowledge-base/discussions/54) | ||
|
||
## Daily tasks | ||
|
||
- [How do I build new AMIs from the Service Catalog?](https://github.com/gruntwork-io/knowledge-base/discussions/218) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Terragrunt FAQ | ||
|
||
## General questions | ||
|
||
- [How do I pass variables between Terragrunt and Terraform?](https://github.com/gruntwork-io/knowledge-base/discussions/137) | ||
- [How do I mock large sets of outputs with Terragrunt?](https://github.com/gruntwork-io/knowledge-base/discussions/109) | ||
|
||
## Versions | ||
|
||
- [How do I lock the version of Terraform being used?](https://github.com/gruntwork-io/knowledge-base/discussions/187) | ||
|
||
## Dependencies | ||
|
||
- [How do you override a dependency block in Terragrunt?](https://github.com/gruntwork-io/knowledge-base/discussions/172) | ||
- [How can you conditionally include a provider in a generate block?](https://github.com/gruntwork-io/knowledge-base/discussions/205) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Terratest FAQ | ||
|
||
## General questions | ||
|
||
- [How to use a field from a Terraform multi-fields output in Terratest?](https://github.com/gruntwork-io/knowledge-base/discussions/217) | ||
- [How to create an S3 bucket with SSL enabled using aws.CreateS3Bucket function in Terratest?](https://github.com/gruntwork-io/knowledge-base/discussions/195) | ||
- [How do I get S3 bucket folder structure using Terratest?](https://github.com/gruntwork-io/knowledge-base/discussions/173) | ||
|
||
## Kubeconfig | ||
|
||
- [Can I pass kubeconfig options into Terratest?](https://github.com/gruntwork-io/knowledge-base/discussions/191) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# DevOps Best Practices FAQ | ||
|
||
## App development | ||
|
||
- [ Can you recommend some best practices for app development? Where can I find a decent 12-factor sample app?](https://github.com/gruntwork-io/knowledge-base/discussions/62) | ||
|
||
## Secrets management | ||
|
||
- [Do you have a recommended strategy for secrets management?](https://github.com/gruntwork-io/knowledge-base/discussions/62) | ||
|
||
|
||
<!-- ##DOCS-SOURCER-START | ||
{"sourcePlugin":"local-copier","hash":"edc21b0a2f48bdf03447da1c1cb9ac21"} | ||
##DOCS-SOURCER-END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# EKS FAQ | ||
|
||
## General questions | ||
|
||
- [How do I share Secrets Manager secrets with Kubernetes Pods through Terragrunt / Terraform?](https://github.com/gruntwork-io/knowledge-base/discussions/213) | ||
- [How do I upgrade the Kubernetes version of the EKS cluster?](https://github.com/gruntwork-io/knowledge-base/discussions/143) | ||
- [Do the Gruntwork EKS modules support spot instances?](https://github.com/gruntwork-io/knowledge-base/discussions/134) | ||
- [How to change EKS cluster managed workers auto scaling group (ASG) name?](https://github.com/gruntwork-io/knowledge-base/discussions/131) | ||
|
||
## Errors | ||
|
||
- [Error when trying to create node labels with eks-cluster](https://github.com/gruntwork-io/knowledge-base/discussions/202) | ||
- [AWS CNI prefix not propagated to nodes](https://github.com/gruntwork-io/knowledge-base/discussions/196) | ||
|
||
|
||
<!-- ##DOCS-SOURCER-START | ||
{"sourcePlugin":"local-copier","hash":"d95f4a0a70695a6733735a2c67f6bd4e"} | ||
##DOCS-SOURCER-END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Infrastructure as Code (IaC) FAQ | ||
|
||
## Destroying | ||
|
||
- [How do I destroy a module that has errors?](https://github.com/gruntwork-io/knowledge-base/discussions/144) | ||
|
||
|
||
<!-- ##DOCS-SOURCER-START | ||
{"sourcePlugin":"local-copier","hash":"36bb7ec496d13c871b1259ef31ea7b1f"} | ||
##DOCS-SOURCER-END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import Card from "/src/components/Card" | ||
import Grid from "/src/components/Grid" | ||
|
||
# Gruntwork FAQs | ||
|
||
Get answers to frequently asked questions, organized by category. | ||
|
||
<Grid cols={2}> | ||
<Card | ||
title="Reference Architecture Pre-Deployment" | ||
href="/faq/ref-arch-predeployment" | ||
> | ||
Preparing for a deployment? We've got answers to common questions here. | ||
</Card> | ||
<Card | ||
title="Reference Architecture" | ||
href="/faq/ref-arch" | ||
> | ||
Questions about working with a deployed Reference Architecture. | ||
</Card> | ||
<Card | ||
title="DevOps Best Practices" | ||
href="/faq/devops-general" | ||
> | ||
Common advice, strategies, tooling, tips and tricks. | ||
</Card> | ||
<Card | ||
title="Service Catalog FAQ" | ||
href="/faq/service-catalog" | ||
> | ||
Common questions about working with the Gruntwork Service Catalog | ||
</Card> | ||
<Card | ||
title="Terragrunt" | ||
href="/faq/terragrunt" | ||
> | ||
Common questions about Gruntwork's open-source library, Terragrunt | ||
</Card> | ||
<Card | ||
title="Terratest" | ||
href="/faq/terratest" | ||
> | ||
Common questions about Gruntwork's open-source library, Terratest | ||
</Card> | ||
<Card | ||
title="Pipelines" | ||
href="/faq/pipelines" | ||
> | ||
Common questions about Gruntwork's continuous integration and delivery (CI/CD) product, Pipelines. | ||
</Card> | ||
<Card | ||
title="EKS" | ||
href="/faq/eks" | ||
> | ||
Common questions about Gruntwork's EKS modules, best practices and common tasks. | ||
</Card> | ||
<Card | ||
title="Infrastructure as Code (IaC) and modules" | ||
href="/faq/iac-general" | ||
> | ||
Common questions about working with modules, Infrastructure as code best practices, tips and tricks. | ||
</Card> | ||
|
||
</Grid> | ||
|
||
|
||
<!-- ##DOCS-SOURCER-START | ||
{"sourcePlugin":"local-copier","hash":"dbdf6417d65b463c42d8decdbed70717"} | ||
##DOCS-SOURCER-END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Pipelines FAQ | ||
|
||
## General questions | ||
|
||
- [Why does `terraform-update-variable` default to skipping CI?](https://github.com/gruntwork-io/knowledge-base/discussions/200) | ||
- [How do I handle ECS Deploy Runner permissions errors for new modules?](https://github.com/gruntwork-io/knowledge-base/discussions/180) | ||
- [Can we run ECS Deploy Runner in multiple regions?](https://github.com/gruntwork-io/knowledge-base/discussions/181) | ||
- [How do I apply changes to common.hcl or other root files?](https://github.com/gruntwork-io/knowledge-base/discussions/133) | ||
|
||
## Errors | ||
|
||
- [How to handle "Provided value for option repo does not match regex" in Pipelines?](https://github.com/gruntwork-io/knowledge-base/discussions/219) | ||
|
||
|
||
<!-- ##DOCS-SOURCER-START | ||
{"sourcePlugin":"local-copier","hash":"a07af15175a16401cffba58d7eb21ef0"} | ||
##DOCS-SOURCER-END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Reference Architecture Pre-deployment FAQ | ||
|
||
## General questions | ||
|
||
- [What are the steps to have a Reference Architecture deployed?](https://github.com/gruntwork-io/knowledge-base/discussions/203) | ||
|
||
## AWS accounts | ||
|
||
- [Can we use existing AWS accounts and organizations?](https://github.com/gruntwork-io/knowledge-base/discussions/207) | ||
- [What is the breakdown of accounts in the Ref Arch?](https://github.com/gruntwork-io/knowledge-base/discussions/57) | ||
- [Can I get a single account Reference Architecture?](https://github.com/gruntwork-io/knowledge-base/discussions/99) | ||
- [Why does the Ref Arch require us to create AWS accounts?](https://github.com/gruntwork-io/knowledge-base/discussions/20) | ||
|
||
## Regions | ||
|
||
- [Can we use a different primary region per environment?](https://github.com/gruntwork-io/knowledge-base/discussions/216) | ||
|
||
## CIS Benchmark compliant Reference Architecture | ||
|
||
- [What are the acceptable CIDRs / IP addresses for IPAllowList?](https://github.com/gruntwork-io/knowledge-base/discussions/206) | ||
- [Why does the CIS AWS Foundations Benchmark package cost additional money?](https://github.com/gruntwork-io/knowledge-base/discussions/69) | ||
|
||
## Gruntwork modules | ||
|
||
- [How do Gruntwork modules differ from the modules already available via the Terraform community?](https://github.com/gruntwork-io/knowledge-base/discussions/117) | ||
|
||
|
||
<!-- ##DOCS-SOURCER-START | ||
{"sourcePlugin":"local-copier","hash":"dc57285f55e7caced69fdb4052fa6264"} | ||
##DOCS-SOURCER-END --> |
Oops, something went wrong.