fix markdown syntax errors and add security check

aws-samples · Aug 6, 2024 · d4c6876 · d4c6876
1 parent d9ba3ba
commit d4c6876
Show file tree

Hide file tree

Showing 10 changed files with 150 additions and 49 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,23 +1,55 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Description
+
+Please provide a clear and concise description of the issue you are encountering, and a reproduction of your configuration (see the `examples/*` directory for references that you can copy+paste and tailor to match your configs if you are unable to copy your exact configuration). The reproduction MUST be executable by running `terraform init && terraform apply` without any further changes.
+
+If your request is for a new feature, please use the `Feature request` template.
+
+- [ ] ✋ I have searched the open/closed issues and my issue is not listed.
+
+## ⚠️ Note
+
+Before you submit an issue, please perform the following first:
+
+1. Remove the local `.terraform` directory (! ONLY if state is stored remotely, which hopefully you are following that best practice!): `rm -rf .terraform/`
+2. Re-initialize the project root to pull down modules: `terraform init`
+3. Re-attempt your terraform plan or apply and check if the issue still persists
+
+## Versions
+
+- Module version [Required]:
+
+- Terraform version:
+<!-- Execute terraform -version -->
+- Provider version(s):
+<!-- Execute: terraform providers -version -->
+
+## Reproduction Code [Required]
+
+<!-- REQUIRED -->
+
+Steps to reproduce the behavior:
+
+<!-- Are you using workspaces? -->
+<!-- Have you cleared the local cache (see Notice section above)? -->
+<!-- List steps in order that led up to the issue you encountered -->
+
+## Expected behavior
+
+<!-- A clear and concise description of what you expected to happen -->
+
+## Actual behavior
+
+<!-- A clear and concise description of what actually happened -->
 
-**To Reproduce**
-Please specify the module/lab you've encountered this issue.
+### Terminal Output Screenshot(s)
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- Optional but helpful -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Additional context
 
