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

[8.14](backport #4193) [apm] Update APM feature roles docs #4355

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 7, 2024

In #3980 (comment), @endorama suggested that we clarify the docs on APM feature roles. Let me know what you think of this approach. I attempted to clarify how feature roles work and which privileges are required for different use cases by:

  • Reframing the intro to feature roles to emphasize that the what we're recommending is to create several feature-related roles and then assign one or more of these roles to each user (or group) based on which features the user needs to access.
  • Providing an example of when a user might need to be assigned multiple roles from this list of feature roles (this needs work).
  • Emphasizing that the Central configuration management role is required in most cases (unless central configuration management is explicitly disabled by the org/user).
  • Putting all roles on a single page to increase the likelihood that the reader will see the context provided in the intro paragraphs.
  • Adding a step at the end of the instructions for creating each role to remind users that they can assign other APM feature roles to the users as needed.

Here's what hasn't been addressed yet:

  • Verify that the privileges listed in each role are correct and reflect the latest version of APM / Elastic as a whole. (I'm not sure how to go about confirming or testing these.)
  • Are these the right feature roles? Are any missing? Should any be removed?

Here's the PR preview: https://observability-docs_bk_4193.docs-preview.app.elstc.co/guide/en/observability/master/apm-feature-roles.html

@endorama let me know what you think of this approach. If we're on the right track, we can iterate in this PR.

cc @simitt @carsonip


This is an automatic backport of pull request #4193 done by Mergify.

* initial attempt

* restructure

* fix build

* address initial feedback

* deprecate api key role

* fix typo

* add use cases

* reframe what we mean by users

* fix redirect

* add monitor privilege

* clean up structure

* Update docs/en/observability/apm/feature-roles.asciidoc

Co-authored-by: Edoardo Tenani <[email protected]>

* update docs/en/observability/apm/feature-roles.asciidoc

* Update feature-roles.asciidoc

* update docs/en/observability/apm/feature-roles.asciidoc

* use roles api in central config section

* apply suggestions from code review

Co-authored-by: Mike Birnstiehl <[email protected]>

---------

Co-authored-by: Edoardo Tenani <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
(cherry picked from commit d6a61fd)

# Conflicts:
#	docs/en/observability/apm/feature-roles.asciidoc
@mergify mergify bot requested a review from a team as a code owner October 7, 2024 21:10
@mergify mergify bot added backport conflicts There is a conflict in the backported pull request labels Oct 7, 2024
Copy link
Contributor Author

mergify bot commented Oct 7, 2024

Cherry-pick of d6a61fd has failed:

On branch mergify/bp/8.14/pr-4193
Your branch is up to date with 'origin/8.14'.

You are currently cherry-picking commit d6a61fd1.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/en/apm-server/redirects.asciidoc
	modified:   docs/en/observability/apm/command-reference.asciidoc
	modified:   docs/en/observability/redirects.asciidoc

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both added:      docs/en/observability/apm/feature-roles.asciidoc

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Copy link
Contributor

github-actions bot commented Oct 7, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@colleenmcginnis colleenmcginnis removed the conflicts There is a conflict in the backported pull request label Oct 7, 2024
@colleenmcginnis colleenmcginnis merged commit af8b39c into 8.14 Oct 7, 2024
4 checks passed
@colleenmcginnis colleenmcginnis deleted the mergify/bp/8.14/pr-4193 branch October 7, 2024 22:31
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.

1 participant