Skip to content

[7.x] [DOCS] Update api_key example on elasticsearch output#28606

Merged
bmorelli25 merged 4 commits intoelastic:masterfrom
ugosan:master
Oct 25, 2021
Merged

[7.x] [DOCS] Update api_key example on elasticsearch output#28606
bmorelli25 merged 4 commits intoelastic:masterfrom
ugosan:master

Conversation

@ugosan
Copy link
Copy Markdown
Contributor

@ugosan ugosan commented Oct 22, 2021

What does this PR do?

The same as PR 28288 but for https://www.elastic.co/guide/en/beats/filebeat/current/securing-communication-elasticsearch.html
Update api_key example on elasticsearch output to include the id and the api_key

Why is it important?

Current example is misleading as the elasticsearch output uses api_key to refer to what should be id:api_key. A few customers have stumbled on this as they thought they would need only the api_key part from the POST /_security/api_key response:

{
  "id" : "ZCV7VnwBgnX0T19fN8Qe",
  "name" : "my-api-key",
  "expiration" : 1633624888071,
  "api_key" : "sWBxrOMISVCmEyGDlwwcOg"
}

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 22, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 22, 2021

This pull request does not have a backport label. Could you fix it @ugosan? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v./d./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Oct 22, 2021
@ugosan ugosan added the Team:Docs Label for the Observability docs team label Oct 22, 2021
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 22, 2021

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

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Oct 22, 2021
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 22, 2021

💚 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-10-22T15:22:00.577+0000

  • Duration: 20 min 59 sec

  • Commit: ba97f49

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

@ugosan ugosan requested a review from bmorelli25 October 22, 2021 15:44
bmorelli25
bmorelli25 approved these changes Oct 25, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Thank you! (again!)

@bmorelli25 bmorelli25 added backport-v7.16.0 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Oct 25, 2021
@bmorelli25 bmorelli25 self-assigned this Oct 25, 2021
@bmorelli25 bmorelli25 merged commit 54dcfd2 into elastic:master Oct 25, 2021
mergify bot pushed a commit that referenced this pull request Oct 25, 2021
@ugosan
docs: Update api_key example on elasticsearch output (#28606)
e231e22 
(cherry picked from commit 54dcfd2)
@mergify mergify bot mentioned this pull request Oct 25, 2021
Merged
v1v added a commit to v1v/beats that referenced this pull request Oct 26, 2021
@v1v
Merge remote-tracking branch 'upstream/master' into feature/remove-jo…
fcc08d9 
…urnalbeat-ci

* upstream/master: (49 commits)
  [CI]: use the downstream packaging pipeline for branches/tags (elastic#28589)
  fix: use declarative style for complete variant of the elastic-agent (elastic#28526)
  x-pack/auditbeat/tracing: fix regexp for kprobe description line (elastic#28609)
  docs: Update `api_key` example on elasticsearch output (elastic#28606)
  chore: add build scripts to CODEOWNERS (elastic#28615)
  Osquerybeat: Fix host_processes missing cmdline arguments (elastic#28622)
  Add note about changes to regexp package in Golang (elastic#28616)
  CI: nightly/weekly builds for 7.x targeting 7.16 instead (elastic#28612)
  Osquerybeat: Fix extenstion unable to start on windows (elastic#28598)
  Osquerybeat: Return the query result count with the action response (elastic#28576)
  Agent: Allow custom response properties in the action response (elastic#28575)
  [Heartbeat] Only setuid in elastic-agent image (elastic#28577)
  Fix formatting of `mapStateJSON` and `layerListJSON` in dashboard assets (elastic#28530)
  CI: refactor the run e2e build (elastic#28502)
  Use fsnotify with long windows name-safe changes (elastic#28517)
  Remove unneeded mergify config
  backport: Add 7.16 branch (elastic#28560)
  Add proxy_url support to threatintel module's malwarebazaar fileset (elastic#28533)
  Osquerybeat: Implement host_users, host_groups, host_processes tables as a part of our osquery_extension. (elastic#28434)
  [Heartbeat] Make run_once syntax a boolean (elastic#28548)
  ...
jsoriano pushed a commit that referenced this pull request Oct 29, 2021
@mergify @ugosan
docs: Update api_key example on elasticsearch output (#28606) (#28627)
9c2c578 
(cherry picked from commit 54dcfd2)

Co-authored-by: Ugo Sangiorgi <ugo.sangiorgi@elastic.co>
Icedroid pushed a commit to Icedroid/beats that referenced this pull request Nov 1, 2021
@ugosan
docs: Update api_key example on elasticsearch output (elastic#28606)
1335bc9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bmorelli25 bmorelli25 bmorelli25 approved these changes

Assignees

@bmorelli25 bmorelli25

Labels

backport-v7.16.0 Automated backport with mergify Team:Docs Label for the Observability docs team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ugosan @elasticmachine @bmorelli25