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][APM] Add apm_user role #10683

Merged
merged 4 commits into from
Feb 25, 2019
Merged

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Feb 11, 2019

This PR adds the new reserved roll apm_user to the documentation. See elastic/elasticsearch#38206 for more details.

A few things:

  1. Naming the role the way we did (apm_user) complicates things a lot. The documentation refers to a user as both the user and the role. To clarify, I swapped the use of user for account where applicable.
  2. The {beatname}_reader example no longer applies to APM. I cut this step out, but it meant I had to introduce a new attribute for this page called :role_name:. This maintains the use of "reader" for the beats examples, but swaps to "user" for the APM example. (fixed by simitt here)

@bmorelli25
Copy link
Member Author

@simitt - your idea worked perfectly! This solution is so much cleaner than the previous. Thank you

@dedemorton
Copy link
Contributor

Just a FYI that I'm planning to do a significant rewrite of the security topic. My proposal is here (feel free to comment and add details for APM): #10241 (comment)

@simitt
Copy link
Contributor

simitt commented Feb 15, 2019

@bmorelli25 it would be great if the issue elastic/apm-server#1579 could also be considered in the APM specific part of the security topic rewrite.

@bmorelli25
Copy link
Member Author

@dedemorton I know there's going to be a re-write soon, but I'm wondering if we can merge this PR in the meantime? It would be nice to have some documentation on this new role live.

Copy link
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.

LGTM. Note that I didn't run a build to test the output (I'll assume that you've done due diligence to test the conditions for Beats and APM).

@bmorelli25
Copy link
Member Author

Just did one final double check to make sure everything looks good for Beats and APM Server - and it does! Merging now...

@bmorelli25 bmorelli25 merged commit 2756877 into elastic:master Feb 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants