Skip to content

Commit 46d9337

Browse files
authored
Merge pull request #20 from aws-observability/dev
Merge with main
2 parents eaee1dd + f1a7b02 commit 46d9337

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+19543
-9
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: 🐞 Bug Report
2+
title: "[Bug]: <title>"
3+
description: Create a report to help us improve
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### How to write a good bug report?
10+
11+
- Respect the issue template as much as possible.
12+
- The title should be short and descriptive.
13+
- Explain the conditions which led you to report this issue and the context.
14+
- The context should lead to something, an idea or a problem that you’re facing.
15+
- Remain clear and concise.
16+
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
17+
18+
- type: checkboxes
19+
id: terms
20+
attributes:
21+
label: Welcome to Amazon EKS Blueprints!
22+
options:
23+
- label: Yes, I've searched similar issues on [GitHub](https://github.com/aws-observability/terraform-aws-observability-accelerator/issues) and didn't find any.
24+
required: true
25+
26+
- type: input
27+
attributes:
28+
label: Amazon EKS Blueprints Release version
29+
description: |
30+
`latest` is not considered as a valid version.
31+
Enter release number!
32+
placeholder: Your version here.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: What is your environment, configuration and the example used?
39+
description: |
40+
Terraform version, link to example used or your main.tf content etc.
41+
42+
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
43+
placeholder: Add information here.
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
attributes:
49+
label: What did you do and What did you see instead?
50+
description: |
51+
Provide error details and the expected details.
52+
53+
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
54+
placeholder: Add information here.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
attributes:
60+
label: Additional Information
61+
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
62+
placeholder: Add information here.
63+
render: shell
64+
validations:
65+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] <title>'
5+
labels: 'feature-request'
6+
assignees: ''
7+
8+
---
9+
10+
#### Is your feature request related to a problem? Please describe
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
14+
#### Describe the solution you'd like
15+
A clear and concise description of what you want to happen.
16+
17+
18+
#### Describe alternatives you've considered
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
22+
#### Additional context
23+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Question
3+
about: I have a Question
4+
title: '[QUESTION] <title>'
5+
labels: 'question'
6+
assignees: ''
7+
8+
---
9+
10+
#### Please describe your question here
11+
<!-- Provide as much information as possible to explain your question -->
12+
13+
14+
#### Provide link to the example related to the question
15+
<!-- Please provide the link to the example related to this question from this repo -->
16+
17+
18+
#### Additional context
19+
<!-- Add any other context or screenshots about the question here -->
20+
21+
22+
#### More
23+
24+
- [ ] Yes, I have checked the repo for existing issues before raising this question

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
### What does this PR do?
3+
4+
<!-- A brief description of the change being made with this pull request. -->
5+
6+
🛑 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 guide for submitting pull-requests.
7+
8+
9+
### Motivation
10+
11+
<!-- What inspired you to submit this pull request? -->
12+
13+
14+
### More
15+
16+
- [ ] Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
17+
- [ ] Yes, I have added a new example under [examples](https://github.com/aws-observability/terraform-aws-eks-blueprints/tree/main/examples) to support my PR
18+
- [ ] Yes, I have created another PR for add-ons under [add-ons](https://github.com/aws-samples/eks-blueprints-add-ons) repo (if applicable)
19+
- [ ] Yes, I have updated the [docs](https://github.com/aws-observability/terraform-aws-eks-blueprints/tree/main/docs) for this feature
20+
- [ ] Yes, I ran `pre-commit run -a` with this PR
21+
22+
23+
**Note**: Not all the PRs required examples and docs except a new pattern or add-on added.
24+
25+
### For Moderators
26+
- [ ] E2E Test successfully complete before merge?
27+
28+
### Additional Notes
29+
30+
<!-- Anything else we should know when reviewing? -->

.gitignore

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.DS_Store
2+
.idea
3+
.build
4+
5+
# Local .terraform directories
6+
**/.terraform/*
7+
8+
# Terraform lockfile
9+
.terraform.lock.hcl
10+
11+
# .tfstate files
12+
*.tfstate
13+
*.tfstate.*
14+
*.tfplan
15+
16+
# Crash log files
17+
crash.log
18+
19+
# Exclude all .tfvars files, which are likely to contain sentitive data, such as
20+
# password, private keys, and other secrets. These should not be part of version
21+
# control as they are data points which are potentially sensitive and subject
22+
# to change depending on the environment.
23+
*.tfvars
24+
25+
# Ignore override files as they are usually used to override resources locally and so
26+
# are not checked in
27+
override.tf
28+
override.tf.json
29+
*_override.tf
30+
*_override.tf.json
31+
32+
# Ignore CLI configuration files
33+
.terraformrc
34+
terraform.rc
35+
36+
# Locals
37+
kubeconfig*
38+
kube-config*
39+
local_tf_state/
40+
.vscode
41+
.gitallowed
42+
site
43+
.env*
44+
45+
# Checks
46+
.tfsec

.pre-commit-config.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.3.0
4+
hooks:
5+
- id: trailing-whitespace
6+
args: ['--markdown-linebreak-ext=md']
7+
- id: end-of-file-fixer
8+
- id: check-merge-conflict
9+
- id: detect-private-key
10+
- id: detect-aws-credentials
11+
args: ['--allow-missing-credentials']
12+
- repo: https://github.com/antonbabenko/pre-commit-terraform
13+
rev: v1.74.1
14+
hooks:
15+
- id: terraform_fmt
16+
- id: terraform_docs
17+
args:
18+
- '--args=--lockfile=false'
19+
- id: terraform_validate
20+
exclude: deploy
21+
- id: terraform_tflint
22+
args:
23+
- '--args=--only=terraform_deprecated_interpolation'
24+
- '--args=--only=terraform_deprecated_index'
25+
- '--args=--only=terraform_unused_declarations'
26+
- '--args=--only=terraform_comment_syntax'
27+
- '--args=--only=terraform_documented_outputs'
28+
- '--args=--only=terraform_documented_variables'
29+
- '--args=--only=terraform_typed_variables'
30+
- '--args=--only=terraform_module_pinned_source'
31+
- '--args=--only=terraform_naming_convention'
32+
- '--args=--only=terraform_required_version'
33+
- '--args=--only=terraform_required_providers'
34+
- '--args=--only=terraform_standard_module_structure'
35+
- '--args=--only=terraform_workspace_remote'
36+
- id: terraform_tfsec
37+
files: ^examples/ # only scan `examples/*` which are the implementation
38+
args:
39+
- --args=--config-file=__GIT_WORKING_DIR__/tfsec.yaml
40+
- --args=--concise-output

.tflint.hcl

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/module-inspection.md
2+
# borrowed & modified indefinitely from https://github.com/ksatirli/building-infrastructure-you-can-mostly-trust/blob/main/.tflint.hcl
3+
4+
plugin "aws" {
5+
enabled = true
6+
version = "0.14.0"
7+
source = "github.com/terraform-linters/tflint-ruleset-aws"
8+
}
9+
10+
config {
11+
module = true
12+
force = false
13+
}
14+
15+
rule "terraform_required_providers" {
16+
enabled = true
17+
}
18+
19+
rule "terraform_required_version" {
20+
enabled = true
21+
}
22+
23+
rule "terraform_naming_convention" {
24+
enabled = true
25+
format = "snake_case"
26+
}
27+
28+
rule "terraform_typed_variables" {
29+
enabled = true
30+
}
31+
32+
rule "terraform_unused_declarations" {
33+
enabled = true
34+
}
35+
36+
rule "terraform_comment_syntax" {
37+
enabled = true
38+
}
39+
40+
rule "terraform_deprecated_index" {
41+
enabled = true
42+
}
43+
44+
rule "terraform_deprecated_interpolation" {
45+
enabled = true
46+
}
47+
48+
rule "terraform_documented_outputs" {
49+
enabled = true
50+
}
51+
52+
rule "terraform_documented_variables" {
53+
enabled = true
54+
}
55+
56+
rule "terraform_module_pinned_source" {
57+
enabled = true
58+
}
59+
60+
rule "terraform_standard_module_structure" {
61+
enabled = true
62+
}
63+
64+
rule "terraform_workspace_remote" {
65+
enabled = true
66+
}

ADOPTERS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Who is using AWS Observability Accelerator for Terraform?
2+
3+
AWS Observability Accelerator for Terraform has a variety of users and use cases to configure and manage Observability on EKS/ECS clusters.
4+
Many customers want to learn from others who have already implemented AWS Observability Accelerator in their environments.
5+
6+
The following is a self-reported list of users to help identify adoption and points of contact.
7+
8+
## Add yourself
9+
10+
If you are using AWS Observability Accelerator please consider adding yourself as a user by opening a pull request to this file.
11+
12+
## Adopters (Alphabetical)
13+
14+
| Organization | Description | Contacts | Link |
15+
| --- | --- | --- | --- |

CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Require approvals from someone in the owner team before merging
2+
# More information here: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
3+
4+
* @aws-observability/aws-observability-accelerator

0 commit comments

Comments
 (0)