-**Additional context**
-Add any other context about the problem here.
+<!-- Add any other context about the problem here -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,17 +1,30 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--- Please keep this note for the community --->
+
+### Community Note
+
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
+
+<!--- Thank you for keeping this note for the community --->
+
+#### What is the outcome that you are trying to reach?
+
+<!-- A clear and concise description of what the problem is. -->
+
+#### Describe the solution you would like
+
+<!-- A clear and concise description of what you want to happen. -->
+
+#### Describe alternatives you have considered
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+#### Additional context
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,18 @@
+---
+name: Question
+about: I have a Question
+---
+
+- [ ] ✋ I have searched the open/closed issues and my issue is not listed.
+
+#### Please describe your question here
+
+<!-- Provide as much information as possible to explain your question -->
+
+#### Provide a link to the example/module related to the question
+
+<!-- Please provide the link to the example related to this question from this repo -->
+
+#### Additional context
+
+<!-- Add any other context or screenshots about the question here -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
+# Description
+
+<!--
+🛑 Please open an issue first to discuss any significant work and flesh out details/direction - we would hate for your time to be wasted.
+Consult the [CONTRIBUTING](https://github.com/aws-ia/terraform-aws-eks-blueprints/blob/main/CONTRIBUTING.md#contributing-via-pull-requests) guide for submitting pull-requests.
+
+A brief description of the change being made with this pull request.
+-->
+
+### Motivation and Context
+
+<!-- What inspired you to submit this pull request? -->
+- Resolves #<issue-number>
+
+### How was this change tested?
+
+- [ ] Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
+- [ ] Yes, I have updated the [docs](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/docs) for this feature
+- [ ] Yes, I ran `pre-commit run -a` with this PR
+
+### Additional Notes
+
+<!-- Anything else we should know when reviewing? -->
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,4 +1,5 @@
-## Code of Conduct
+# Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-opensource-codeofconduct@amazon.com with any additional questions or comments.
+<opensource-codeofconduct@amazon.com> with any additional questions or comments.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -46,7 +46,7 @@ Looking at the existing issues is a great way to find something to contribute on
 
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-opensource-codeofconduct@amazon.com with any additional questions or comments.
+<opensource-codeofconduct@amazon.com> with any additional questions or comments.
 
 ## Security issue notifications
 

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-MIT No Attribution
+# MIT No Attribution
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 

diff --git a/README.md b/README.md
@@ -2,14 +2,20 @@
 
 ## Table of Contents
 
-1. [How to deploy Infrastructure and Besu cluster](#how-to-deploy)
-1. [Ingress Services](#ingress-services)
-1. [Configuring Index Pattern in Kibana](#configuring-index-pattern-in-kibana)
-1. [Testing Cluster Besu](#testing-cluster-besu)
-1. [Stop and Start Besu Services](#stop-and-start-besu)
-1. [Installing Sirato - Optional](#installing-sirato---optional)
-1. [Troubleshooting](#troubleshooting)
-1. [How to destroy infrastructure](#how-to-destroy)
+- [AWS - PSP Platform Egineering - Pilot](#aws---psp-platform-egineering---pilot)
+  - [Table of Contents](#table-of-contents)
+  - [Prerequisites](#prerequisites)
+    - [Roles and Permissions](#roles-and-permissions)
+    - [S3 for TFState Persistance](#s3-for-tfstate-persistance)
+    - [SSH Key](#ssh-key)
+  - [Networking](#networking)
+  - [Environment Variables](#environment-variables)
+  - [Control Plane Creation](#control-plane-creation)
+  - [Access to EKS Cluster](#access-to-eks-cluster)
+  - [Destroy EKS Cluster](#destroy-eks-cluster)
+  - [Troubleshooting session](#troubleshooting-session)
+  - [Security](#security)
+  - [License](#license)
 
 ## Prerequisites
 
@@ -25,8 +31,8 @@ Before you begin, make sure you have the following command line tools installed:
 Also, for a full provisioning experience, we should have at least:
 
 - 2 AWS Accounts
-    - Control Plane Account
-    - Data Plane Account
+  - Control Plane Account
+  - Data Plane Account
 
 ### Roles and Permissions
 
@@ -83,10 +89,10 @@ ssh-keygen -t ecdsa -f privatekey_name.pem
 You must have a VPC configured with:
 
 - 3 Private for Nodes
-    - Tag Subnets with kubernetes.io/role/internal-elb = 1
+  - Tag Subnets with kubernetes.io/role/internal-elb = 1
 - 3 Private Subnets for Pods (RFC6598): to use Custom Networking achieving higher scalability
 - 3 Public Subnets: to host Load Balancers
-    - Tag Subnets with kubernetes.io/role/elb = 1
+  - Tag Subnets with kubernetes.io/role/elb = 1
 
 IF you don`t have Internet access (through Internet Gateway): VPC Endpoints
 
@@ -177,7 +183,6 @@ GitHubAction-AssumeRoleWithAction
 -EC2 FullAdmin
 -VPC FullAdmin
 
-
 ### Create Control Plane Role in the Control Plane Account with the following permission
 GitHubAction-AssumeRoleWithAction
 -EKS FullAdmin
@@ -189,10 +194,10 @@ GitHubAction-AssumeRoleWithAction
 ## Troubleshooting session
 
 - If after full creation of the environment via terraform the ArgoCD service is still as ClusterIP, please check:
-    - Check the SSH key with right permissons to the repositories
-    - Repository URLs
-    - Repository branches
-    - Directory path on variable file or tfvar file
+  - Check the SSH key with right permissons to the repositories
+  - Repository URLs
+  - Repository branches
+  - Directory path on variable file or tfvar file
 - Check container logs
 - Check if repository URI is in correct form `git@github.com:ORG-NAME`
 
@@ -232,3 +237,11 @@ Check on argocd server if they have conectivity and permissions to clone the rep
 kubectl -n argocd exec --stdin --tty argo-cd-argocd-server-6c6b95b77f-2b65c -- /bin/bash
 git clone git@github.com:ORG-NAME/repository-name
 ```
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This library is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file.
diff --git a/terraform/versions.tf b/terraform/versions.tf
@@ -16,8 +16,8 @@ terraform {
     }
   }
   backend "s3" {
-     bucket = "BUCKETNAME"
-     key    = "controlplane/tfstate/psp-controlplane.tfstate"
-     region = "REGION"
- }
+    bucket = "BUCKETNAME"
+    key    = "controlplane/tfstate/psp-controlplane.tfstate"
+    region = "REGION"
+  }
 }