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.

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(mutelist): remove MUTED and explain new fields #3726

Merged

Conversation

jfagoagas
Copy link
Member

Context

Since Prowler v4, WARNING or MUTED are not valid statuses, the finding has a muted attribute to store if muted or not.

Description

MUTED is not valid status anymore. Remove it from the documentation.

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@jfagoagas jfagoagas requested a review from a team April 9, 2024 09:05
Copy link
Contributor

github-actions bot commented Apr 9, 2024

You can check the documentation for this PR here -> SaaS Documentation

Copy link
Contributor

github-actions bot commented Apr 9, 2024

You can check the documentation for this PR here -> SaaS Documentation

Copy link
Contributor

github-actions bot commented Apr 9, 2024

You can check the documentation for this PR here -> SaaS Documentation

@@ -108,23 +114,23 @@ If you want to mute failed findings only in specific regions, create a file with
Resources:
- "*"

## Default AWS Mutelist
### Default Mutelist
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not remove AWS, since the default mutelist is only available for AWS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same again, I've included an AWS section to enclose this.

For the AWS Provider, Prowler is executed with a Default AWS Mutelist with the AWS Resources that should be muted such as all resources created by AWS Control Tower when setting up a landing zone.
You can see this Mutelist file in [`prowler/config/aws_mutelist.yaml`](https://github.com/prowler-cloud/prowler/blob/master/prowler/config/aws_allowlist.yaml).

## Supported AWS Mutelist Locations
### Supported Mutelist Locations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not remove AWS, since this locations are only available for AWS Mutelists

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is within a new AWS section.

Copy link
Member

@sergargar sergargar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔝🔝🔝

@sergargar sergargar merged commit 4342604 into master Apr 9, 2024
10 checks passed
@sergargar sergargar deleted the PRWLR-3485-docs-remove-muted-from-mutelist-documentation branch April 9, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants