Commit graph

588 commits

Author SHA1 Message Date
Salvatore Campagna
a5e9fa9362
Update synthetic source documentation (#112363) (#115098) 2024-10-18 14:40:35 +02:00
Salvatore Campagna
90e16e7e87
Replace usages of _source.mode in documentation (#114743) (#114917)
We will deprecate the `_source.mode` mapping level configuration
in favor of the index-level `index.mapping.source.mode` setting.
As a result, we go through the documentation and update it to reflect
the introduction of the setting.

(cherry picked from commit f6a1e36d6b)
2024-10-16 16:51:48 +02:00
john-wagster
e19a9760a9
Deduplicate Nori and Kuromoji User Dictionary (#112768) (#113401)
added the ability to deduplicate the user dictionary optionally
2024-09-24 02:43:42 +10:00
Liam Thompson
2fac37dd68
fix typos of docs/plugins (#113348) (#113404)
Co-authored-by: YeonghyeonKo <46114393+YeonghyeonKO@users.noreply.github.com>
2024-09-24 02:20:36 +10:00
Liam Thompson
cbe2faead8
fix typos (#113329) (#113400)
Co-authored-by: Pm Ching <41728178+pionCham@users.noreply.github.com>
2024-09-24 02:05:57 +10:00
Sam Xiao
7cd6de76f4
Adds example plugin for custom ingest processor (#112282)
* Adds example plugin for custom ingest processor

Adds an example for creating a plugin with a simple custom ingest
processor. The example processor repeats the value of an expected filed
in a document, or ignores it if the expected field does not exist.

Closes #111539
2024-09-06 12:05:52 -04:00
Dai Sugimori
2982fc61e8
[DOCS] Add docs for new Lucene's filters for Japanese text. (#112356) 2024-09-04 12:55:56 +02:00
Oleksandr Kolomiiets
c3d45b99f2
Document binary field defauls in TSDB indices (#108046) 2024-04-30 08:02:16 -07:00
Oleksandr Kolomiiets
e1d902d33b
Implement synthetic source support for annotated text field (#107735)
This PR adds synthetic source support for annotated_text fields. Existing implementation for text is reused including test infrastructure so the majority of the change is moving and making things accessible.

Contributes to #106460, #78744.
2024-04-25 10:31:27 -07: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
Parsa Hosseinian
dab8b2798a
fix a typo in stable plugin documentation (#101812) 2023-11-06 10:52:22 +01:00
James Rodewig
1301995a46
[DOCS] Remove unneeded ifevals from install docs (#98952)
Problem: The current install docs contain several `ifeval` statements that hide commands and code snippets based on the branch's release state. These statements make the Asciidoc hard to read  and maintain. It also makes doc changes difficult to preview.

Solution: Remove `ifeval` statements that hide commands or code snippets. Leave in any `ifeval` statements used to add warnings.
2023-08-29 07:56:10 -04:00
Piotr Stankowski
a462deaccf
HDFS plugin: add replication_factor param (#94132)
Allows users of the HDFS repository plugin to configure the replication factor for files created by the repository implementation at repository creation time.

---------

Co-authored-by: James Baiera <james.baiera@gmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-08-03 14:13:45 -04:00
Wonseop Kim
9465e68dbe
[DOC] Fixes a link in nori_part_of_speech token filter (#97158)
* [DOCS] Fixes a link in nori_part_of_speech token filter

* [DOCS] Fixes a typo in the link

---------

Co-authored-by: Wonseop Kim <refarde@gmail.com>
2023-06-28 15:51:43 +02: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
Abdon Pijpelink
c1490d48a4
[DOCS] Remove SNAPSHOT references from stable plugin example (#94952)
* [DOCS] Remove snapshot references from stable plugin example

* Fix indentation

* More indentation issues
2023-03-31 16:36:05 +02:00
Abdon Pijpelink
f93a94009f
[DOCS] Documentation update for creating plugins (#93413)
* [DOCS] Documentation for the stable plugin API

* Removed references to rivers

* Add link to Cloud docs for managing plugins

* Add caveat about needing to update plugins

* Remove reference to site plugins

* Wording and clarifications

* Fix test

* Add link to text analysis docs

* Text analysis API dependencies

* Remove reference to REST endpoints and fix list

* Move plugin descriptor file to its own page

* Typos

* Review feedback

* Delete unused properties file

* Changed  into

* Changed 'elasticsearchVersion' into 'pluginApiVersion'

* Swap 'The analysis plugin API' and 'Plugin file structure' sections

* Update docs/plugins/authors.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/example-text-analysis-plugin.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/plugin-descriptor-file.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/plugin-script.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Rewording

* Add modulename and extended.plugins descriptions for descriptor file

* Add link to existing plugins in Github

* Review feedback

* Use 'stable' and 'classic' plugin naming

* Fix capitalization

* Review feedback

---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: William Brafford <william.brafford@elastic.co>
2023-02-13 14:15:12 +01:00
sunyoung-dev
df1263c4dc
Fix broken site links (#92954) 2023-01-16 17:44:18 +01:00
Kiyoung's Noona
e535df64c5
Fix typo in nori docs and tests (#92336)
C샤프 in English is C#, not C++.
(C++ in Korean is C플플, C쁠쁠 or C플러스플러스.)

The translation doesn't make sense, so I changed C++ to C#.
It might be true that the writer used C샤프 as just an independent example, regardless C++, but I think it is better to align them for better understanding.
2023-01-11 23:54:44 +01:00
amyjtechwriter
f2512d4694
[DOCS] fixes issue number 91889 - missing [discrete] header (#91976)
* [DOCS] fixes issue number 91889 - missing [discrete] header

* Update docs/plugins/plugin-script.asciidoc

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2022-11-29 17:40:01 +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
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