Commit graph

1017 commits

Author SHA1 Message Date
Nik Everett
f8dbda3f98
ESQL: Document esql_worker threadpool (#113203) (#113459)
Documents the thread pool we use to run ESQL operations. It's the same
size and queue depth as the `search` thread pool.

Closes #113130
2024-09-24 23:28:53 +10:00
David Turner
2ba00c2810
Mention full-cluster restart in initial_master_node docs (#112986) (#113166)
Apparently some users consider "node is restarting" not to apply to a
full-cluster restart. This commit further clarifies that you must not
set `cluster.initial_master_nodes` in a full cluster restart.
2024-09-19 20:06:24 +10:00
Stef Nestor
d039c280af
(Docs+) Flush out Resource+Task troubleshooting (#111773) (#112818)
* (Docs+) Flush out Resource+Task troubleshooting

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
2024-09-13 00:09:58 +10:00
David Turner
1977a715df
Add links to network disconnect troubleshooting (#112330)
Makes the docs added in #112271 more discoverable.
2024-09-10 00:59:39 +10:00
David Turner
9387ce3357
Deduplicate unstable-cluster troubleshooting docs (#112333)
We duplicated these docs in order to avoid breaking older links, but
this makes it confusing and hard to link to the right copy of the
information. This commit removes the duplication by replacing the docs
at the old locations with stubs that link to the new locations.
2024-08-29 13:16:37 +01:00
David Turner
59a42ed41b
Include network disconnect info in troubleshooting docs (#112323)
A misplaced `//end::` tag meant that the docs added in #112271 are only
included in the page on fault detection and not the equivalent
troubleshooting docs. This commit fixes the problem.
2024-08-29 15:03:13 +10:00
David Turner
42d650b9bb
Add docs for troubleshooting network disconnects (#112271)
Basically the same as for nodes that leave the cluster with reason
`disconnected`, except that these disconnects don't involve the master
so don't cause any nodes to leave the cluster.
2024-08-28 18:59:11 +10:00
David Turner
615e084617
Add more cross-links about sniff/proxy modes (#112079)
The info about remote cluster connection modes is a little disjointed.
This commit adds some cross-links between the sections to help users
find more relevant information.
2024-08-22 14:13:56 +01:00
David Turner
f0dbda7529
Expand docs on remote cluster proxying (#112025)
It's not obvious from the docs that transport connections (including
connections to remote clusters) use a custom binary protocol and require
a _layer 4_ proxy. This commit clarifies this point.
2024-08-21 22:26:57 +01:00
David Turner
e5fd63bbb8
More detail around packet captures (#111835)
Clarify that it's best to analyse the captures alongside the node logs,
and spell out in a bit more detail how to use packet captures and logs
to pin down the cause of a `disconnected` node.
2024-08-13 21:55:38 +01:00
Stef Nestor
11bea77d3e
(Doc+) cluster.routing.allocation.enable effects going forward (#111557)
* (Doc+) cluster.routing.allocation.enable effects going forward

Noting setting e.g.  `cluster.routing.allocation.enable: primaries` ([doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-cluster.html#cluster-shard-allocation-settings)) does not de-allocate existing replicas. Instead this setting affects allocations going forward.

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-08-02 14:43:22 -06:00
shainaraskas
50bccf5609
Round up shard allocation / recovery / relocation concepts (#109943) 2024-07-25 14:44:57 -04:00
Stef Nestor
05060f8413
(Doc+) Link Gateway Settings to Full Restart (#110902)
* (Doc+) Link Gateway Settings to Full Restart

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-07-25 09:10:19 -06:00
David Turner
51d658e3cd
Always allow rebalancing by default (#111015)
Today `cluster.routing.allocation.allow_rebalance` defaults to
`indices_all_active` which blocks all rebalancing moves while the
cluster is in `yellow` or `red` health. This was appropriate for the
legacy allocator which might do too many rebalancing moves otherwise.
The desired-balance allocator has better support for rebalancing a
cluster that is not in `green` health, and expects to be able to
rebalance some shards away from over-full nodes to avoid allocating
shards to undesirable locations in the first place. This commit changes
the default `allow_rebalance` setting to `always`.
2024-07-18 12:35:50 +01:00
Stef Nestor
3f3ec0c5f9
(Doc+) Include cluster.blocks.* default settings (#110560)
👋 howdy, team! Mini doc update to include default settings for `cluster.blocks.*` settings.
2024-07-11 08:04:28 -06:00
Alexander Spies
e28654f8d2
Aggs: Scripted metric allow list docs (#109635)
* Document new settings
* Mention agg allow list in scripting security doc
2024-07-11 14:27:51 +02:00
David Turner
58bb05df94
Clarify logs/errors re. publish addresses (#110570)
These warning logs and error messages assume some level of understanding
of Elasticsearch's networking config and are not particularly
actionable. This commit adds links to the relevant section of the
manual, rewords them a little to match the terminology used in the
manual, and also documents that each node must have its own publish
address, distinct from those of all other nodes.
2024-07-08 18:20:28 +10:00
David Turner
0131e80624 Revert "(+Doc) link split-brain wiki from quorom decision making (#108915)"
This reverts commit 4d3ca2d029.
2024-06-16 08:54:44 +01:00
shainaraskas
900eb82c99
[DOCS] Address local vs. remote storage + shard limits feedback (#109360) 2024-06-12 13:50:23 -04:00
David Turner
366c0b16bf
Add docs on HTTP client config (#109543)
Some notes and recommendations on timeouts and TCP keepalives.

Relates INC-1049
2024-06-12 14:54:54 +01:00
David Turner
683245e41e
Detect long-running tasks on network threads (#109204)
This commit introduces a watchdog timer to monitor for long-running
tasks on network threads. If a network thread is active and has not made
progress for two consecutive ticks of the timer then the watchdog logs a
warning and a thread dump.
2024-06-10 17:47:40 +10:00
Liam Thompson
2268e383e8
[DOCS][ESQL][8.14] Add API key based security model info for ESQL CCS (#109155)
Co-authored-by: Jake Landis <jake.landis@elastic.co>
2024-06-03 18:44:33 +02:00
Stef Nestor
4d3ca2d029
(+Doc) link split-brain wiki from quorom decision making (#108915)
Mini change to link the [wiki page about "split-brain"](https://en.wikipedia.org/wiki/Split-brain_(computing)) as an industry-not-Elastic term under [Quorum-based decision making](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-quorums.html)
2024-05-22 13:22:03 -06:00
Stef Nestor
12aab08330
(+Doc) Link split-brain wiki (#108914)
Mini change to link the wiki page about "split-brain" as an industry-not-Elastic term under [Voting configurations](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-voting.html).
2024-05-22 13:21:54 -06:00
David Turner
6ecb295ff1
Document transport.compress trade-offs more clearly (#108458)
Spells out explicitly that setting `transport.compress: true` may cost
extra CPU.
2024-05-09 14:04:45 -04:00
shainaraskas
9d9f23ca96
[DOCS] Add API example + diagrams to shard allocation awareness docs (#108390) 2024-05-08 12:52:50 -04:00
Liam Thompson
9a62dba53c
[DOCS] Remove remaining beta flags for RCS (#108201) 2024-05-03 09:12:37 +02:00
florent-leborgne
0c500e5264
Remove Beta label for RCS2.0 from 8.14 (#108030) 2024-05-02 15:43:21 +02:00
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
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
David Turner
9a2f8a80eb
Add remote cluster network troubleshooting docs (#107072)
Spells out in a little more detail our expectations for remote cluster
connections, including an example log message when the network is
unreliable and some suggestions for how to troubleshoot further.
2024-04-04 02:37:13 -04:00
shainaraskas
206a0b7a4c
[DOCS] Remove obsolete accounting circuit breakers (#107015) 2024-04-03 09:54:53 -04:00
Jake Landis
bb9566a57e
Update discovery.asciidoc (#106541) (#106695)
Fix typo

(cherry picked from commit 96a46b9c5b)

Co-authored-by: Boen <13752080613@163.com>
2024-03-22 15:43:48 -04:00
shainaraskas
82d7e4ec93
[DOCS] Clarify behavior of the generic data node role (#106375) 2024-03-22 14:06:19 -04:00
florent-leborgne
d37d93ac36
[Docs] [Remote Clusters] Note about certificates in ESS for Remote Cluster Security (#105771)
* note about ess certificates

* Update docs/reference/modules/cluster/remote-clusters-api-key.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
2024-02-23 15:13:51 +01:00
David Turner
369096365c
Expand docs about max-shards-per-node (#105607)
Adds a little more detail on what sorts of problems may occur if you
exceed the default limits.
2024-02-20 08:43:18 +00:00
Nikolaj Volgushev
e241a91a4e
Docs for hot-reloadable remote cluster credentials (#105483)
Docs PR to accompany
https://github.com/elastic/elasticsearch/pull/103215.

Resolves: ES-7625
2024-02-15 06:02:13 -05:00
florent-leborgne
4ee086e406
[DOCS] [Remote clusters] Reference specific instructions for cloud trust 2024-02-15 09:39:02 +01:00
David Turner
cc2e56da38
Security auto-config overrides default http.host (#105377)
If you start up a freshly-unpacked Elasticsearch tarball, security
auto-configuration will set `http.host: 0.0.0.0` in `elasticsearch.yml`,
overriding the documented default behaviour which is to fall back to
`network.host` which itself defaults to `localhost`. This commit adds a
note to the docs about this.
2024-02-12 09:54:38 +00:00
Fabio Busatto
b1adb78f6c
[DOCS] Update remote cluster setup instructions (#105256) 2024-02-07 21:11:57 +01:00
Yang Wang
6cf92584ba
[Docs] Minor tweak for balance settings docs (#105170)
Relates: #105119
2024-02-06 22:31:35 +11:00
David Turner
6a40c04cc1
More guidance in balance settings docs (#105119)
Today the docs on balancing settings describe what the settings all do
but offer little guidance about how to configure them. This commit adds
some extra detail to avoid some common misunderstandings and reorders
the docs a little so that more commonly-adjusted settings are mentioned
earlier.
2024-02-05 05:04:24 -05:00
David Turner
88e497069a
Allocation awareness allocates some replicas (#104800)
The docs for forced awareness indicate that no replicas will be assigned
until all zones are available, which is definitely undesirable and also
not the actual behaviour. This commit fixes the wording to match what
really happens.

Closes #104777
2024-01-29 08:13:06 +00:00
David Turner
1c11249c05
Fix docs about uneven disk usage (#104541)
There's a note in the docs saying we only consider shard count and not
disk usage which is no longer true. This commit fixes the note to
reflect today's implementation.
2024-01-18 16:02:37 +00:00
Iraklis Psaroudakis
37b7dd987b
Add warning on desired balancer heuristics (#102633)
To avoid changing them.
2023-11-27 14:45:57 +02:00
David Turner
61191b880c
Link to troubleshooting docs from other disco pages (#102509)
I have several times struggled to find the docs about restoring from a
snapshot if a quorum cannot be found. That info is on the discovery
troubleshooting page, but it seems I expect it to be on somewhere like
the quorums or voting docs pages instead. This commit adds links from
those pages to the troubleshooting page.
2023-11-23 09:45:21 +00:00
David Turner
9b51d9972d
More specific cluster.initial_master_nodes instructions (#101493)
In the note on forming a single cluster we describe what to do if
inadvertently forming extra clusters, but we can be more explicit about
what to do with `cluster.initial_master_nodes` in these instructions.
This commit adds the missing details.
2023-10-30 08:25:40 +00:00
David Turner
5dff56a00e
Mention network handler logging in docs (#100118)
Mentions the `InboundHandler` (and `OutboundHandler`) as potential
sources of useful log messages when tracking down a network threading
bug.
2023-10-02 08:52:16 +01:00
James Rodewig
4da2d31390
[main] [DOCS] Fix typo in query_cache.asciidoc (#99713) (#99810)
Co-authored-by: Joseph AFARI <71259267+joeafari@users.noreply.github.com>
2023-09-22 08:58:05 -04:00
James Rodewig
255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00