Commit graph

550 commits

Author SHA1 Message Date
Tim Vernum
ac8c5911fc
[7.17] [Docs] Custom S3 CA must be reinstalled on upgrade (#103168) (#103248)
* [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

* Fix cross-book reference
2023-12-11 20:23:14 -05:00
David Turner
731a961d05 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:11:18 +00:00
Ryan Ernst
c46d0ed1f3
Reference the entire example plugins dir in docs (#87406) (#87423)
The plugin author docs refer to a few example plugins, yet these are
just a few of the existing examples. While an overhaul is needed of
these docs, this commit slightly improves the situation by making it
clear that these are not the only examples, and linking to the entire
examples directory. Additionally, the wording is tweaked to remove the
superfluous use of "java plugin" because there is no longer a non java
plugin as there was in 1.x.
2022-06-06 12:19:01 -04:00
David Turner
cf52fc03bf Note that S3 compat includes performance (#84798)
Today the note in the docs about S3-compatible repositories notes that
the repo must behave correctly, but it's also important that it has the
same performance profile. This commit extends the docs to include this
info.
2022-03-09 12:36:02 +00:00
Nik Everett
17f5cc87bd
Backport doc fixes to 7.17 (#84722)
* Update painless-reindex-context.asciidoc (#84444) (#84712)

ctx['op'] should be set to 'noop', not 'none' when specifying no
operation.

Elasticsearch error when using 'none':

```json
{
  "error" : {
    "root_cause" : [
      {
        "type" : "illegal_argument_exception",
        "reason" : "Operation type [none] not allowed, only [noop, index, delete] are allowed"
      }
    ],
    "type" : "illegal_argument_exception",
    "reason" : "Operation type [none] not allowed, only [noop, index, delete] are allowed"
  },
  "status" : 400
}
```

Co-authored-by: jalvar08 <jeovanny.alvarez@gmail.com>

* [DOCS] Update install instructions for Debian/Ubuntu (#84645) (#84714)

The use of `apt-key` is deprecated and will no longer be available after
Debian 11 and Ubuntu 22.04. This updates the installation instructions
for Debian-based distributions.

Closes #84644

Co-authored-by: er0k <er0k@users.noreply.github.com>

* Fix some typos in plugins & reference docs (#84667) (#84717)

This pull request removes a few instances of duplicate words or
punctuation and erroneous spelling from the docs.

Co-authored-by: Abele Mălan <6689720+AbeleMM@users.noreply.github.com>

Co-authored-by: jalvar08 <jeovanny.alvarez@gmail.com>
Co-authored-by: er0k <er0k@users.noreply.github.com>
Co-authored-by: Abele Mălan <6689720+AbeleMM@users.noreply.github.com>
2022-03-07 14:04:12 -05:00
James Rodewig
99de635f0c
[DOCS] Add note for HTTP proxy connections to GCS repos (#84004)
We've had a few users ask about support for HTTP proxy connections to GCS snapshot repositories in 7.x and 6.x.
However, client settings for those connections are only supported in 8.0+.

This adds a note to the 7.17 and 6.8 docs to nudge users to upgrade.

Relates to https://github.com/elastic/elasticsearch/pull/82737

Closes https://github.com/elastic/elasticsearch/issues/83959
2022-02-16 08:08:35 -05:00
David Turner
0da062615c
Add note on truststore for S3-compatible repos (#82669) (#83143)
Today we note that the `repository-s3` plugin uses the JVM-wide
truststore in the docs for the `protocol` client setting, but it turns
out that this is easy to overlook since most installations will not need
to change the `protocol`. This commit adds the same detail to the
section on S3-compatible repositories where it is more likely to be
found.
2022-01-26 06:28:43 -05:00
Rory Hunter
3be1cdfcf6 Document the declarative plugins configuration file (#80760)
Follow-up to #77544.
2021-11-17 21:11:42 +00:00
James Rodewig
c13cd213bc
[DOCS] Overhaul snapshot and restore docs (#79081) (#80733)
Makes several changes to consolidate snapshot and backup-related docs.

Highlights:

* Adds info about supported ESS snapshot repository types
* Adds docs for Kibana's Snapshot and Restore feature
* Combines tutorial pages related to taking and managing snapshots
* Consolidates explanations of the snapshot process
* Incorporates SLM into the snapshot tutorial
* Removes duplicate "back up a cluster" pages
2021-11-15 13:23:48 -05:00
James Rodewig
288ba5760e
[DOCS] Fix a typo in annotated text examples (#78683) (#78686)
Fixes `start` to `strat` for the second example.
`strat` looks weird but it is a short name of the
legendary `stratocaster` guitar.

Co-authored-by: Dimitris Athanasiou <dimitris@elastic.co>
2021-10-05 07:33:35 -04:00
David Turner
0705943d41
Note S3 plugin uses JVM-wide truststore (#77676) (#77681)
Today it's not clear how to tell Elasticsearch to trust an S3-compatible
repository that presents a certificate issued by a private or
nonstandard CA. This commit expands the docs to say how.

Supersedes #65034
Relates #77081

Co-authored-by: Joost De Cock <joost@decock.org>

Co-authored-by: Joost De Cock <joost@decock.org>

Co-authored-by: Joost De Cock <joost@decock.org>
2021-09-14 04:54:02 -04:00
David Turner
46bbb97ffb
Add note on cleanup of S3 multipart uploads (#77619) (#77646)
* Add note on cleanup of S3 multipart uploads

Adds docs describing Elasticsearch's behaviour around leaking multipart uploads
and what to do about it.

Closes #44955

* instance -> example
2021-09-13 13:00:21 -04:00
Ryan Ernst
174a92316a
Remove quota-aware-fs plugin (#76352) (#76393)
The quota aware filesystem was added as a means of allowing
Elasticsearch to track the used space of the underlying filesystem in
virtualized environments. However, the need for it was due to a bug in a
much earlier version of Elasticsearch that always found the underlying
mount and checked it directely for usage. That bug has already been
fixed, so the there is no longer a need for this plugin. This commit
removes the plugin. We should consider separately whether there is still
a need for bootstrap plugins.

closes #70309
2021-08-11 20:25:29 -04:00
Nhat Nguyen
373b30d25b
Deprecate SimpleFS and replace it with NIOFS (#75156)
SimpleFS is deprecated and will be removed in Lucene 9. This commit 
deprecates SimpleFS in 7.x and uses NIOFS for SimpleFS in Elasticsearch
7.15 or later as it offers superior or equivalent performance to
SimpleFS.
2021-07-09 14:34:57 -04:00
Rene Groeschke
e7993be320
Fix docs paths 2021-06-07 17:08:00 +02:00
James Rodewig
54409690f2
[DOCS] Update service account creation docs for GCS repository plugin (#73561) (#73665)
There are some changes in GCP. The service accounts are now their own button and not a child under the IAM/permissions anymore.

Co-authored-by: Philipp Kahr <philipp.kahr@elastic.co>
2021-06-02 09:01:18 -04:00
James Rodewig
088ef40db0
[DOCS] Clarify the type of Azure storage for snapshots (#72826) (#72977)
Azure Storage accounts offer several storage services including Blob Storage, Table Storage, File Storage, and Storage Queues.  The intro page for this plugin should specify which type is used for elasticsearch snapshots.  This info is necessary for pricing at very least.

Co-authored-by: joshschmitter <45405518+joshschmitter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-05-12 10:20:30 -04:00
James Rodewig
91e23bfb5a
[DOCS] Improve discovery-gce docs (#72338) (#72409)
* Improve indentation of code for discovery-gce

Improve the indentation by using a indentation level of two spaces to
improve readability and enable better copy&paste experience.

* Improve docs for GCP web-console and permissions

Match the description for the GCP web-console to the current state
and change the API-permission.
There is (no longer) a permission `compute.full_control`.

* Apply suggestions from code review

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Paul Puschmann <paul.puschmann@gmail.com>
2021-04-28 12:42:50 -04:00
James Rodewig
f00025c712
[DOCS] Reword buffer_size default (#72038) (#72041)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-04-21 13:41:15 -04:00
Yannick Welsch
9d30ca419f Use default application credentials for GCS repositories (#71239)
Adds support for "Default Application Credentials" for GCS repositories, making it easier to set up a repository on GCP,
as all relevant information to connect to the repository is retrieved from the environment, not necessitating complicated
keystore setups.
2021-04-06 15:21:31 +02:00
Christoph Büscher
6a96e9e04c Update mapper-size.asciidoc
Small change in wording.
2021-04-01 11:53:40 +02:00
Christoph Büscher
8d12de9ee5 Add _size and _doc_count to fields output (#70575)
Currently metadata fields like `_size` or `_doc_count` cannot be retrieved using
the fields API. With this change, we allow this if the field is explicitely
queried for using its name, but won't include metadata fields when e.g.
requesting all fields via "*".
With this change, not all metadata fields will be retrievable by using its name,
but support for "_size" and "_doc_count" (which is fetched from source) is
added. Support for other metadata field types will need to be decided case by
case and an appropriate ValueFetcher needs to be supplied.

Relates to #63569
2021-03-31 19:44:05 +02:00
James Rodewig
c757f9e4e7
[DOCS] Fix double spaces (#71082) (#71120) 2021-03-31 11:43:34 -04:00
James Rodewig
52b861a64c
[DOCS] Replace hard-coded admons with cloud-only attribute (#70864) (#70868) 2021-03-25 10:03:13 -04:00
Mark Vieira
9559baf9d2 Indicate that the quota-aware-fs plugin is for cloud-only use in docs (#70832) 2021-03-24 14:24:28 -07:00
James Rodewig
b95afd9ddf
[DOCS] Refactor ingest pipeline docs (#70253) (#70409) 2021-03-15 14:12:11 -04:00
Dan Hermann
c58b8e972a
[DOCS] resource_name property for attachment ingest processor (#65974) (#69828) 2021-03-02 11:38:41 -06:00
Rory Hunter
119ba5ac65 Support removing multiple plugins at once in the CLI (#69063)
Closes #66476. Add support for removing multiple plugins at the
same time to `elasticsearch-plugin`. Also change references from
"plugin name" to "plugin id", to align better with the installer
class.
2021-02-24 14:15:06 +00:00
David Turner
fe94800521 Remove mention of repositories.s3.base_path in doc (#69516)
We removed the global `repositories.s3.base_path` setting in 6.0 but it
is still mentioned in the docs for the S3 repository plugin. This commit
removes it from the docs.

Relates #24445
2021-02-24 09:14:32 +00:00
David Turner
f19159a587 Link to repo analyser from docs on S3-compat repos (#69513)
Adds a link to the repository analyser API from the docs regarding
"S3-compatible" repository types.
2021-02-24 09:05:34 +00:00
James Rodewig
157878d242
[DOCS] Audit community plugins and integrations (#69378) (#69388) 2021-02-22 16:49:52 -05:00
James Rodewig
e99254e892
[DOCS] Remove default modules from plugin docs (#69304) (#69358) 2021-02-22 10:34:20 -05:00
James Rodewig
b55249507e
[DOCS] Fix typos for duplicate words (#69125) (#69132) 2021-02-17 11:16:58 -05:00
James Rodewig
74780eec6e
[DOCS] Fix S3 bucket names in S3 repo plugin docs (#66521) (#66526)
Co-authored-by: Inbar Shimshon <inbar.shimshon@elastic.co>
2020-12-17 10:27:25 -05:00
Wylie Conlon
4d9f5b1867 Clarify field data cache behavior in docs (#64375)
* Clarify that field data cache includes global ordinals
* Describe that the cache should be cleared once the limit is reached
* Clarify that the `_id` field does not supported aggregations anymore
* Fold the `fielddata` mapping parameter page into the `text field docs
* Improve cross-linking
2020-11-20 13:56:02 -08:00
James Rodewig
86d1814c54
[DOCS] Clarify ingest attachment example (#65143) (#65159) 2020-11-17 15:13:39 -05:00
Armin Braun
dea839fc55
Default S3 Chunk Size to 5TB (#64980) (#64984)
Just like we did for Azure and GCS we should just go with the
maximum possible chunk size in S3 as well.
2020-11-12 12:37:17 +01:00
James Rodewig
b7091094e2
[DOCS] Add checksum links for plugin downloads (#64949) (#64958) 2020-11-11 13:30:20 -05:00
Rory Hunter
f0d016f246
Introduce quota-aware filesystem ES plugin (#64314)
Backport of #63620.

Closes #61145.

This PR adds a quota-aware filesystem plugin to Elasticsearch. This plugin
offers a way to provide user quota limits (specifically, total quota size
and available quota size) to Elasticsearch, in an implementation-agnostic
manner.

As part of this work, this PR also introduces the concept of "bootstrap
only" plugins, which are excluded from the normal plugin loading process.

Finally, note that this implementation supports `createLink(...)`, since ES
/ Lucene use hard links where possible.
2020-11-09 14:52:14 +00:00
James Rodewig
2eae9b6dfa
[DOC] Review integration page (#63799) (#63815)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: Aaron Bull Schaefer <abs@elastic.co>
Co-authored-by: Luca Belluccini <luca.belluccini@elastic.co>
2020-10-16 11:39:57 -04:00
David Turner
81df471922 Third-party S3-compatible repos aren't unsupported (#63238)
Today in the `repository-s3` docs we say

> Other S3-compatible storage systems may also work with Elasticsearch,
> but these are not tested or supported.

Saying that they are explicitly not supported is a very strong
statement, implying that it is positively irresponsible to use anything
except S3 or Minio, even after extensive testing. S3-compatibility in
third-party systems has matured in recent years and users today report
success with a good number of them. In contrast, we effectively claim
support for any old NFS implementation when used with the
shared-filesystem repository.

This commit weakens this statement, removing the absolute claim of
unsupportedness and instead spelling out that the user is responsible
for ironing out any incompatibilities with the storage supplier.
2020-10-12 09:38:43 +01:00
Adam Locke
83fcaf4fe7
[DOCS] [7.x] Add PGSync as community-supported integration (#63250)
* Add PGSync as a new community supported tool (#62788)

* Remvoing errant space in Kafka link.

Co-authored-by: Tolu Aina <7848930+toluaina@users.noreply.github.com>
2020-10-05 12:02:23 -04:00
James Rodewig
26f98f3a74
[DOCS] Fix 404s (#62918) (#63013)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Guido Lena Cota <guido.lenacota@kreuzwerker.de>
2020-09-29 10:37:26 -04:00
James Rodewig
a1100bb770
[DOCS] Add CBOR example to ingest attachment docs (#60919) (#60964) 2020-08-11 10:28:22 -04:00
James Rodewig
a761985fab
[DOCS] Move script and stored fields content to search fields page (#60826) (#60835)
Changes:

* Moves `Retrieve selected fields` to its own page and adds a title abbreviation.
* Adds existing script and stored fields content to `Retrieve selected fields`
* Adds a xref for `Retrieve selected fields` to `Search your data`
* Adds related redirects and updates existing xrefs
2020-08-06 13:06:06 -04:00
James Rodewig
029869eb35
[DOCS] Fix metadata field refs (#60764) (#60769) 2020-08-05 14:04:55 -04:00
Francisco Fernández Castaño
f64e572e69
[DOCS] Include reference to AWS VPC endpoints in s3 repository docs. (#60753)
Add VPC endpoint as the recommended way of connecting to s3 in private subnets

Backport of #60654

Co-authored-by: Bill Mitchell <vocatan@users.noreply.github.com>
Co-authored-by: David Turner <david.turner@elastic.co>
2020-08-05 18:39:47 +02:00
James Rodewig
bffe82449a
[DOCS] Update Amazon Linux AMI link in EC2 docs (#60589) (#60593) 2020-08-03 09:32:31 -04:00
James Rodewig
5a2c6f0d4f
[DOCS] http -> https, remove outdated plugin docs (#60380) (#60545)
Plugin discovery documentation contained information about installing
Elasticsearch 2.0 and installing an oracle JDK, both of which is no
longer valid.

While noticing that the instructions used cleartext HTTP to install
packages, this commit replaces HTTPs links instead of HTTP where possible.

In addition a few community links have been removed, as they do not seem
to exist anymore.

Co-authored-by: Alexander Reelsen <alexander@reelsen.net>
2020-07-31 16:16:31 -04:00
James Rodewig
0022d316bb
[DOCS] Merge search topic and overview pages (#60459) (#60479) 2020-07-30 16:45:18 -04:00