Commit graph

203 commits

Author SHA1 Message Date
shainaraskas
b84bd458b6
[DOCS] clarify that the repo location setting accepts only one value (#108267) 2024-05-06 09:18:17 -04:00
Yang Wang
bcf4297e89
Ensure necessary security context for s3 bulk deletions (#108280)
This PR moves the doPrivileged wrapper closer to the actual deletion
request to ensure the necesary security context is established at all
times. Also added a new repository setting to configure max size for s3
deleteObjects request.

Fixes: #108049
2024-05-06 06:02:09 -04:00
Rafi Estrada
295fba33d8
Add note about license to "Restore an Entire Cluster" docs (#87485)
One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.
2024-05-03 19:23:51 -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
2f9e753463
Add setting for max connections to S3 (#107533)
The S3 SDK permits changing the maximum number of concurrent connections
that it will open, but today there's no way to adjust this setting
within Elasticsearch. This commit adds a setting for this parameter.
2024-04-17 06:49:02 -04:00
shainaraskas
648c9cb05c
[DOCS] Add azure storage secure settings while the node is running (#107163) 2024-04-11 13:00:31 -04:00
David Turner
ccbb5badce
Fix support for infinite ?master_timeout (#107050)
Specifying `?master_timeout=-1` on an API which performs a cluster state
update means that the cluster state update task will never time out
while waiting in the pending tasks queue. However this parameter is also
re-used in a few places where a timeout of `-1` means something else,
typically to timeout immediately. This commit fixes those places so that
`?master_timeout=-1` consistently means to wait forever.
2024-04-10 18:32:38 +01:00
David Turner
ceeee1bf56
Recommend NFS over S3-like repositories (#107297)
Allegedly-S3-compatible APIs are very popular these days, but many
third-party systems offering such an API also support a shared
filesystem interface. Shared filesystem protocols such as NFS are much
better specified than the S3 API, and experience shows that they lead to
fewer compatibility headaches. This commit adds a recommendation to the
`repository-s3` docs to consider such an interface instead.
2024-04-10 11:39:38 +01:00
Moritz Mack
6b50b6ddf9
Block updates to log level for restricted loggers if less specific than INFO (#105020)
To prevent leaking sensitive information such as credentials and keys in logs, this 
commit prevents configuring some restricted loggers (currently `org.apache.http` 
and `com.amazonaws.request`) at high verbosity unless the NetworkTraceFlag 
(`es.insecure_network_trace_enabled`) is enabled.
2024-02-21 17:45:51 +01:00
David Turner
30f963960e
Improve S3 storage class docs (#104599)
Moves some of the detail about S3 storage classes to their own section
for easier linking, and adds a note about `intelligent_tiering` archive
classes.
2024-01-24 12:52:54 -05:00
Fabien Baligand
4c87a7f135
docs: fix numbering in restore-snapshot.asciidoc (#103769)
* docs: fix numbering in restore-snapshot.asciidoc

Fix numbering in "Restore an entire cluster" section.
Remove "3." for "Universal Profiling" and add "3." just before "If you use Elasticsearch security features"

* Keep ID, fix list rendering

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2024-01-03 12:01:44 +01:00
Tim Vernum
394444cd27
[Docs] Custom S3 CA must be reinstalled on upgrade (#103168)
This commit updates the docs to call out that custom certificate
authorities for S3 repositories will need to be reinstalled every time
ES is upgraded, is the node is using the bundled JDK
2023-12-11 00:01:29 -05:00
Iraklis Psaroudakis
ed2f02c963
Reference stored scripts in snapshot restore (#102966)
Closes #102903
2023-12-06 12:59:42 +02:00
Sanjay J
51eef046a0
Add support for configuring proxy scheme in S3 client settings and EC2 discovery plugin (#102495)
Closes #101873
2023-11-24 10:33:21 +02:00
David Turner
e063d1ddc8
Fix nesting of linearizable register docs (#102218)
Removes the `[discrete]` line from the docs introduced in #102050 so
that these subsections are nested at the right level.
2023-11-15 09:07:20 -05:00
David Turner
053c6638cb
Reorganise repository-s3 docs page (#102058)
These docs have various subsections under the _Client settings_ and
_Repository settings_ sections which are nothing to do with those
settings. The reasons for this are historical and no longer relevant.
This commit moves these subsections together and up a level so that they
better reflect the structure of the information.
2023-11-15 05:02:15 -05:00
David Turner
20a1503001
Add docs about linearizable registers in repositories (#102050)
We don't mention linearizable registers in the snapshot/restore docs
today, but these things are verified for correctness by the repository
analysis API and some users with incorrect repository implementations
struggle to understand the verification errors. This commit adds some
docs to describe them and their various implementations.
2023-11-14 11:23:55 -05:00
David Turner
8572d6e618
Repo analysis: allow configuration of register ops (#102051)
Adds the `?register_operation_count` parameter that allows to control
the number of register operations separately from the number of regular
blob operations.
2023-11-13 02:20:23 -05:00
David Turner
f1c7436140
Note that repo analysis varies by version (#101762)
Clarifies that repo analysis may get stricter over time.
2023-11-03 11:15:19 +00:00
David Turner
a170d73b06
Suggest a strategy for using repo analysis (#101507)
Adds some docs to suggest running a sequence of increasingly large
analyses, and to set a very generous timeout.
2023-10-30 09:30:33 +00:00
David Turner
cf97e967a9
More S3-compatible repo deflection (#100754)
Call out explicitly that users need to reproduce issues with the real S3
before reporting them to ES.
2023-10-12 05:41:50 -04:00
Tanguy Leroux
583a787618
[Docs] Link to AWS SDK documentation for requests logging (#100491)
Co-authored-by: David Turner david.turner@elastic.co
2023-10-12 09:48:45 +02:00
David Turner
a1caba1521
Add repository backup warning (#99788)
Adds a note about the consequences of trying to back up and restore a
snapshot repository without taking steps to make sure the copy is
consistent.
2023-09-25 17:17:03 +01:00
David Turner
3691312aca
Slightly adjust docs about S3 incompatibilities (#99624)
It's often useful to quote these docs to users encountering problems
with their not-quite-S3-compatible storage system. In practice we don't
need to quote the bits in the middle but we do need the last sentence
about working with the supplier to address incompatibilities. This
commit reorders things so that the most commonly quoted sentences form a
standalone paragraph.
2023-09-18 08:26:03 -04:00
Stef Nestor
61228b888e
[DOC+] ILM Searchable Snapshot migrations require repository "name" to be the same (#99308)
👋 howdy, team! Expanding reference to [internal](https://github.com/elastic/cloud/pull/118105) update, we've just confirmed ILM requires the repository name to be the same among migrating clusters. This is a hard block for Searchable Snapshots which requires un-Searchable-Snapshotting or redoing migration to resolve.
2023-09-08 10:28:30 +02:00
Stef Nestor
9573f6f1f4
[DOC+] snapshot-restore single index example (#99065)
* [DOC+] snapshot-restore single index example

👋🏼 howdy, team! I'd like to append an example to snapshot-restore a single index. Support usually points users to [this page](https://www.elastic.co/guide/en/elasticsearch/reference/master/restore-snapshot-api.html) but then users attempt the `rename_pattern` example (which makes sense!). I'd like to point them to a more literal "close index > restore on that index" example in the future.

* Fix test failure and reword

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-08-31 16:23:50 +02:00
Peter Dyson
ef7b7ccded
[DOCS] mention closed indices are included by default for snapshot (#98766) 2023-08-23 10:41:35 +02:00
David Kilfoyle
174ea9645c
[Docs] Fix links to Cloud snapshot and restore docs (#98228) 2023-08-04 18:01:46 -04:00
David Kilfoyle
4d3069a986
Fix broken links to Cloud snapshot restore info (#98213) 2023-08-04 16:38:27 -04:00
David Turner
c7c1dc1914
Add docs on troubleshooting NFS repos (#97601)
Spell out a bit more clearly that ES works through the OS's filesystem
abstraction, giving advice about how to reproduce problems outside of
ES.
2023-07-19 13:55:09 +01:00
debadair
777598d602
[DOCS] Remove redirect pages (#88738)
* [DOCS] Remove manual redirects

* [DOCS] Removed refs to modules-discovery-hosts-providers

* [DOCS] Fixed broken internal refs

* Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc.

* Update docs/reference/search/point-in-time-api.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/setup/restart-cluster.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/sql/endpoints/translate.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/snapshot-restore/restore-snapshot.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update repository-azure.asciidoc

* Update node-tool.asciidoc

* Update repository-azure.asciidoc

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-05-24 12:32:46 +01:00
Daniel Mitterdorfer
3aed3499ff
Bootstrap profiling indices at startup (#95666)
With this commit we bootstrap all indices and related structures that
are required for Elastic Universal Profiling.
2023-05-16 16:56:51 +02:00
Francisco Fernández Castaño
da9bb382f5
Add support for custom endpoints in the Azure repository (#94576)
Closes #94537
2023-03-22 11:40:19 +01:00
Stef Nestor
69d3039726
Doc about elasticsearch#78276 (#93873)
👋🏼 Regardless of if we decide to validation enforce #78276, may we please drop a doc note that users should avoid duplicating repositories (particularly bucket / base paths).
2023-02-22 21:08:15 +01:00
Francisco Fernández Castaño
da387b430c
Link to the time-units doc in S3 repository docs instead of explaining it in words (#93351) 2023-01-31 11:59:20 +01:00
Francisco Fernández Castaño
ed9246f8d4
Amend read_timeout S3 repository setting description (#93136) 2023-01-23 15:34:46 +01:00
Iraklis Psaroudakis
6ff081beef
Clarify searchable snapshot repository reliability (#93023)
To make it clear that repository snapshots should be available and reliable for any mounted searchable snapshots.

Co-authored-by: David Turner <david.turner@elastic.co>
2023-01-19 14:31:01 +02:00
David Turner
82ed1fbcc9
Clarify use of S3 lifecycle policies (#92427)
Clarifies that it doesn't work to transition to Glacier tiers, nor does
it work to use object expiry, and that the consequences can be severe.
2022-12-19 09:04:29 +00:00
amyjtechwriter
c0e624b3b1
Removing 'or closed' from ignore_unavalible in line with new default behviour. (#92233) 2022-12-12 09:18:27 +00:00
Andrei Dan
261f184c22
[DOCS] disable the ILM history store on full cluster restore (#88515) 2022-11-23 16:54:54 +00:00
Iraklis Psaroudakis
7bfc672eb4
Tie snapshot speed to node bandwidth settings (#91021)
If the recovery node bandwidth settings exist,
then the default value for max snapshot speed will
be infinite, and the speed will be rate limited
by the recovery rate limit as well.

Fixes #57023
2022-11-15 16:13:09 +02:00
Anthony McGlone
0249d1650f
[DOCS] Update the feature state example in the snapshot and restore docs (#90328) 2022-11-01 10:17:29 +09:00
debadair
ef7aaec815
[DOCS] Fixed footnote. Closes #89403 (#90541) 2022-09-29 16:48:02 -07:00
Joe Gallo
f262f36564
Add master_timeout to the snapshot delete docs (#90032) 2022-09-14 12:23:46 -04:00
Pooya Salehi
72b2bd90e2
Update running snapshot state value to STARTED (#89863)
The get snapshot status API will currently return a value of `STARTED` for the state of a snapshot that is currently running. The documentation says that the `state` value for a running snapshot is `IN_PROGRESS`. This documentation change will align the docs with the actual result of the get snapshot status API.

Co-authored-by: Austin Smith <76973609+asmith-elastic@users.noreply.github.com>
2022-09-08 10:12:44 +02:00
Pooya Salehi
59c1c81262
Fix typo in get-snapshot-status-api doc (#89865) 2022-09-07 15:21:41 +02:00
Seth Michael Larson
fffabae10a
Add pagination parameters to API spec and docs for 'snapshot.get' API 2022-07-20 06:35:52 -05:00
Yannick Welsch
d666ddca1d
Clarify snapshot docs on archive indices (#88417)
Should remove confusion what to do with old archive indices.
2022-07-11 12:03:18 +02:00
David Turner
58703c3a79
Clarify what to do if repo analysis fails (#88267)
The docs for the repo analysis API don't really say how to react on a
failure. This commit adds a note about this case.
2022-07-05 06:45:23 -04:00
Yannick Welsch
46b386be16
Docs for snapshots as simple archives (#86261)
Adds documentation for the new snapshots as archive feature.

Relates #81210
2022-05-30 13:23:53 +02:00