Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: documenting undocumented rules #231

Merged
merged 4 commits into from
Dec 24, 2021
Merged

docs: documenting undocumented rules #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3de0946
docs: documenting undocumented rules
PatMyron Dec 24, 2021
bc1a276
go generate
PatMyron Dec 24, 2021
98fc105
fix: best practice markdown column
PatMyron Dec 24, 2021
109e5c9
go generate
PatMyron Dec 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/rules/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
|aws_db_instance_invalid_parameter_group|Disallow using invalid parameter group|✔|✔|
|[aws_db_instance_invalid_type](aws_db_instance_invalid_type.md)|Disallow using invalid instance class||✔|
|aws_db_instance_invalid_vpc_security_group|Disallow using invalid VPC security groups|✔|✔|
|aws_dynamodb_table_invalid_stream_view_type|||✔|
|aws_elasticache_cluster_invalid_parameter_group|Disallow using invalid parameter group|✔|✔|
|aws_elasticache_cluster_invalid_security_group|Disallow using invalid security groups|✔|✔|
|aws_elasticache_cluster_invalid_subnet_group|Disallow using invalid subnet group|✔|✔|
Expand All @@ -25,13 +26,18 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
|aws_elb_invalid_instance|Disallow using invalid instances|✔|✔|
|aws_elb_invalid_security_group|Disallow using invalid security groups|✔|✔|
|aws_elb_invalid_subnet|Disallow using invalid subnets|✔|✔|
|[aws_iam_group_policy_too_long](aws_iam_group_policy_too_long.md)|||✔|
|[aws_iam_policy_sid_invalid_characters](aws_iam_policy_sid_invalid_characters.md)|||✔|
|[aws_iam_policy_too_long_policy](aws_iam_policy_too_long_policy.md)|||✔|
|aws_instance_invalid_ami|Disallow using invalid AMI|✔|✔|
|aws_instance_invalid_iam_profile|Disallow using invalid IAM profile|✔|✔|
|aws_instance_invalid_key_name|Disallow using invalid key name|✔|✔|
|aws_instance_invalid_subnet|Disallow using invalid subnet|✔|✔|
|aws_instance_invalid_vpc_security_group|Disallow using invalid VPC security groups|✔|✔|
|aws_launch_configuration_invalid_iam_profile|Disallow using invalid IAM profile|✔|✔|
|aws_launch_configuration_invalid_image_id|Disallow using invalid image ID|✔|✔|
|aws_mq_broker_invalid_engine_type|||✔|
|aws_mq_configuration_invalid_engine_type|||✔|
|aws_route_invalid_egress_only_gateway|Disallow using invalid egress only gateway|✔|✔|
|aws_route_invalid_gateway|Disallow using invalid gateway|✔|✔|
|aws_route_invalid_instance|Disallow using invalid instance|✔|✔|
Expand All @@ -41,6 +47,9 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
|aws_route_invalid_vpc_peering_connection|Disallow using invalid VPC peering connection|✔|✔|
|[aws_route_not_specified_target](aws_route_not_specified_target.md)|Disallow routes that have no targets||✔|
|[aws_route_specified_multiple_targets](aws_route_specified_multiple_targets.md)|Disallow routes that have multiple targets||✔|
|aws_s3_bucket_invalid_acl|||✔|
|aws_s3_bucket_invalid_region|||✔|
|aws_spot_fleet_request_invalid_excess_capacity_termination_policy|||✔|

### Best Practices/Naming Conventions

Expand All @@ -59,6 +68,7 @@ These rules enforce best practices and naming conventions:
|[aws_iam_policy_document_gov_friendly_arns](aws_iam_policy_document_gov_friendly_arns.md)|Ensure `iam_policy_document` data sources do not contain `arn:aws:` ARN's||
|[aws_iam_policy_gov_friendly_arns](aws_iam_policy_gov_friendly_arns.md)|Ensure `iam_policy` resources do not contain `arn:aws:` ARN's||
|[aws_iam_role_policy_gov_friendly_arns](aws_iam_role_policy_gov_friendly_arns.md)|Ensure `iam_role_policy` resources do not contain `arn:aws:` ARN's||
|[aws_lambda_function_deprecated_runtime](aws_lambda_function_deprecated_runtime.md)||✔|
|[aws_resource_missing_tags](aws_resource_missing_tags.md)|Require specific tags for all AWS resource types that support them||
|[aws_s3_bucket_name](aws_s3_bucket_name.md)|Ensures all S3 bucket names match the specified naming rules||

