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: add note about aws creds #27434

Merged
merged 1 commit into from
Aug 19, 2021
Merged

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Aug 17, 2021

Backstory

@bmorelli25:

The AWS module documentation shows up in the metricbeat, filebeat, and heartbeat docs, but always refers to metricbeat config. See the filebeat docs for an example: https://www.elastic.co/guide/en/beats/filebeat/master/filebeat-module-aws.html#_supported_formats_2.

@kaiyan-sheng:

Yes this is by design. Because for all AWS related modules, no matter it's in Metricbeat, Filebeat or Functionbeat, it's all using the same credential options for authentication with AWS. Maybe under the Supported Formats section, we should remove the metricbeat.modules: line so it's less confusing? Thank you!

Proposed solution

@kaiyan-sheng, how do you feel about this solution? There are a lot of references to Metricbeat, so I'm not sure I want to remove the metricbeat.modules line. This PR adds a note at the top of the instructions that says Metricbeat is used for examples, but that the examples are applicable to any beat.

Related

For #24767.

@bmorelli25 bmorelli25 added release-note:skip The PR should be ignored when processing the changelog Team:Docs Label for the Observability docs team v7.14.0 v7.15.0 labels Aug 17, 2021
@bmorelli25 bmorelli25 self-assigned this Aug 17, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/obs-docs (Team:Docs)

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Aug 17, 2021
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-08-17T19:53:11.699+0000

  • Duration: 23 min 24 sec

  • Commit: 2f3c1ad

Trends 🧪

Image of Build Times

❕ Flaky test report

No test was executed to be analysed.

Copy link
Contributor

@kaiyan-sheng kaiyan-sheng left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!!

@bmorelli25 bmorelli25 merged commit a77c07c into elastic:master Aug 19, 2021
@bmorelli25 bmorelli25 deleted the docs-aws_updates branch August 19, 2021 03:28
bmorelli25 added a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
bmorelli25 added a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
# Conflicts:
#	x-pack/libbeat/docs/aws-credentials-config.asciidoc
bmorelli25 added a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
Icedroid pushed a commit to Icedroid/beats that referenced this pull request Nov 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note:skip The PR should be ignored when processing the changelog Team:Docs Label for the Observability docs team v7.14.0 v7.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants