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

Add AWS Security Hub documentation #7111

Merged
merged 7 commits into from
Apr 8, 2024
Merged

Conversation

fdalmaup
Copy link
Member

@fdalmaup fdalmaup commented Mar 8, 2024

Description

Closes #6900. Adds the documentation for the new AWS Security Hub integration, adding new parameters for the AWS module reference and extending the available values with the security_hub type.

Checks

Docs building

  • Compiles without warnings.

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@fdalmaup fdalmaup self-assigned this Mar 8, 2024
@fdalmaup fdalmaup force-pushed the enhancement/6900-security-hub-docs branch from eb228e0 to b0915ac Compare March 8, 2024 17:52
@fdalmaup fdalmaup linked an issue Mar 8, 2024 that may be closed by this pull request
3 tasks
@fdalmaup fdalmaup force-pushed the enhancement/6900-security-hub-docs branch from f595890 to cd1624e Compare March 12, 2024 12:49
GGP1
GGP1 previously approved these changes Mar 12, 2024
Copy link
Member

@GGP1 GGP1 left a comment

Choose a reason for hiding this comment

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

LGTM, good job!

Copy link
Contributor

@Selutario Selutario left a comment

Choose a reason for hiding this comment

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

Just some minor suggestions:

Selutario
Selutario previously approved these changes Mar 15, 2024
Copy link
Contributor

@Selutario Selutario left a comment

Choose a reason for hiding this comment

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

LGTM!

@Selutario Selutario requested a review from javimed March 15, 2024 12:43
@javimed javimed added level/task Task issue type/enhancement Enhancement issue labels Mar 15, 2024
@@ -128,8 +130,8 @@ These authentication methods require using the ``/root/.aws/credentials`` file t

The available authentication configuration parameters are the following:

- ``<aws_profile>``: A valid profile name from a Shared Credential File or AWS Config File with the permission to read logs from the bucket.
- ``<aws_profile>``: A valid profile name from a Shared Credential File or AWS Config File with permission to read logs from the bucket.
Copy link
Member

Choose a reason for hiding this comment

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

If we could turn the concept phrases here into links would be a plus. These links would take the user to read about "Shared Credential File", "AWS Config File", "profile name", and "permissions to read logs from the bucket"

Copy link
Member Author

Choose a reason for hiding this comment

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

Added links for Shared Credential File and AWS Config File. The profile name link would be the same used for Shared Credential File since the .aws/credentials file is mentioned inside the Profiles section. This way the user will read about both topics.
In regards to the "permissions to read logs from the bucket", these have been abstracted in the /_templates/cloud/amazon/create_policy.rst, /_templates/cloud/amazon/bucket_policies.rst, and /_templates/cloud/amazon/attach_policy.rst files present in many of the other services (Config, Cloudtrail, etc.). I'm adding a link that contains information about Amazon S3 policy actions to it.

@fdalmaup fdalmaup force-pushed the enhancement/6900-security-hub-docs branch from a3556de to bce3de8 Compare April 4, 2024 15:42
@fdalmaup fdalmaup requested a review from javimed April 4, 2024 18:42
@fdalmaup fdalmaup requested a review from javimed April 4, 2024 20:27
@Selutario
Copy link
Contributor

This is fantastic! It significantly enhances Facu’s already commendable prior work. Thank you @javimed and @fdalmaup! 👏

@javimed javimed merged commit e917ab3 into 4.9.0 Apr 8, 2024
3 checks passed
@javimed javimed deleted the enhancement/6900-security-hub-docs branch April 8, 2024 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/enhancement Enhancement issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update AWS documentation with AWS Security Hub integration
4 participants