Expand Down
10 changes: 10 additions & 0 deletions docs/rules/README.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
|aws_db_instance_invalid_parameter_group|Disallow using invalid parameter group|✔|✔|
|[aws_db_instance_invalid_type](aws_db_instance_invalid_type.md)|Disallow using invalid instance class||✔|
|aws_db_instance_invalid_vpc_security_group|Disallow using invalid VPC security groups|✔|✔|
|aws_dynamodb_table_invalid_stream_view_type|||✔|
|aws_elasticache_cluster_invalid_parameter_group|Disallow using invalid parameter group|✔|✔|
|aws_elasticache_cluster_invalid_security_group|Disallow using invalid security groups|✔|✔|
|aws_elasticache_cluster_invalid_subnet_group|Disallow using invalid subnet group|✔|✔|
Expand All @@ -25,13 +26,18 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
|aws_elb_invalid_instance|Disallow using invalid instances|✔|✔|
|aws_elb_invalid_security_group|Disallow using invalid security groups|✔|✔|
|aws_elb_invalid_subnet|Disallow using invalid subnets|✔|✔|
|[aws_iam_group_policy_too_long](aws_iam_group_policy_too_long.md)|||✔|
|[aws_iam_policy_sid_invalid_characters](aws_iam_policy_sid_invalid_characters.md)|||✔|
|[aws_iam_policy_too_long_policy](aws_iam_policy_too_long_policy.md)|||✔|
|aws_instance_invalid_ami|Disallow using invalid AMI|✔|✔|
|aws_instance_invalid_iam_profile|Disallow using invalid IAM profile|✔|✔|
|aws_instance_invalid_key_name|Disallow using invalid key name|✔|✔|
|aws_instance_invalid_subnet|Disallow using invalid subnet|✔|✔|
|aws_instance_invalid_vpc_security_group|Disallow using invalid VPC security groups|✔|✔|
|aws_launch_configuration_invalid_iam_profile|Disallow using invalid IAM profile|✔|✔|
|aws_launch_configuration_invalid_image_id|Disallow using invalid image ID|✔|✔|
|aws_mq_broker_invalid_engine_type|||✔|
|aws_mq_configuration_invalid_engine_type|||✔|
|aws_route_invalid_egress_only_gateway|Disallow using invalid egress only gateway|✔|✔|
|aws_route_invalid_gateway|Disallow using invalid gateway|✔|✔|
|aws_route_invalid_instance|Disallow using invalid instance|✔|✔|
Expand All @@ -41,6 +47,9 @@ These rules warn of possible errors that can occur at `terraform apply`. Rules m
|aws_route_invalid_vpc_peering_connection|Disallow using invalid VPC peering connection|✔|✔|
|[aws_route_not_specified_target](aws_route_not_specified_target.md)|Disallow routes that have no targets||✔|
|[aws_route_specified_multiple_targets](aws_route_specified_multiple_targets.md)|Disallow routes that have multiple targets||✔|
|aws_s3_bucket_invalid_acl|||✔|
|aws_s3_bucket_invalid_region|||✔|
|aws_spot_fleet_request_invalid_excess_capacity_termination_policy|||✔|

### Best Practices/Naming Conventions

Expand All @@ -59,6 +68,7 @@ These rules enforce best practices and naming conventions:
|[aws_iam_policy_document_gov_friendly_arns](aws_iam_policy_document_gov_friendly_arns.md)|Ensure `iam_policy_document` data sources do not contain `arn:aws:` ARN's||
|[aws_iam_policy_gov_friendly_arns](aws_iam_policy_gov_friendly_arns.md)|Ensure `iam_policy` resources do not contain `arn:aws:` ARN's||
|[aws_iam_role_policy_gov_friendly_arns](aws_iam_role_policy_gov_friendly_arns.md)|Ensure `iam_role_policy` resources do not contain `arn:aws:` ARN's||
|[aws_lambda_function_deprecated_runtime](aws_lambda_function_deprecated_runtime.md)||✔|
|[aws_resource_missing_tags](aws_resource_missing_tags.md)|Require specific tags for all AWS resource types that support them||
|[aws_s3_bucket_name](aws_s3_bucket_name.md)|Ensures all S3 bucket names match the specified naming rules||

Expand Down