From 986e62def5eae7761840cdf0ad0d3778d733a23c Mon Sep 17 00:00:00 2001 From: Beth Adele Long Date: Thu, 13 Apr 2023 10:57:43 -0700 Subject: [PATCH 1/6] add new page for Shared Responsibility Model --- .../overview/shared-responsibility-model.md | 41 ++++++++++++++++ .../overview/shared-responsibility-model.md | 49 +++++++++++++++++++ sidebars/intro-guide.js | 1 + 3 files changed, 91 insertions(+) create mode 100644 _docs-sources/intro/overview/shared-responsibility-model.md create mode 100644 docs/intro/overview/shared-responsibility-model.md diff --git a/_docs-sources/intro/overview/shared-responsibility-model.md b/_docs-sources/intro/overview/shared-responsibility-model.md new file mode 100644 index 0000000000..0f122f4a7e --- /dev/null +++ b/_docs-sources/intro/overview/shared-responsibility-model.md @@ -0,0 +1,41 @@ +# Shared Responsibility Model + +**The implementation and maintenance of Gruntwork products in AWS is a shared responsibility between Gruntwork and the customer.** + +**Gruntwork is responsible for:** + +- Providing a tested, updated, and richly featured collection of infrastructure code for the customer to use. +- Maintaining a healthy Knowledge Base community where other engineers (including Grunts) post & answer questions. +- For Pro / Enterprise Support customers: Answering questions via email and Slack. +- For Reference Architecture customers: + - Generating the initial Reference Architecture based on our customer’s selections of available configurations. This includes: + - Our implementation of Landing Zone + - A complete sample app with underlying database and caching layer + - The Gruntwork Pipeline for deploying changes to infrastructure + - An overview of how to use the Reference Architecture + - Manual steps the customer needs to take that can only be done by the customer + - Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. + - Delivering the initial Reference Architecture Infrastructure as Code to the customer. + - Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. +- For CIS customers: + - Providing IaC libraries to the CIS customer that correctly implement CIS requirements and restrictions. + - For aspects of the CIS AWS Foundations Benchmark where those requirements cannot be met by modules, but require human intervention, provide instructions on manual steps the customer must take to meet the requirements. + - For CIS Reference Architecture customers, deploying a Reference Architecture and providing access to infrastructure code that implements the CIS AWS Foundations Benchmark requirements out-of-the-box, wherever possible. + +**As a Gruntwork customer, you are responsible for:** + +- Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. + - Raise limitations of Gruntwork modules as a feature request or a pull request. + - Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. +- Adding additional Infrastructure as Code to customize it for their company. +- Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). +- For Reference Architecture customers: + - Following all provided manual steps in the Reference Architecture documents where automation is not possible. + - Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. + - Designing and implementing their AWS infrastructure beyond the Reference Architecture. + - Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). + - Once deployed, maintaining the Reference Architecture to keep it secure and up to date. + - Keeping the Reference Architecture secure in accordance with their company needs. + - Understanding and accepting the security implications of any changes made to the Reference Architecture. + - Monitoring Gruntwork repositories for updates and new releases and applying them as appropriate. + - Maintaining all compliance standards after the Reference Architecture has been delivered. diff --git a/docs/intro/overview/shared-responsibility-model.md b/docs/intro/overview/shared-responsibility-model.md new file mode 100644 index 0000000000..fd3c830a30 --- /dev/null +++ b/docs/intro/overview/shared-responsibility-model.md @@ -0,0 +1,49 @@ +# Shared Responsibility Model + +**The implementation and maintenance of Gruntwork products in AWS is a shared responsibility between Gruntwork and the customer.** + +**Gruntwork is responsible for:** + +- Providing a tested, updated, and richly featured collection of infrastructure code for the customer to use. +- Maintaining a healthy Knowledge Base community where other engineers (including Grunts) post & answer questions. +- For Pro / Enterprise Support customers: Answering questions via email and Slack. +- For Reference Architecture customers: + - Generating the initial Reference Architecture based on our customer’s selections of available configurations. This includes: + - Our implementation of Landing Zone + - A complete sample app with underlying database and caching layer + - The Gruntwork Pipeline for deploying changes to infrastructure + - An overview of how to use the Reference Architecture + - Manual steps the customer needs to take that can only be done by the customer + - Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. + - Delivering the initial Reference Architecture Infrastructure as Code to the customer. + - Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. +- For CIS customers: + - Providing IaC libraries to the CIS customer that correctly implement CIS requirements and restrictions. + - For aspects of the CIS AWS Foundations Benchmark where those requirements cannot be met by modules, but require human intervention, provide instructions on manual steps the customer must take to meet the requirements. + - For CIS Reference Architecture customers, deploying a Reference Architecture and providing access to infrastructure code that implements the CIS AWS Foundations Benchmark requirements out-of-the-box, wherever possible. + +**As a Gruntwork customer, you are responsible for:** + +- Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. + - Raise limitations of Gruntwork modules as a feature request or a pull request. + - Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. +- Adding additional Infrastructure as Code to customize it for their company. +- Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). +- For Reference Architecture customers: + - Following all provided manual steps in the Reference Architecture documents where automation is not possible. + - Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. + - Designing and implementing their AWS infrastructure beyond the Reference Architecture. + - Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). + - Once deployed, maintaining the Reference Architecture to keep it secure and up to date. + - Keeping the Reference Architecture secure in accordance with their company needs. + - Understanding and accepting the security implications of any changes made to the Reference Architecture. + - Monitoring Gruntwork repositories for updates and new releases and applying them as appropriate. + - Maintaining all compliance standards after the Reference Architecture has been delivered. + + + diff --git a/sidebars/intro-guide.js b/sidebars/intro-guide.js index 05695f25ba..a368b66eec 100644 --- a/sidebars/intro-guide.js +++ b/sidebars/intro-guide.js @@ -4,6 +4,7 @@ const sidebar = [ "intro/overview/intro-to-gruntwork", "intro/overview/how-it-works", "intro/overview/reference-architecture-prerequisites-guide", + "intro/overview/shared-responsibility-model", // Temporarily hiding the unfinished sections from the sidebar We'll put // them back shortly and don't want to delete the pages as we know we're // going to have these sections within a few days. From 2d169e69732c8545680a07b4215e340ad862ea12 Mon Sep 17 00:00:00 2001 From: Oreoluwa Agunbiade Date: Mon, 1 May 2023 09:52:10 -0600 Subject: [PATCH 2/6] PR Suggestions --- .../overview/shared-responsibility-model.md | 74 ++++++++-------- .../overview/shared-responsibility-model.md | 84 ++++++++++--------- 2 files changed, 83 insertions(+), 75 deletions(-) diff --git a/_docs-sources/intro/overview/shared-responsibility-model.md b/_docs-sources/intro/overview/shared-responsibility-model.md index 0f122f4a7e..7995e81219 100644 --- a/_docs-sources/intro/overview/shared-responsibility-model.md +++ b/_docs-sources/intro/overview/shared-responsibility-model.md @@ -1,41 +1,45 @@ # Shared Responsibility Model -**The implementation and maintenance of Gruntwork products in AWS is a shared responsibility between Gruntwork and the customer.** +:::note -**Gruntwork is responsible for:** +The implementation and maintenance of Gruntwork products in AWS is a shared responsibility between Gruntwork and the customer. -- Providing a tested, updated, and richly featured collection of infrastructure code for the customer to use. -- Maintaining a healthy Knowledge Base community where other engineers (including Grunts) post & answer questions. -- For Pro / Enterprise Support customers: Answering questions via email and Slack. -- For Reference Architecture customers: - - Generating the initial Reference Architecture based on our customer’s selections of available configurations. This includes: - - Our implementation of Landing Zone - - A complete sample app with underlying database and caching layer - - The Gruntwork Pipeline for deploying changes to infrastructure - - An overview of how to use the Reference Architecture - - Manual steps the customer needs to take that can only be done by the customer - - Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. - - Delivering the initial Reference Architecture Infrastructure as Code to the customer. - - Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. -- For CIS customers: - - Providing IaC libraries to the CIS customer that correctly implement CIS requirements and restrictions. - - For aspects of the CIS AWS Foundations Benchmark where those requirements cannot be met by modules, but require human intervention, provide instructions on manual steps the customer must take to meet the requirements. - - For CIS Reference Architecture customers, deploying a Reference Architecture and providing access to infrastructure code that implements the CIS AWS Foundations Benchmark requirements out-of-the-box, wherever possible. +::: -**As a Gruntwork customer, you are responsible for:** +## Gruntwork is responsible for: -- Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. - - Raise limitations of Gruntwork modules as a feature request or a pull request. - - Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. -- Adding additional Infrastructure as Code to customize it for their company. -- Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). -- For Reference Architecture customers: - - Following all provided manual steps in the Reference Architecture documents where automation is not possible. - - Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. - - Designing and implementing their AWS infrastructure beyond the Reference Architecture. - - Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). - - Once deployed, maintaining the Reference Architecture to keep it secure and up to date. - - Keeping the Reference Architecture secure in accordance with their company needs. - - Understanding and accepting the security implications of any changes made to the Reference Architecture. - - Monitoring Gruntwork repositories for updates and new releases and applying them as appropriate. - - Maintaining all compliance standards after the Reference Architecture has been delivered. +1. Providing a tested, updated, and richly featured collection of infrastructure code for the customer to use. +1. Maintaining a healthy Knowledge Base community where other engineers (including Grunts) post & answer questions. +1. For Pro / Enterprise Support customers: Answering questions via email and Slack. +1. For Reference Architecture customers: + 1. Generating the initial Reference Architecture based on our customer’s selections of available configurations. This includes: + 1. Our implementation of Landing Zone + 1. A complete sample app with underlying database and caching layer + 1. The Gruntwork Pipeline for deploying changes to infrastructure + 1. An overview of how to use the Reference Architecture + 1. Manual steps the customer needs to take that can only be done by the customer + 1. Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. + 1. Delivering the initial Reference Architecture Infrastructure as Code to the customer. + 1. Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. +1. For CIS customers: + 1. Providing IaC libraries to the CIS customer that correctly implement CIS requirements and restrictions. + 1. For aspects of the CIS AWS Foundations Benchmark where those requirements cannot be met by modules, but require human intervention, provide instructions on manual steps the customer must take to meet the requirements. + 1. For CIS Reference Architecture customers, deploying a Reference Architecture and providing access to infrastructure code that implements the CIS AWS Foundations Benchmark requirements out-of-the-box, wherever possible. + +## As a Gruntwork customer, you are responsible for: + +1. Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. + 1. Raise limitations of Gruntwork modules as a feature request or a pull request. + 1. Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. +1. Adding additional Infrastructure as Code to customize it for their company. +1. Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). +1. For Reference Architecture customers: + 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. + 1. Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. + 1. Designing and implementing their AWS infrastructure beyond the Reference Architecture. + 1. Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). + 1. Once deployed, maintaining the Reference Architecture to keep it secure and up to date. + 1. Keeping the Reference Architecture secure in accordance with their company needs. + 1. Understanding and accepting the security implications of any changes made to the Reference Architecture. + 1. Monitoring Gruntwork repositories for updates and new releases and applying them as appropriate. + 1. Maintaining all compliance standards after the Reference Architecture has been delivered. diff --git a/docs/intro/overview/shared-responsibility-model.md b/docs/intro/overview/shared-responsibility-model.md index fd3c830a30..ce262013a7 100644 --- a/docs/intro/overview/shared-responsibility-model.md +++ b/docs/intro/overview/shared-responsibility-model.md @@ -1,49 +1,53 @@ # Shared Responsibility Model -**The implementation and maintenance of Gruntwork products in AWS is a shared responsibility between Gruntwork and the customer.** - -**Gruntwork is responsible for:** - -- Providing a tested, updated, and richly featured collection of infrastructure code for the customer to use. -- Maintaining a healthy Knowledge Base community where other engineers (including Grunts) post & answer questions. -- For Pro / Enterprise Support customers: Answering questions via email and Slack. -- For Reference Architecture customers: - - Generating the initial Reference Architecture based on our customer’s selections of available configurations. This includes: - - Our implementation of Landing Zone - - A complete sample app with underlying database and caching layer - - The Gruntwork Pipeline for deploying changes to infrastructure - - An overview of how to use the Reference Architecture - - Manual steps the customer needs to take that can only be done by the customer - - Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. - - Delivering the initial Reference Architecture Infrastructure as Code to the customer. - - Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. -- For CIS customers: - - Providing IaC libraries to the CIS customer that correctly implement CIS requirements and restrictions. - - For aspects of the CIS AWS Foundations Benchmark where those requirements cannot be met by modules, but require human intervention, provide instructions on manual steps the customer must take to meet the requirements. - - For CIS Reference Architecture customers, deploying a Reference Architecture and providing access to infrastructure code that implements the CIS AWS Foundations Benchmark requirements out-of-the-box, wherever possible. - -**As a Gruntwork customer, you are responsible for:** - -- Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. - - Raise limitations of Gruntwork modules as a feature request or a pull request. - - Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. -- Adding additional Infrastructure as Code to customize it for their company. -- Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). -- For Reference Architecture customers: - - Following all provided manual steps in the Reference Architecture documents where automation is not possible. - - Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. - - Designing and implementing their AWS infrastructure beyond the Reference Architecture. - - Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). - - Once deployed, maintaining the Reference Architecture to keep it secure and up to date. - - Keeping the Reference Architecture secure in accordance with their company needs. - - Understanding and accepting the security implications of any changes made to the Reference Architecture. - - Monitoring Gruntwork repositories for updates and new releases and applying them as appropriate. - - Maintaining all compliance standards after the Reference Architecture has been delivered. +:::note + +The implementation and maintenance of Gruntwork products in AWS is a shared responsibility between Gruntwork and the customer. + +::: + +## Gruntwork is responsible for: + +1. Providing a tested, updated, and richly featured collection of infrastructure code for the customer to use. +1. Maintaining a healthy Knowledge Base community where other engineers (including Grunts) post & answer questions. +1. For Pro / Enterprise Support customers: Answering questions via email and Slack. +1. For Reference Architecture customers: + 1. Generating the initial Reference Architecture based on our customer’s selections of available configurations. This includes: + 1. Our implementation of Landing Zone + 1. A complete sample app with underlying database and caching layer + 1. The Gruntwork Pipeline for deploying changes to infrastructure + 1. An overview of how to use the Reference Architecture + 1. Manual steps the customer needs to take that can only be done by the customer + 1. Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. + 1. Delivering the initial Reference Architecture Infrastructure as Code to the customer. + 1. Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. +1. For CIS customers: + 1. Providing IaC libraries to the CIS customer that correctly implement CIS requirements and restrictions. + 1. For aspects of the CIS AWS Foundations Benchmark where those requirements cannot be met by modules, but require human intervention, provide instructions on manual steps the customer must take to meet the requirements. + 1. For CIS Reference Architecture customers, deploying a Reference Architecture and providing access to infrastructure code that implements the CIS AWS Foundations Benchmark requirements out-of-the-box, wherever possible. + +## As a Gruntwork customer, you are responsible for: + +1. Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. + 1. Raise limitations of Gruntwork modules as a feature request or a pull request. + 1. Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. +1. Adding additional Infrastructure as Code to customize it for their company. +1. Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). +1. For Reference Architecture customers: + 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. + 1. Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. + 1. Designing and implementing their AWS infrastructure beyond the Reference Architecture. + 1. Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). + 1. Once deployed, maintaining the Reference Architecture to keep it secure and up to date. + 1. Keeping the Reference Architecture secure in accordance with their company needs. + 1. Understanding and accepting the security implications of any changes made to the Reference Architecture. + 1. Monitoring Gruntwork repositories for updates and new releases and applying them as appropriate. + 1. Maintaining all compliance standards after the Reference Architecture has been delivered. From df01ae0f4f831233d5a5f123a6434c7bd9980e8f Mon Sep 17 00:00:00 2001 From: Zachary Proser Date: Tue, 2 May 2023 15:48:59 -0400 Subject: [PATCH 3/6] Implement quick fixes for typos / voice changes --- docs/guides/stay-up-to-date/index.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/docs/guides/stay-up-to-date/index.md b/docs/guides/stay-up-to-date/index.md index a332f9130e..d6d6f16e0b 100644 --- a/docs/guides/stay-up-to-date/index.md +++ b/docs/guides/stay-up-to-date/index.md @@ -16,22 +16,7 @@ import CardGroup from "/src/components/CardGroup" - - - - - - - - - - - - - - - - + @@ -113,7 +98,7 @@ href="/guides/stay-up-to-date/cis/cis-1.5.0" From b7602262dd09c02dbdfa6ea1b785973660d2ed65 Mon Sep 17 00:00:00 2001 From: Zachary Proser Date: Tue, 2 May 2023 15:59:20 -0400 Subject: [PATCH 4/6] Replace another their with your --- _docs-sources/intro/overview/shared-responsibility-model.md | 4 ++-- docs/intro/overview/shared-responsibility-model.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_docs-sources/intro/overview/shared-responsibility-model.md b/_docs-sources/intro/overview/shared-responsibility-model.md index 7995e81219..406e31df86 100644 --- a/_docs-sources/intro/overview/shared-responsibility-model.md +++ b/_docs-sources/intro/overview/shared-responsibility-model.md @@ -30,8 +30,8 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp 1. Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. 1. Raise limitations of Gruntwork modules as a feature request or a pull request. - 1. Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. -1. Adding additional Infrastructure as Code to customize it for their company. + 1. N.B., Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, so we will be selective about features added and pull requests accepted. +1. Adding additional Infrastructure as Code to customize it for your company. 1. Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). 1. For Reference Architecture customers: 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. diff --git a/docs/intro/overview/shared-responsibility-model.md b/docs/intro/overview/shared-responsibility-model.md index ce262013a7..5c1e519394 100644 --- a/docs/intro/overview/shared-responsibility-model.md +++ b/docs/intro/overview/shared-responsibility-model.md @@ -30,8 +30,8 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp 1. Staffing appropriately (as described in the [Prerequisites Guide](/intro/overview/reference-architecture-prerequisites-guide/)) to maintain and customize the modules and (if applicable) the Reference Architecture and to understand how the Gruntwork product works so that changes can be made to customize it to the customer’s needs. 1. Raise limitations of Gruntwork modules as a feature request or a pull request. - 1. Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, and will be selective about features to be added. -1. Adding additional Infrastructure as Code to customize it for their company. + 1. N.B., Gruntwork does not guarantee any turn-around time on getting features built or PRs reviewed and merged. Gruntwork modules must also be applicable to a wide range of companies, so we will be selective about features added and pull requests accepted. +1. Adding additional Infrastructure as Code to customize it for your company. 1. Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). 1. For Reference Architecture customers: 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. @@ -48,6 +48,6 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp From 287bc88471b2dc4ac7ec8f00ff6039ab7626dea5 Mon Sep 17 00:00:00 2001 From: Zachary Proser Date: Tue, 2 May 2023 16:07:44 -0400 Subject: [PATCH 5/6] Additional tweaks for legibility --- .../intro/overview/shared-responsibility-model.md | 10 +++++----- docs/intro/overview/shared-responsibility-model.md | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/_docs-sources/intro/overview/shared-responsibility-model.md b/_docs-sources/intro/overview/shared-responsibility-model.md index 406e31df86..0693e0c5b4 100644 --- a/_docs-sources/intro/overview/shared-responsibility-model.md +++ b/_docs-sources/intro/overview/shared-responsibility-model.md @@ -17,7 +17,6 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp 1. A complete sample app with underlying database and caching layer 1. The Gruntwork Pipeline for deploying changes to infrastructure 1. An overview of how to use the Reference Architecture - 1. Manual steps the customer needs to take that can only be done by the customer 1. Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. 1. Delivering the initial Reference Architecture Infrastructure as Code to the customer. 1. Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. @@ -34,10 +33,11 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp 1. Adding additional Infrastructure as Code to customize it for your company. 1. Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). 1. For Reference Architecture customers: - 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. - 1. Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. - 1. Designing and implementing their AWS infrastructure beyond the Reference Architecture. - 1. Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). + 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. There are certain steps a Reference Architecture customer must perform on their own. Please keep an eye out for emails from Gruntwork engineers when you are configuring your Reference Architecture form for + deployment. + 1. Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit your deployment requirements. + 1. Designing and implementing your AWS infrastructure beyond the Reference Architecture. + 1. Understanding and awareness of AWS resource costs for all infrastructure deployed into your AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). 1. Once deployed, maintaining the Reference Architecture to keep it secure and up to date. 1. Keeping the Reference Architecture secure in accordance with their company needs. 1. Understanding and accepting the security implications of any changes made to the Reference Architecture. diff --git a/docs/intro/overview/shared-responsibility-model.md b/docs/intro/overview/shared-responsibility-model.md index 5c1e519394..7c8b1017bf 100644 --- a/docs/intro/overview/shared-responsibility-model.md +++ b/docs/intro/overview/shared-responsibility-model.md @@ -17,7 +17,6 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp 1. A complete sample app with underlying database and caching layer 1. The Gruntwork Pipeline for deploying changes to infrastructure 1. An overview of how to use the Reference Architecture - 1. Manual steps the customer needs to take that can only be done by the customer 1. Deploying the initial Reference Architecture into the customer’s brand new empty AWS accounts. 1. Delivering the initial Reference Architecture Infrastructure as Code to the customer. 1. Providing resources to the customer for deeply understanding the inner workings of the Reference Architecture. @@ -34,10 +33,11 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp 1. Adding additional Infrastructure as Code to customize it for your company. 1. Communicating with AWS to fix account issues and limitations beyond Gruntwork’s control (quotas, account verification, et cetera). 1. For Reference Architecture customers: - 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. - 1. Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit their deployment requirements. - 1. Designing and implementing their AWS infrastructure beyond the Reference Architecture. - 1. Understanding and awareness of AWS resource costs for all infrastructure deployed into their AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). + 1. Following all provided manual steps in the Reference Architecture documents where automation is not possible. There are certain steps a Reference Architecture customer must perform on their own. Please keep an eye out for emails from Gruntwork engineers when you are configuring your Reference Architecture form for + deployment. + 1. Extending and customizing Gruntwork Pipelines beyond the basic CI/CD pipeline that Gruntwork has provided to suit your deployment requirements. + 1. Designing and implementing your AWS infrastructure beyond the Reference Architecture. + 1. Understanding and awareness of AWS resource costs for all infrastructure deployed into your AWS accounts ([Knowledge Base #307](https://github.com/gruntwork-io/knowledge-base/discussions/307) for Ref Arch baseline). 1. Once deployed, maintaining the Reference Architecture to keep it secure and up to date. 1. Keeping the Reference Architecture secure in accordance with their company needs. 1. Understanding and accepting the security implications of any changes made to the Reference Architecture. @@ -48,6 +48,6 @@ The implementation and maintenance of Gruntwork products in AWS is a shared resp From 725c5745bd304191e557182be304bded1048bacd Mon Sep 17 00:00:00 2001 From: Oreoluwa Agunbiade Date: Thu, 11 May 2023 10:16:54 -0600 Subject: [PATCH 6/6] Revert changes to stay-up-to-date guide --- docs/guides/stay-up-to-date/index.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/guides/stay-up-to-date/index.md b/docs/guides/stay-up-to-date/index.md index d6d6f16e0b..a332f9130e 100644 --- a/docs/guides/stay-up-to-date/index.md +++ b/docs/guides/stay-up-to-date/index.md @@ -16,7 +16,22 @@ import CardGroup from "/src/components/CardGroup" - + + + + + + + + + + + + + + + + @@ -98,7 +113,7 @@ href="/guides/stay-up-to-date/cis/cis-1.5.0"