Skip to content

Commit

Permalink
[8.10] update data view docs for excluding cluster (elastic#164904) (e…
Browse files Browse the repository at this point in the history
…lastic#165345)

# Backport

This will backport the following commits from `main` to `8.10`:
- [update data view docs for excluding cluster
(elastic#164904)](elastic#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
(elastic#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
(elastic#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
(elastic#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]>
  • Loading branch information
kibanamachine and nreese authored Aug 31, 2023
1 parent fe93fa7 commit 638b971
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/concepts/data-views.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,11 @@ all clusters having a name starting with `cluster_`:
`cluster_*:logstash-*,cluster_*:-logstash-old*`
```

To exclude a cluster having a name starting with `cluster_`:
Excluding a cluster avoids sending any network calls to that cluster.
To exclude a cluster with the name `cluster_one`:

```ts
`cluster_*:logstash-*,cluster_one:-*`
`cluster_*:logstash-*,-cluster_one:*`
```

Once you configure a {data-source} to use the {ccs} syntax, all searches and
Expand Down

0 comments on commit 638b971

Please sign in to comment.