Skip to content

[AWS docs] Add required permissions for Custom AWS Logs#11891

Merged
alaudazzi merged 0 commit intomainfrom
fix-11603
Nov 29, 2024
Merged

[AWS docs] Add required permissions for Custom AWS Logs#11891
alaudazzi merged 0 commit intomainfrom
fix-11603

Conversation

@alaudazzi
Copy link
Copy Markdown
Member

This PR adds the specific permissions required to use the Custom AWS Logs integration, both for aws-s3 input and aws-cloudwatch input.

Closes #11603.

@alaudazzi alaudazzi added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request labels Nov 27, 2024
@alaudazzi alaudazzi self-assigned this Nov 27, 2024
@alaudazzi alaudazzi requested a review from a team as a code owner November 27, 2024 08:38
@andrewkroh andrewkroh added Integration:aws_logs Custom AWS Logs Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] labels Nov 27, 2024
Copy link
Copy Markdown
Contributor

@lucabelluccini lucabelluccini left a comment

Choose a reason for hiding this comment

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

Hello @alaudazzi
I would involve the owners / developer of the aws_logs integration for a double check.

To me, the pointers to the Filebeat aws-s3 doc and cloudwatch doc make sense, but I would have expected that the whole Requirement section of https://www.elastic.co/docs/current/integrations/aws#requirements would have been ported to https://www.elastic.co/docs/current/integrations/aws_logs.
IIUC, the permissions should be similar (just the AWS integration Requirement section mixes up both the permissions required for S3 and Cloudwatch).
Obviously the "cost" of this is we're duplicating the content.

If instead we want to tackle this problem properly in the follow up issue #11793, then this PR should be ok to allow users to understand which permissions are required.

I would ask @octavioranieri to review.

@octavioranieri
Copy link
Copy Markdown

+1 to @lucabelluccini suggestions above.

It's better to have it within the page (and product) instead of referencing to an external page.
we already do that under the parent page for https://www.elastic.co/docs/current/integrations/aws#aws-permissions

@alaudazzi
Copy link
Copy Markdown
Member Author

Duplicating content often leads to maintenance issues that are difficult to track.

@kaiyan-sheng
Copy link
Copy Markdown

@alaudazzi I agree with Luca on the whole Requirement section should be included as well. This is not necessarily permissions but should be mentioned as required for using the integration.

@alaudazzi
Copy link
Copy Markdown
Member Author

@kaiyan-sheng @octavioranieri
Thank you for your feedback.

@lucabelluccini

If instead we want to tackle this problem properly in the follow up issue #11793, then this PR should be ok to allow users to understand which permissions are required.

Yes, let's do that.

Please note that one of the points highlighted in the follow-up issue is locate the permissions set in one place to facilitate content standardization and maintenance.

@elasticmachine
Copy link
Copy Markdown

💚 Build Succeeded

History

cc @alaudazzi

@elastic-sonarqube
Copy link
Copy Markdown

@alaudazzi alaudazzi merged commit 82ae499 into main Nov 29, 2024
@alaudazzi alaudazzi deleted the fix-11603 branch November 29, 2024 09:22
@elastic-vault-github-plugin-prod
Copy link
Copy Markdown

Package aws_logs - 1.5.1 containing this change is available at https://epr.elastic.co/package/aws_logs/1.5.1/

harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 4, 2025
* Add required permissions for AWS custom logs

* Update changelog and manifest
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 5, 2025
* Add required permissions for AWS custom logs

* Update changelog and manifest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:aws_logs Custom AWS Logs Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[AWS docs] Required permissions under AWS custom logs

6 participants