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

Fix missing remote_cluster docs #116366

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

jakelandis
Copy link
Contributor

Documentation for the remote_cluster in the role was added
in #111682 and #108840, but a few places were missed.
This commit fill the gaps in the documentation.

@jakelandis jakelandis added >docs General docs changes :Security/Security Security issues without another label labels Nov 6, 2024
Copy link
Contributor

github-actions bot commented Nov 6, 2024

Documentation preview:

@jakelandis jakelandis marked this pull request as ready for review November 6, 2024 23:00
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Security Meta label for security team labels Nov 6, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

Copy link
Contributor

@slobodanadamovic slobodanadamovic left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Left only a non-blocking question if we should update the example role to include remote_cluster.

@@ -80,7 +81,7 @@ POST /_security/role/remote-search
"privileges": [
"read",
"read_cross_cluster",
"view_index_metadata"
"view_index_metadata"
]
}
]
Copy link
Contributor

Choose a reason for hiding this comment

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

Wondering if we should update example remote-search role to include remote cluster privileges?

Suggested change
]
],
"remote_cluster": [
{
"privileges": [
"monitor_enrich"
],
"clusters": [
"my_remote_cluster"
]
}
]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not yet. This PR backfills some missing docs and will target elder docs where monitor_enrich is the privilege allowed (that usage is already covered in ES|QL docs where it is relevant). I will have another docs PR to introduce a new remote_cluster privilege and will consider it then.

@@ -75,7 +75,7 @@ that begin with `_` are reserved for system usage.
For more information, see
<<run-as-privilege>>.

`remote_indices`:: beta:[] (list) A list of remote indices permissions entries.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice catch!

@jakelandis jakelandis added v8.16.1 v8.17.0 auto-backport Automatically create backport pull requests when merged labels Nov 7, 2024
@jakelandis jakelandis merged commit e27c909 into elastic:main Nov 7, 2024
6 checks passed
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.16
8.x

jakelandis added a commit to jakelandis/elasticsearch that referenced this pull request Nov 7, 2024
Documentation for the remote_cluster in the role was added
in elastic#111682 and elastic#108840, but a few places were missed.
This commit fill the gaps in the documentation.
jakelandis added a commit to jakelandis/elasticsearch that referenced this pull request Nov 7, 2024
Documentation for the remote_cluster in the role was added
in elastic#111682 and elastic#108840, but a few places were missed.
This commit fill the gaps in the documentation.
elasticsearchmachine pushed a commit that referenced this pull request Nov 7, 2024
Documentation for the remote_cluster in the role was added
in #111682 and #108840, but a few places were missed.
This commit fill the gaps in the documentation.
elasticsearchmachine pushed a commit that referenced this pull request Nov 7, 2024
Documentation for the remote_cluster in the role was added
in #111682 and #108840, but a few places were missed.
This commit fill the gaps in the documentation.
jozala pushed a commit that referenced this pull request Nov 13, 2024
Documentation for the remote_cluster in the role was added
in #111682 and #108840, but a few places were missed.
This commit fill the gaps in the documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :Security/Security Security issues without another label Team:Docs Meta label for docs team Team:Security Meta label for security team v8.16.1 v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants