elasticsearch/docs/reference/modules/cluster
Michael Peterson a451511e3a
Change skip_unavailable default value to true (#105792)
In order to improve the experience of cross-cluster search, we are changing
the default value of the remote cluster `skip_unavailable` setting from `false` to `true`.

This setting causes any cross-cluster _search (or _async_search) to entirely fail when
any remote cluster with `skip_unavailable=false` is either unavailable (connection to it fails)
or if the search on it fails on all shards.

Setting `skip_unavailable=true` allows partial results from other clusters to be
returned. In that case, the search response cluster metadata will show a `skipped`
status, so the user can see that no data came in from that cluster. Kibana also
now leverages this metadata in the cross-cluster search responses to allow users
to see how many clusters returned data and drill down into which clusters did not
(including failure messages).

Currently, the user/admin has to specifically set the value to `true` in the configs, like so:

```
cluster:
    remote:
        remote1:
            seeds: 10.10.10.10:9300
            skip_unavailable: true
```

even though that is probably what search admins want in the vast majority of cases.

Setting `skip_unavailable=false` should be a conscious (and probably rare) choice
by an Elasticsearch admin that a particular cluster's results are so essential to a
search (or visualization in dashboard or Discover panel) that no results at all should
be shown if it cannot return any results.
2024-04-29 15:53:47 -04:00
..
images [DOCS] Update remote cluster docs (#77043) 2021-09-22 16:02:33 -04:00
allocation_awareness.asciidoc Allocation awareness allocates some replicas (#104800) 2024-01-29 08:13:06 +00:00
allocation_filtering.asciidoc Deprecation of transient cluster settings (#78794) 2021-10-15 13:00:52 -04:00
disk_allocator.asciidoc Fix docs about uneven disk usage (#104541) 2024-01-18 16:02:37 +00:00
misc.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
remote-clusters-api-key.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
remote-clusters-cert.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
remote-clusters-connect.asciidoc Change skip_unavailable default value to true (#105792) 2024-04-29 15:53:47 -04:00
remote-clusters-migration.asciidoc Docs for hot-reloadable remote cluster credentials (#105483) 2024-02-15 06:02:13 -05:00
remote-clusters-remote-info.asciidoc [DOCS] Remote cluster troubleshooting guide (#99128) 2023-09-05 15:10:45 +02:00
remote-clusters-settings.asciidoc Change skip_unavailable default value to true (#105792) 2024-04-29 15:53:47 -04:00
remote-clusters-troubleshooting.asciidoc Add remote cluster network troubleshooting docs (#107072) 2024-04-04 02:37:13 -04:00
shards_allocation.asciidoc [Docs] Minor tweak for balance settings docs (#105170) 2024-02-06 22:31:35 +11:00