-
Notifications
You must be signed in to change notification settings - Fork 171
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
Update slo-privileges.asciidoc #4643
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
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. |
Image with correct SLO permissions
@@ -35,11 +35,12 @@ To create a role: | |||
Set the following privileges for the SLO Editor role: | |||
|
|||
. Under *Index privileges* in the *Elasticsearch* section, add `.slo-observability-*` to the *Indices* field and `read`, `view_index_metadata`, `write`, and `manage` to the *Privileges* field. | |||
. Under *Cluster privileges* add `manage_transform` as SLO most likely to create the transform respect to your SLO. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what you're trying to say here. Is there an issue or something else that explains why this privilege is needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reason of needing the privilege is that SLOs create transforms under the hood, so I would suggest something like:
Under Cluster privileges add
manage_transform
as SLOs rely on Elasticsearch transforms.
Or just the need without any explanation (we are not offering explanations in the other privileges required):
Under Cluster privileges add
manage_transform
.
Or something like SLOs need transforms privileges to work
.
We have recently added a new doc section called Understanding SLO internals
with an introduction explaining the relation between SLOs and transforms. We could link to that document to provide background (https://www.elastic.co/guide/en/observability/current/slo-troubleshoot-slos.html#slo-understanding-slos).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Users should not need manage_transform
privileges in 8.16. We removed this requirement in an earlier version. Are you receiving reports of SLOs not working without manage_transforms
? IF so, what version?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text in this image is small and pretty difficult to read and there's a lot of whitespace. Can you reduce the width of your browser window before taking a screenshot? You can refer to the existing image for guidance on an appropriate width.
. Click *Add index privilege*. | ||
. In the *Indices* field, add the indices for which you plan to create SLOs. Then, add `read` and `view_index_metadata` to the *Privileges* field. The following example shows `logs-*`, but you can specify any indices. | ||
+ | ||
[role="screenshot"] | ||
image::images/slo-es-priv-editor.png[Cluster and index privileges for SLO Editor role] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this image is no longer needed, you should delete it. Alternatively you could rename your new image slo-es-priv-editor.png
so it replaces the existing image.
After a conversation with @AkashPrakashShinde he has also realized that @dominiqueclarke , if you remember we updated the privileges needed for SLOs a few months ago under this issue: #4229 It looks we might have missed cluster privileges Would you please take a look and confirm if the privileges are needed? I'm pretty sure the As soon as you confirm we will fix the docs through this PR. |
@dominiqueclarke : @AkashPrakashShinde also found another issue in the docs. Without fixing the privileges the user gets this type of error when accessing SLOs view: In summary, we need to clarify if we have to fix these items in the doc:
If you prefer we can create an issue instead of discussing the problem in this PR. Oh... now I see in #4229 it's mentioned:
So we need to clarify if that statement was accurate, as apparently if a user without the manage_transform privilege creates a SLO using the API it ends up like: ![]() |
I'm closing this PR and created the issue #4720 to determine if we really need a docs change or if this should be treated as a product issue. |
Description
Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #
Checklist
Follow-up tasks
Select one.