Cleanup AWS CloudFormation checks examples #118
Conversation
|
|
| AWSTemplateFormatVersion: 2010-09-09 | ||
| Description: Bad example of redshift sgr | ||
| Resources: | ||
| Queue: | ||
| Type: AWS::Redshift::ClusterSecurityGroup | ||
| Properties: | ||
| Description: "" | ||
|
|
There was a problem hiding this comment.
Yes. This check is related to resources using EC2-Classic, so the example provided is not relevant. Additionally, AWS has completely retired EC2-Classic as of August 23, 2023, so this check should probably be retired altogether.
| AWSTemplateFormatVersion: 2010-09-09 | ||
| Description: Good example of redshift sgr | ||
| Resources: | ||
|
|
There was a problem hiding this comment.
Yes. This check is related to resources using EC2-Classic, so the example provided is not relevant. Additionally, AWS has completely retired EC2-Classic as of August 23, 2023, so this check should probably be retired altogether.
There was a problem hiding this comment.
I understand. Your point about deprecating the check makes sense but I do think we should do that in a separate PR once we have added support for deprecating a check and for each such deprecated check we can update the docs separately. I've opened this to track adding support for deprecation of checks.
For the time being I would bring back these examples and as I mentioned we can open a separate PR to update both check and its docs.
Thoughts?
There was a problem hiding this comment.
Sure, I will restore these to their previous state.
There was a problem hiding this comment.
Thanks @StevenSmiley - looks like the tests are red. If you could update them we can merge this PR in. Thanks for the patience.
There was a problem hiding this comment.
I have updated the tests
There was a problem hiding this comment.
Still seem to be failing. You can run make test locally to run the tests.
| AWSTemplateFormatVersion: 2010-09-09 | ||
| Description: Good example of rds sgr | ||
| Resources: | ||
|
|
There was a problem hiding this comment.
Yes. This check is related to resources using EC2-Classic, so the example provided is not relevant. Additionally, AWS has completely retired EC2-Classic as of August 23, 2023, so this check should probably be retired altogether.
| AWSTemplateFormatVersion: 2010-09-09 | ||
| Description: Bad example of rds sgr | ||
| Resources: | ||
| Queue: | ||
| Type: AWS::RDS::DBSecurityGroup | ||
| Properties: | ||
| Description: "" | ||
|
|
There was a problem hiding this comment.
Yes. This check is related to resources using EC2-Classic, so the example provided is not relevant. Additionally, AWS has completely retired EC2-Classic as of August 23, 2023, so this check should probably be retired altogether.
|
I see that a test is failing during docs generation, can you provide guidance on how to resolve that? Am I supposed to copy each changed example into the docs files? |
|
Hi @StevenSmiley ! Just run |
|
Ah, easy. Done. |
This PR fixes a number of minor issues with the examples provided for AWS CloudFormation checks, including:
I've been using trivy lately and ran into a bunch of these, so I wanted to help fix them.