Skip to content

Update api-keys.asciidoc - API key prerequisites#21026

Merged
dedemorton merged 2 commits intomasterfrom
rwaight-docs-patch-20200908
Sep 8, 2020
Merged

Update api-keys.asciidoc - API key prerequisites#21026
dedemorton merged 2 commits intomasterfrom
rwaight-docs-patch-20200908

Conversation

@rwaight
Copy link
Copy Markdown
Contributor

@rwaight rwaight commented Sep 8, 2020

What does this PR do?

Clarify the API key documentation by adding references to the Beats privileges documentation

Why is it important?

Improve user experience with updates to the Beats API key documentation

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.

Author's Checklist

  • Discuss proposed changes with @elastic/docs team

Related issues

Use cases

Assist users with their initial configuration of Beats, using API keys

@rwaight
Update api-keys.asciidoc - API key prerequisites
0f114ce 
Add references to required privileges within the API key examples
@rwaight rwaight added enhancement docs needs_reviewer PR needs to be assigned a reviewer Team:Docs Label for the Observability docs team labels Sep 8, 2020
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Sep 8, 2020

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 Sep 8, 2020
@rwaight rwaight requested a review from dedemorton September 8, 2020 20:35
dedemorton
dedemorton approved these changes Sep 8, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

Minor change, otherwise LGTM.

@rwaight rwaight removed the needs_reviewer PR needs to be assigned a reviewer label Sep 8, 2020
@rwaight @dedemorton
Update libbeat/docs/security/api-keys.asciidoc
7a98f2e 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@dedemorton dedemorton self-assigned this Sep 8, 2020
@rwaight rwaight added the needs_backport PR is waiting to be backported to other branches. label Sep 8, 2020
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Sep 8, 2020 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #21026 updated]

  • Start Time: 2020-09-08T20:36:42.938+0000

  • Duration: 23 min 28 sec

@dedemorton dedemorton merged commit 7326d5d into master Sep 8, 2020
@dedemorton dedemorton deleted the rwaight-docs-patch-20200908 branch September 8, 2020 21:44
dedemorton added a commit to dedemorton/beats that referenced this pull request Sep 8, 2020
@rwaight @dedemorton
Update api-keys.asciidoc - API key prerequisites (elastic#21026)
11d5257 
* Update api-keys.asciidoc - API key prerequisites

Add references to required privileges within the API key examples

* Update libbeat/docs/security/api-keys.asciidoc

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
This was referenced Sep 8, 2020
Merged
Merged
dedemorton added a commit to dedemorton/beats that referenced this pull request Sep 8, 2020
@rwaight @dedemorton
Update api-keys.asciidoc - API key prerequisites (elastic#21026)
4d0b10f 
* Update api-keys.asciidoc - API key prerequisites

Add references to required privileges within the API key examples

* Update libbeat/docs/security/api-keys.asciidoc

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Sep 8, 2020
dedemorton added a commit that referenced this pull request Sep 10, 2020
@dedemorton @rwaight
Update api-keys.asciidoc - API key prerequisites (#21026) (#21029)
1337c65 
* Update api-keys.asciidoc - API key prerequisites

Add references to required privileges within the API key examples

* Update libbeat/docs/security/api-keys.asciidoc

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Rob Waight <43173714+rwaight@users.noreply.github.com>
dedemorton added a commit that referenced this pull request Sep 10, 2020
@dedemorton @rwaight
Update api-keys.asciidoc - API key prerequisites (#21026) (#21028)
100f8ec 
* Update api-keys.asciidoc - API key prerequisites

Add references to required privileges within the API key examples

* Update libbeat/docs/security/api-keys.asciidoc

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Rob Waight <43173714+rwaight@users.noreply.github.com>
v1v added a commit to v1v/beats that referenced this pull request Sep 14, 2020
@v1v
Merge remote-tracking branch 'upstream/master' into feature/windows-10
cc07c42 
* upstream/master: (362 commits)
  Add vendoring to Google Cloud Functions again (elastic#21070)
  [Elastic Agent] Add fleet.host.id for sending to endpoint. (elastic#21042)
  Do not need Google credentials before using it (elastic#21072)
  [Filebeat][New Module] Zoom webhook module (elastic#20414)
  Add support for GMT timezone offset in decode_cef (elastic#20993)
  Filebeat: Fix random error on harvester close (elastic#21048)
  Add ingress controller dashboards (elastic#21052)
  Fix loggers in composable module. (elastic#21047)
  [Ingest Manager] Increase kibana client timeout to 5 minutes (elastic#21037)
  Add changelog. (elastic#21041)
  [Elastic Agent] Add support for EQL based conditions (elastic#20994)
  Disable Kafka metricsets based on Jolokia (elastic#20989)
  Update apm agent (elastic#21031)
  Add container ECS fields in kubernetes metadata (elastic#20984)
  Sanitize event.host in Metricbeat (elastic#21022)
  Update api-keys.asciidoc - API key prerequisites (elastic#21026)
  [Filebeat][suricata] Map x509 for suricata/eve fileset (elastic#20973)
  [Filebeat][santa] Map x509 fields in santa module (elastic#20976)
  [Filebeat][fortinet] Map x509 ecs fields for fortinet fw fileset (elastic#20983)
  Bump zeek kerberos/ssl/x509 ecs version (elastic#21003)
  ...
v1v added a commit to v1v/beats that referenced this pull request Sep 14, 2020
@v1v
Merge remote-tracking branch 'upstream/master' into feature/windows-7-64
fcc41b4 
* upstream/master: (364 commits)
  Add vendoring to Google Cloud Functions again (elastic#21070)
  [Elastic Agent] Add fleet.host.id for sending to endpoint. (elastic#21042)
  Do not need Google credentials before using it (elastic#21072)
  [Filebeat][New Module] Zoom webhook module (elastic#20414)
  Add support for GMT timezone offset in decode_cef (elastic#20993)
  Filebeat: Fix random error on harvester close (elastic#21048)
  Add ingress controller dashboards (elastic#21052)
  Fix loggers in composable module. (elastic#21047)
  [Ingest Manager] Increase kibana client timeout to 5 minutes (elastic#21037)
  Add changelog. (elastic#21041)
  [Elastic Agent] Add support for EQL based conditions (elastic#20994)
  Disable Kafka metricsets based on Jolokia (elastic#20989)
  Update apm agent (elastic#21031)
  Add container ECS fields in kubernetes metadata (elastic#20984)
  Sanitize event.host in Metricbeat (elastic#21022)
  Update api-keys.asciidoc - API key prerequisites (elastic#21026)
  [Filebeat][suricata] Map x509 for suricata/eve fileset (elastic#20973)
  [Filebeat][santa] Map x509 fields in santa module (elastic#20976)
  [Filebeat][fortinet] Map x509 ecs fields for fortinet fw fileset (elastic#20983)
  Bump zeek kerberos/ssl/x509 ecs version (elastic#21003)
  ...
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
@dedemorton @rwaight
Update api-keys.asciidoc - API key prerequisites (elastic#21026) (ela…
9bd0684 
…stic#21028)

* Update api-keys.asciidoc - API key prerequisites

Add references to required privileges within the API key examples

* Update libbeat/docs/security/api-keys.asciidoc

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Rob Waight <43173714+rwaight@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@dedemorton dedemorton dedemorton approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@dedemorton dedemorton

Labels

docs enhancement 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

@rwaight @elasticmachine @dedemorton