Docs: Add Configuring Elasticsearch documentation for required privileges #87593
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ivanahuckova
added
type/docs
datasource/Elasticsearch
no-backport
ivanahuckova
commented
May 10, 2024
docs/sources/datasources/elasticsearch/configure-elasticsearch-data-source.md
Outdated
Show resolved
Hide resolved
svennergr
reviewed
May 10, 2024
docs/sources/datasources/elasticsearch/configure-elasticsearch-data-source.md
Outdated
Show resolved
Hide resolved
…-data-source.md Co-authored-by: Sven Grossmann <sven.grossmann@grafana.com>
obetomuniz
added a commit
that referenced
this pull request
May 10, 2024
…-tracker * gops-configuration-tracker: (56 commits) SAML: add referemce to azure ad limitations (#87571) Update dependency glob to v10.3.14 Chore: Updated go.work.sum file (#87622) Update dependency @types/lodash to v4.17.1 (#87419) AdHocFilters: Use queries in ad hoc filters api calls (#87624) TimeSeries: Improve keyboard focus and fix spacebar override (#86848) Dropdown: Fixes double call to onVisibilityChange (#87607) [DOC] Adds missing link to Pyroscope core data source (#85493) Docs: Add Configuring Elasticsearch documentation for required privileges (#87593) Update dependency eslint-plugin-jsdoc to v48.2.4 Chore: Add login protection when user is trying different uppercase letters (#87588) Explore: lookup datasource by name when present in legacy URLs (#85222) Update dependency @prometheus-io/lezer-promql to v0.52.0 (#87554) Update dependency systemjs to v6.15.1 (#87594) Chore: Remove deprecated re-exported template variable types (#87459) Chore: Use getNextRefId instead of deprecated getNextRefIdChar (#87460) Chore: Remove use of deprecated method in AC code (#87541) Chore:: Update authlib version (#87603) Alerting: Reduce number of request fetching rules in the dashboard view using rtkq (#86991) refactor: rename variable ...
|
@svennergr |
|
@grvsoni you can find it on https://grafana.com/docs/grafana/next/datasources/elasticsearch/configure-elasticsearch-data-source/. Once Grafana 11.1 is released it's gonna be on latest. |
jdbaldry
reviewed
May 30, 2024
There was a problem hiding this comment.
Thanks for writing the docs!
I'm sorry I missed this during the docs offsite. I've added a suggestion to apply the style guide in Writers' Toolkit https://grafana.com/docs/writers-toolkit/
Comment on lines
+31
to
+37
| ## Configuring permissions | ||
|
|
||
| When Elasticsearch security features are enabled, it is essential to configure the necessary cluster privileges to ensure seamless operation. Below is a list of the required privileges along with their purposes: | ||
|
|
||
| - **monitor** - Necessary to retrieve the version information of the connected Elasticsearch instance. | ||
| - **view_index_metadata** - Required for accessing mapping definitions of indices. | ||
| - **read** - Grants the ability to perform search and retrieval operations on indices. This is essential for querying and extracting data from the cluster. |
There was a problem hiding this comment.
- Avoid gerunds in headings (verbs with an 'ing' ending): https://developers.google.com/style/headings
- Rewrites to use some active voice for configuring cluster privileges
- Rewrites the list to be parallel: https://developers.google.com/style/lists#parallel-syntax
Suggested change
| ## Configuring permissions | |
| When Elasticsearch security features are enabled, it is essential to configure the necessary cluster privileges to ensure seamless operation. Below is a list of the required privileges along with their purposes: | |
| - **monitor** - Necessary to retrieve the version information of the connected Elasticsearch instance. | |
| - **view_index_metadata** - Required for accessing mapping definitions of indices. | |
| - **read** - Grants the ability to perform search and retrieval operations on indices. This is essential for querying and extracting data from the cluster. | |
| ## Configure permissions | |
| When Elasticsearch security features are enabled, you must configure the necessary cluster privileges to ensure operation. | |
| Below is a list of the required privileges along with their purposes: | |
| - **monitor** - Retrieve the version information of the connected Elasticsearch instance. | |
| - **view_index_metadata** - Access mapping definitions of indices. | |
| - **read** - Perform search and retrieval operations on indices. | |
| This is essential for querying and extracting data from the cluster. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation about necessary cluster privilege.
Fixes https://github.com/grafana/support-escalations/issues/9096
Related to #79955