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

update data view docs for excluding cluster #164904

Merged
merged 7 commits into from
Aug 31, 2023

Conversation

nreese
Copy link
Contributor

@nreese nreese commented Aug 25, 2023

elastic/elasticsearch#97865 expands index-pattern expressions to include a cluster alias for purposes of excluding an entire cluster from a cross-cluster search. This allows users to put the minus sign in front of the cluster name (-cluster_one:*). The advantage to this change is that it avoids sending any network calls to that cluster. Compare this to the existing syntax for excluding clusters, where the minus sign is in front of the index name (cluster_one:-*). The older syntax has to send the request to the remote cluster, which if it is down (and skip_unavailable=false), will cause the search to fail.

This PR updates the docs to reflect the new syntax.

@github-actions
Copy link
Contributor

Documentation preview:

@nreese nreese marked this pull request as ready for review August 25, 2023 23:01
@nreese nreese added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v8.10.0 v8.11.0 labels Aug 25, 2023
@elasticmachine
Copy link
Contributor

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

Copy link

@quux00 quux00 left a comment

Choose a reason for hiding this comment

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

LGTM

@nreese
Copy link
Contributor Author

nreese commented Aug 28, 2023

@elasticmachine merge upstream

@nreese
Copy link
Contributor Author

nreese commented Aug 31, 2023

@elasticmachine merge upstream

@nreese nreese merged commit 4b02740 into elastic:main Aug 31, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 31, 2023
elastic/elasticsearch#97865 expands
index-pattern expressions to include a cluster alias for purposes of
excluding an entire cluster from a cross-cluster search. This allows
users to put the minus sign in front of the cluster name
(`-cluster_one:*`). The advantage to this change is that it avoids
sending any network calls to that cluster. Compare this to the existing
syntax for excluding clusters, where the minus sign is in front of the
index name (`cluster_one:-*`). The older syntax has to send the request
to the remote cluster, which if it is down (and skip_unavailable=false),
will cause the search to fail.

This PR updates the docs to reflect the new syntax.

---------

Co-authored-by: Kibana Machine <[email protected]>
(cherry picked from commit 4b02740)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.10

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Aug 31, 2023
# Backport

This will backport the following commits from `main` to `8.10`:
- [update data view docs for excluding cluster
(#164904)](#164904)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Nathan
Reese","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-08-31T14:27:03Z","message":"update
data view docs for excluding cluster
(#164904)\n\nhttps://github.com/elastic/elasticsearch/pull/97865
expands\r\nindex-pattern expressions to include a cluster alias for
purposes of\r\nexcluding an entire cluster from a cross-cluster search.
This allows\r\nusers to put the minus sign in front of the cluster
name\r\n(`-cluster_one:*`). The advantage to this change is that it
avoids\r\nsending any network calls to that cluster. Compare this to the
existing\r\nsyntax for excluding clusters, where the minus sign is in
front of the\r\nindex name (`cluster_one:-*`). The older syntax has to
send the request\r\nto the remote cluster, which if it is down (and
skip_unavailable=false),\r\nwill cause the search to fail.\r\n\r\nThis
PR updates the docs to reflect the new
syntax.\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"4b02740b32542b6e84ee7a8abec9cb355f70db35","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v8.10.0","v8.11.0"],"number":164904,"url":"https://github.com/elastic/kibana/pull/164904","mergeCommit":{"message":"update
data view docs for excluding cluster
(#164904)\n\nhttps://github.com/elastic/elasticsearch/pull/97865
expands\r\nindex-pattern expressions to include a cluster alias for
purposes of\r\nexcluding an entire cluster from a cross-cluster search.
This allows\r\nusers to put the minus sign in front of the cluster
name\r\n(`-cluster_one:*`). The advantage to this change is that it
avoids\r\nsending any network calls to that cluster. Compare this to the
existing\r\nsyntax for excluding clusters, where the minus sign is in
front of the\r\nindex name (`cluster_one:-*`). The older syntax has to
send the request\r\nto the remote cluster, which if it is down (and
skip_unavailable=false),\r\nwill cause the search to fail.\r\n\r\nThis
PR updates the docs to reflect the new
syntax.\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"4b02740b32542b6e84ee7a8abec9cb355f70db35"}},"sourceBranch":"main","suggestedTargetBranches":["8.10"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/164904","number":164904,"mergeCommit":{"message":"update
data view docs for excluding cluster
(#164904)\n\nhttps://github.com/elastic/elasticsearch/pull/97865
expands\r\nindex-pattern expressions to include a cluster alias for
purposes of\r\nexcluding an entire cluster from a cross-cluster search.
This allows\r\nusers to put the minus sign in front of the cluster
name\r\n(`-cluster_one:*`). The advantage to this change is that it
avoids\r\nsending any network calls to that cluster. Compare this to the
existing\r\nsyntax for excluding clusters, where the minus sign is in
front of the\r\nindex name (`cluster_one:-*`). The older syntax has to
send the request\r\nto the remote cluster, which if it is down (and
skip_unavailable=false),\r\nwill cause the search to fail.\r\n\r\nThis
PR updates the docs to reflect the new
syntax.\r\n\r\n---------\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"4b02740b32542b6e84ee7a8abec9cb355f70db35"}}]}]
BACKPORT-->

Co-authored-by: Nathan Reese <[email protected]>
jrodewig added a commit that referenced this pull request Aug 31, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 31, 2023
kibanamachine referenced this pull request Aug 31, 2023
# Backport

This will backport the following commits from `main` to `8.10`:
- [[DOCS] Cross-link to ES CCS docs
(#165406)](#165406)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"James
Rodewig","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-08-31T20:26:32Z","message":"[DOCS]
Cross-link to ES CCS docs (#165406)\n\nCross-links to [Excluding
clusters or indices from cross-cluster
search](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-cross-cluster-search.html#exclude-problematic-clusters)
from [Use data views with cross-cluster
search](https://www.elastic.co/guide/en/kibana/current/data-views.html#management-cross-cluster-search).\r\n\r\nThis
was originally part of
https://github.com/elastic/kibana/pull/164904","sha":"ae12744b96dc6830384ddfd76814defeb4eb0289","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v8.10.0","v8.11.0"],"number":165406,"url":"https://github.com/elastic/kibana/pull/165406","mergeCommit":{"message":"[DOCS]
Cross-link to ES CCS docs (#165406)\n\nCross-links to [Excluding
clusters or indices from cross-cluster
search](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-cross-cluster-search.html#exclude-problematic-clusters)
from [Use data views with cross-cluster
search](https://www.elastic.co/guide/en/kibana/current/data-views.html#management-cross-cluster-search).\r\n\r\nThis
was originally part of
https://github.com/elastic/kibana/pull/164904","sha":"ae12744b96dc6830384ddfd76814defeb4eb0289"}},"sourceBranch":"main","suggestedTargetBranches":["8.10"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/165406","number":165406,"mergeCommit":{"message":"[DOCS]
Cross-link to ES CCS docs (#165406)\n\nCross-links to [Excluding
clusters or indices from cross-cluster
search](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-cross-cluster-search.html#exclude-problematic-clusters)
from [Use data views with cross-cluster
search](https://www.elastic.co/guide/en/kibana/current/data-views.html#management-cross-cluster-search).\r\n\r\nThis
was originally part of
https://github.com/elastic/kibana/pull/164904","sha":"ae12744b96dc6830384ddfd76814defeb4eb0289"}}]}]
BACKPORT-->

Co-authored-by: James Rodewig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.10.0 v8.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants