Commit graph

567 commits

Author SHA1 Message Date
Kewang
3c6797f2d2
Docs: use correct index name for kuromoji docs
The document is `kuromoji` analyzer, not `nori` analyzer
2022-09-01 12:59:42 -05:00
Jun Ohtani
c4dfc66ea2
[DOCS] Use CJKWidthCharFilter in JapaneseAnalyzer (#89364)
After Lucene 9.0, JapaneseAnalyzer uses CJKWidthCharFilter instead of
CJKWidthFilter.

See details https://issues.apache.org/jira/browse/LUCENE-9853

Co-authored-by: Julie Tibshirani <julietibs@apache.org>
2022-08-16 19:04:11 -07:00
GabyCT
341f3b717a
[DOCS] Update URLs in plugin document (#89221)
This PR updates the URLs for several references that are being
used in the plugin document.

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2022-08-10 16:40:01 +02:00
Thomas Decaux
2f0d9c8342
[DOCS] Fix plugins CLI doc CLI_JAVA_OPTS env var (#89003)
The commit 1d4534f848 changes the env variable ``ES_JAVA_OPTS`` to ``CLI_JAVA_OPTS``. Doc must be updated as well.
2022-08-04 09:04:28 -04:00
Abdon Pijpelink
aae0ed8eb1
[DOCS] Added note about using _size in Kibana. Closes #88322 (#89030)
* [DOCS] Added note about using _size in Kibana. Closes #88322

* Use correct attributes
2022-08-03 10:36:03 +02:00
Ryan Ernst
9b2f31be40
Simplify azure discovery installation docs (#88404)
The installation docs for azure discovery suggest installing
Elasticsearch, and then verifying it is running. However, installation
packages do not generally automatically start an installed service. For
example, with systemd, once a package is installed it must be enabled
and/or started explicitly. This commit removes wording about verifying
Elasticsearch is running, as well as adjusts later docs about restarting
it.
2022-07-13 17:32:00 -07:00
Ryan Ernst
9016883e1c
Add build_flavor back to info api rest response (#88336)
The build_flavor was previously removed since it is no longer relevant;
only the default distribution now exists. However, the removal of build
flavor included removing it from the version information on the info
response for the root path. This API is supposed to be stable, so
removing that key was a compatibility break. This commit adds the
build_flavor back to that API, hardcoded to `default`. Additionally, a
test is added to ensure the key exists going forward, until it can be
properly deprecated.

closes #88318
2022-07-08 09:54:29 +09:30
Ryan Ernst
eed8da3919
Move the ingest attachment processor to the default distribution (#87989)
The ingest attachment processor is currently available as a plugin. This
commit moves the processor to the default distribution so it is always
available.
2022-06-28 02:10:36 -04:00
debadair
c1d64a9558
[DOCS] Remove refs to Stack GS (#87996) 2022-06-23 16:56:45 -07:00
Ryan Ernst
e048687c0a
Reference the entire example plugins dir in docs (#87406)
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 09:06:11 -07:00
Keith Massey
6b34671dad
Upgrading to tika 2.4 (#86015)
Tika 1.x is end of life as of later this year. This change updates the
AttachmentProcessor to use tika 2. The goal was to keep the
functionality as close as possible, just with upgraded tika. The tests
have been slightly modified because of a small change in tika
functionality -- as of 2.4.0 it now adds an extra newline to the output
for every embedded attachment in a document. Also as part of this I have
broken apart the tika-parsers into individual dependencies. The reason
is that we are considering breaking this plugin apart, and want to know
exactly which parsers we pull in.
2022-05-24 16:34:19 -04:00
Ryan Ernst
d60cde6681
Remove flavor from build (#85796)
The default distribution is the only remaining build flavor, and has been for
quite a while now. This commit removes flavor from the internal Build
class. It keeps rest api compat for nodes info for now by hardcoding
`default`.
2022-04-11 16:46:55 -07:00
Abele Mălan
9ecb96fcf3
Fix some typos in plugins & reference docs (#84667)
This pull request removes a few instances of duplicate words or
punctuation and erroneous spelling from the docs.
2022-03-07 12:29:58 -05:00
Tobias Stadler
e3deacf547
[DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
James Rodewig
cb6265f9bd
[DOCS] Move snapshot repo types to separate pages (#82826)
With https://github.com/elastic/elasticsearch/pull/81870, the Azure, GCS, and S3 repository types have separate, dedicated pages in the Elasticsearch guide. For consistency, this PR creates separate pages for the shared file system, read-only URL, and source-only repository types.

Related changes:

- Adds redirects to the plugins docs
- Fixes a few breaking changes that refer to the Azure, GCS, and S3 repositories as plugins.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-01-26 17:13:39 -05:00
Rory Hunter
d2dbef5063
Convert repository plugins to modules (#81870)
Closes #81652.

Convert the `repository-azure`, `repository-gcs` and `repository-s3`
plugins into modules, so that they are always included in the
Elasticsearch distribution. Also change plugin installation, removal
and syncing so that attempting to add or remove these plugins still
succeeds but is now a no-op.
2022-01-10 10:45:42 +00:00
David Pilato
564ff9db88
Extract more standard metadata from binary files (#78754)
Until now, we have been extracted a few number of fields from the binary files sent to the ingest attachment plugin:

* `content`,
* `title`,
* `author`,
* `keywords`,
* `date`,
* `content_type`,
* `content_length`,
* `language`.

Tika has a list of more standard properties which can be extracted:

* `modified`,
* `format`,
* `identifier`,
* `contributor`,
* `coverage`,
* `modifier`,
* `creator_tool`,
* `publisher`,
* `relation`,
* `rights`,
* `source`,
* `type`,
* `description`,
* `print_date`,
* `metadata_date`,
* `latitude`,
* `longitude`,
* `altitude`,
* `rating`,
* `comments`

This commit exposes those new fields.

Related to #22339.

Co-authored-by: Keith Massey <keith.massey@elastic.co>
2021-11-23 05:01:08 +01:00
Rory Hunter
bad9d7c232
Document the declarative plugins configuration file (#80760)
Follow-up to #77544.
2021-11-17 21:11:00 +00:00
James Rodewig
659e0d3fd3
[DOCS] Overhaul snapshot and restore docs (#79081)
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 12:45:07 -05:00
David Pilato
879ae33b17
Remove binary field after attachment processor execution (#79172)
Keeping the binary as a field within the document might consume a lot of resources. It is highly recommended to remove that field from the document, which can be done by adding a `remove` processor in th pipeline.

This commit allows an easier way of doing this by adding a new option `remove_binary`.

 When set to `true`, it removes automatically the field at the end of the processor execution.

It defaults to `false` to keep the existing behavior and not introduce any breaking change.
2021-10-21 15:06:37 +02:00
Dimitris Athanasiou
af0f442018
[DOCS] Fix a typo in annotated text examples (#78683)
Fixes `start` to `strat` for the second example.
`strat` looks weird but it is a short name of the
legendary `stratocaster` guitar.
2021-10-05 07:23:04 -04:00
David Turner
5fd0a1710b
Note S3 plugin uses JVM-wide truststore (#77676)
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>
2021-09-14 04:43:51 -04:00
David Turner
9b6f50b981
Add note on cleanup of S3 multipart uploads (#77619)
* 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 12:48:50 -04:00
Ryan Ernst
96627dfa14
Remove quota-aware-fs plugin (#76352)
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 15:12:50 -07:00
Nhat Nguyen
5fb4c05095
Deprecate SimpleFS and replace it with NIOFS (#75156) (#75196)
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 18:22:41 -04:00
debadair
364fe32c0c
[DOCS] Update xrefs to the units sections in the ES guide (#74726) 2021-06-29 18:09:10 -07:00
James Rodewig
75bf92c050
[DOCS] Update service account creation docs for GCS repository plugin (#73561) (#73664)
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:06 -04:00
Rene Groeschke
94f07c4942
Fix docs path for docs PR to pass 2021-06-01 16:55:13 +02:00
James Rodewig
08f7902ff4
[DOCS] Clarify the type of Azure storage for snapshots (#72826) (#72976)
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:18 -04:00
Paul Puschmann
c575b15bd9
[DOCS] Improve discovery-gce docs (#72338)
* 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>
2021-04-28 12:26:52 -04:00
James Rodewig
6eed0b6bb5
[DOCS] Reword buffer_size default (#72038) 2021-04-21 12:46:41 -04:00
Yannick Welsch
801c50985c
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:16:00 +02:00
Christoph Büscher
014cc2b759
Update mapper-size.asciidoc
Small change in wording.
2021-04-01 11:05:34 +02:00
Christoph Büscher
ba0ecac934
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:24:21 +02:00
James Rodewig
693807a6d3
[DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
James Rodewig
bd4439be24
[DOCS] Replace hard-coded admons with cloud-only attribute (#70864) 2021-03-25 09:21:35 -04:00
Mark Vieira
ef51e69513
Indicate that the quota-aware-fs plugin is for cloud-only use in docs (#70832) 2021-03-24 14:24:00 -07:00
James Rodewig
010a973018
[DOCS] Refactor ingest pipeline docs (#70253) 2021-03-15 12:22:57 -04:00
Rory Hunter
0f6ad19f15
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:10:06 +00:00
David Turner
851e2b8ed5
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:10 +00:00
David Turner
27df7d6f75
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:16 +00:00
James Rodewig
463c7a1269
[DOCS] Audit community plugins and integrations (#69378) 2021-02-22 16:10:17 -05:00
James Rodewig
3252de5f35
[DOCS] Remove default modules from plugin docs (#69304) 2021-02-22 10:21:17 -05:00
James Rodewig
9b88ae92e6
[DOCS] Fix typos for duplicate words (#69125) 2021-02-17 10:34:20 -05:00
James Rodewig
6e0befe25c
[DOCS] Fix S3 bucket names in S3 repo plugin docs (#66521)
Co-authored-by: Inbar Shimshon <inbar.shimshon@elastic.co>
2020-12-17 09:53:25 -05:00
James Rodewig
78facdcf69 Revert "Update repository-s3.asciidoc"
This reverts commit 77a54aa722.
2020-12-17 08:42:23 -05:00
James Rodewig
7292a2e3ed Revert "Update repository-s3.asciidoc"
This reverts commit c40c29e2e4.
2020-12-17 08:42:15 -05:00
Inbar Shimshon
c40c29e2e4
Update repository-s3.asciidoc 2020-12-17 15:36:41 +02:00
Inbar Shimshon
77a54aa722
Update repository-s3.asciidoc
the bucket naming convention should be clear, underscores (which we use in all of our examples) are not allowed so we should really change all these examples.
2020-12-17 15:34:51 +02:00
Dan Hermann
157679cc76
[DOCS] resource_name property for attachment ingest processor (#65974) 2020-12-08 11:53:58 -06:00