Skip to content

Commit 2cf45cf

Browse files
authored
docs: Update READMEs with provider versions (#127)
1 parent 2eab9e5 commit 2cf45cf

File tree

22 files changed

+61
-30
lines changed

22 files changed

+61
-30
lines changed

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ repos:
4747
hooks:
4848
- id: terraform_fmt
4949
# https://github.com/antonbabenko/pre-commit-terraform#terraform_validate
50-
- id: terraform_validate
51-
exclude: (test)|(examples-internal)\/.*$
5250
- id: terraform_docs
5351
args:
5452
- '--args=--sort-by required'
53+
- id: terraform_validate
54+
exclude: (test)|(examples-internal)\/.*$
5555
- id: terraform_tflint
5656
exclude: (test)|(examples-internal)\/.*$
5757
args:

Makefile

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
deps:
2+
go install github.com/terraform-docs/terraform-docs@v0.16.0
3+
go install github.com/hashicorp/terraform-config-inspect@latest
4+
curl -L "`curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip"`" -o tflint.zip && \
5+
unzip tflint.zip && \
6+
rm tflint.zip && \
7+
mv tflint "`go env GOPATH`/bin"
8+
9+
clean:
10+
find -name ".terraform" -type d | xargs rm -rf
11+
find -name ".terraform.lock.hcl" -type f | xargs rm -f
12+
13+
# https://github.com/antonbabenko/pre-commit-terraform/#terraform_validate
14+
# Adding this patch to fix organizational multi-provider terraform validate error
15+
# 'missing provider provider["registry.terraform.io/hashicorp/google"].multiproject'
16+
generate-terraform-providers:
17+
./resources/scripts/generate_providers.sh ./modules/infrastructure/permissions/org-role-ecs ./examples/organizational
18+
19+
terraform-init: generate-terraform-providers
20+
find -name "*.tf" | xargs dirname | uniq | xargs -I% -P0 sh -c 'cd %; terraform init --backend=false' 1>/dev/null
21+
22+
docs: clean generate-terraform-providers
23+
pre-commit run -a terraform_docs
24+
25+
lint: terraform-init
26+
pre-commit run -a terraform_validate
27+
pre-commit run -a terraform_tflint
28+
29+
fmt:
30+
find -name "*.tf" | xargs dirname | uniq | xargs -I% -P0 sh -c 'cd %; terraform fmt'
31+
pre-commit run -a terraform_fmt

examples/organizational/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,9 @@ $ terraform apply
145145

146146
| Name | Version |
147147
|------|---------|
148-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
149-
| <a name="provider_aws.member"></a> [aws.member](#provider\_aws.member) | 4.26.0 |
150-
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | 0.5.39 |
148+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0.0 |
149+
| <a name="provider_aws.member"></a> [aws.member](#provider\_aws.member) | >= 4.0.0 |
150+
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | >= 0.5.33 |
151151

152152
## Modules
153153

examples/single-account-apprunner/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ $ terraform apply
7272

7373
| Name | Version |
7474
|------|---------|
75-
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | 0.5.39 |
75+
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | >= 0.5.33 |
7676

7777
## Modules
7878

examples/single-account-ecs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ $ terraform apply
7272

7373
| Name | Version |
7474
|------|---------|
75-
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | 0.5.39 |
75+
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | >= 0.5.33 |
7676

7777
## Modules
7878

examples/single-account-k8s/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ $ terraform apply
8484

8585
| Name | Version |
8686
|------|---------|
87-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
88-
| <a name="provider_helm"></a> [helm](#provider\_helm) | 2.6.0 |
89-
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | 0.5.39 |
87+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0.0 |
88+
| <a name="provider_helm"></a> [helm](#provider\_helm) | >=2.3.0 |
89+
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | >= 0.5.33 |
9090

9191
## Modules
9292

examples/trigger-events/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ terraform apply
4949

5050
| Name | Version |
5151
|------|---------|
52-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
52+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0.0 |
5353

5454
## Modules
5555

modules/infrastructure/cloudtrail/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
| Name | Version |
1414
|------|---------|
15-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0.0 |
1616

1717
## Modules
1818

modules/infrastructure/cloudtrail_s3-sns-sqs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ EVENT FILTER/fine-tunning, regarding what we want to send to Sysdig Cloud-Connec
4646

4747
| Name | Version |
4848
|------|---------|
49-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
49+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
5050

5151
## Modules
5252

modules/infrastructure/codebuild/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
| Name | Version |
1414
|------|---------|
15-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1616

1717
## Modules
1818

modules/infrastructure/ecs-vpc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
| Name | Version |
1515
|------|---------|
16-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
16+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1717

1818
## Modules
1919

modules/infrastructure/permissions/cloud-connector/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
| Name | Version |
1414
|------|---------|
15-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1616

1717
## Modules
1818

modules/infrastructure/permissions/cloud-scanning/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
| Name | Version |
1414
|------|---------|
15-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1616

1717
## Modules
1818

modules/infrastructure/permissions/general/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ General permissions that apply to both cloud-connector and cloud-scanning module
1515

1616
| Name | Version |
1717
|------|---------|
18-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
18+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1919

2020
## Modules
2121

modules/infrastructure/permissions/iam-user/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Note: Contact us if this authentication system does not match your requirement.
4545

4646
| Name | Version |
4747
|------|---------|
48-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
48+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
4949

5050
## Modules
5151

modules/infrastructure/permissions/org-role-ecs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ The aim of this module is to manage the organizational **managed account** requi
3232

3333
| Name | Version |
3434
|------|---------|
35-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
36-
| <a name="provider_aws.member"></a> [aws.member](#provider\_aws.member) | 4.26.0 |
35+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
36+
| <a name="provider_aws.member"></a> [aws.member](#provider\_aws.member) | >= 3.50.0 |
3737

3838
## Modules
3939

modules/infrastructure/permissions/org-role-eks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The aim of this module is to manage the organizational **managed account** requi
2626

2727
| Name | Version |
2828
|------|---------|
29-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
29+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
3030

3131
## Modules
3232

modules/infrastructure/resource-group/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
| Name | Version |
1515
|------|---------|
16-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
16+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1717

1818
## Modules
1919

modules/infrastructure/sqs-sns-subscription/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
| Name | Version |
1414
|------|---------|
15-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
1616

1717
## Modules
1818

modules/infrastructure/ssm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ and pass it, in a safe way, to all the modules that require it.
1616

1717
| Name | Version |
1818
|------|---------|
19-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
19+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.50.0 |
2020

2121
## Modules
2222

modules/services/cloud-bench/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ This module will be deployed as a StackSet and it will take into account newly m
2828

2929
| Name | Version |
3030
|------|---------|
31-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
32-
| <a name="provider_random"></a> [random](#provider\_random) | 3.3.2 |
33-
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | 0.5.39 |
31+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.62.0 |
32+
| <a name="provider_random"></a> [random](#provider\_random) | >= 3.1.0 |
33+
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | >= 0.5.29 |
3434

3535
## Modules
3636

modules/services/cloud-connector-ecs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ A task deployed on an **ECS deployment** will detect events in your infrastructu
1515

1616
| Name | Version |
1717
|------|---------|
18-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.26.0 |
19-
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | 0.5.39 |
18+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0.0 |
19+
| <a name="provider_sysdig"></a> [sysdig](#provider\_sysdig) | >= 0.5.33 |
2020

2121
## Modules
2222

0 commit comments

Comments
 (0)