Commit graph

9488 commits

Author SHA1 Message Date
Adam Locke
33b72f34e2
[DOCS] Add note that write indices are not replicated (#82997)
* [DOCS] Add note that write indices are not replicated

* Clarify note about is_write_index

* Clarify leader aliases with is_write_index

Co-authored-by: Henning Andersen <33268011+henningandersen@users.noreply.github.com>

Co-authored-by: Henning Andersen <33268011+henningandersen@users.noreply.github.com>
2022-01-28 13:24:53 -05:00
Julie Tibshirani
e7ba03e0a6
Add notes on indexing to kNN search guide (#83188)
This change adds a new 'indexing considerations' section that explains why index
calls can be slow and how force merge can help search latency.
2022-01-28 10:23:35 -08:00
Joe Gallo
0935485684
Fix get-snapshot-api :docs:integTest (#83273) 2022-01-28 12:24:01 -05:00
Christoph Büscher
61e1b080dd
[Docs] Add supported _terms_enum field types (#83244)
The `_terms_enum` API currently supported keyword, constant_keyword and
flattened fields. This should be documented more clearly.
2022-01-28 12:47:12 +01:00
Salvatore Campagna
9de75c2ac5
Add an aggregator for IPv4 and IPv6 subnets (#82410)
Parameters accepted by the aggregator include:

* prefix_length (integer, required): defines the network size of the subnet mask;
* is_ipv6 (boolean, optional, default: false): defines whether the prefix applies to IPv6 (true) or IPv4 (false) IP addresses;
* min_doc_count (integer, optional, default: 1): defines the minimum number of documents for a bucket to be returned in the results;
* append_prefix_length (boolean, optional, default: false): defines if the prefix length is appended to the IP address key when returning results;
* keyed (boolean, optional, default: false): defines whether the result is returned keyed or as an array of buckets;

Each bucket returned by the aggregator represents a different subnet. IPv4 subnets also include a netmask field set to the subnet mask value (i.e. "255.255.0.0" for a /16 subnet).

Related to: #57964 and elastic/kibana#68424
2022-01-28 11:59:07 +01:00
Jack Conradson
43052a1074
Fix joda migration for week based methods in Painless (#83232)
This change updates the docs to correct suggestions for migrating from 
JodaCompatibleZonedDateTime to ZonedDateTime in Painless for week based year and week of 
week based year.
2022-01-27 12:23:49 -08:00
Adam Locke
e182067f1f
Clarify commands shown for "permanently" setting max_map_count (#82345) (#83227)
* Clarify commands shown for "permanently" setting max_map_count

The current text shows a grep, which of course does not set the value at all.  I've clarified why it's offered (to CHECK the value).

I've also moved the command for setting the value temporarily to above that discussion, to make it more clear to readers that that's what it does.

* Reorder commands, add headings, and fix typos

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Charlie Arehart <charlie@carehart.org>
2022-01-27 13:45:30 -05:00
David Kyle
c1fbf87de8
[ML] Add error counts to trained model stats (#82705)
Adds inference_count, timeout_count, rejected_execution_count
and error_count fields to trained model stats.
2022-01-27 16:18:20 +00:00
Nicole Albee
5b6164f8fd
[Docs] Watcher clarification on CSV formulas warning. (#83088)
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-01-27 09:23:12 -05:00
James Rodewig
836d9bc786
[DOCS] Add redirect for 'Java client and security' page (#83180)
Adds a redirect for the [Java client and security](https://www.elastic.co/guide/en/elasticsearch/reference/7.17/java-clients.html) page, which has been removed in 8.0+.

We saw this missing page create several broken links in https://github.com/elastic/docs/pull/2312. I've opened separate PRs to update those links. This adds a redirect for anyone who otherwise lands on the page.
2022-01-27 08:27:35 -05:00
István Zoltán Szabó
b42ba64019
[DOCS] Fixes geo function field names. (#83198) 2022-01-27 12:03:58 +01:00
Ignacio Vera
0873893bb7
New GeoHexGrid aggregation (#82924)
This commit introduces a new geogrid aggregation called GeoHexGridAggregation that
is based in Uber h3 grid. It only supports geo_point fields.
2022-01-27 07:45:51 +01: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
Mitar
b65fb17a48 Fixed documentation for built in date formats. (#83036)
We had a lot of `ZZ` on the end of formats. But it's just `Z`.
2022-01-26 14:22:02 -05:00
Ugo Sangiorgi
305ff20b8f
[DOCS] Add missing HTML anchors to CCR and ML (#80287) 2022-01-26 11:00:40 -08:00
James Rodewig
47d45d0a14
[DOCS] Archived settings block config updates (#82069)
**Changes:**

* Notes that archived cluster settings block cluster setting updates. Previously, the docs stated that ES ignored archived cluster settings.
* Notes that archived index settings can block index settings updates. For example, it blocks `index.hidden` but not `number_of_replicas`. Previously, the docs stated that you could safely ignore archived index settings.

Relates #78351

Closes #61175
2022-01-26 12:21:46 -05:00
James Rodewig
63f228e24e
[DOCS] Re-add paragraph noting doc_count is approximate (#83154)
This paragraph was accidentally removed as part of #79205. Also fixes a minor heading capitalization error.
2022-01-26 11:07:59 -05:00
David Turner
9633883c64
Add note on truststore for S3-compatible repos (#82669)
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 11:16:43 +00:00
Toby Sutor
30b8cdc184
[DOCS] Add note to that log4j customization is outside the support scope (#82668)
* [docs] Add note to Elasticsearch logging that log4j customization is out of support scope

* Update language for default logging recommendation

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Quin Hoxie <qhoxie@gmail.com>
Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-01-25 17:03:16 -05:00
James Rodewig
eda391a7ed
[DOCS] Delete pipeline containing stored script (#83102)
Adds a hidden snippet to delete the pipeline containing a stored script for cleanup.

Relates to https://github.com/elastic/elasticsearch/issues/83097.
2022-01-25 16:32:56 -05:00
James Rodewig
d3fb014914
[DOCS] Reuse multi-level join warning (#82976)
Updates and reuses a warning against creating multi-level `join` fields to make it more prominent.

The current warning is low on the page, where some users may not seeing until they've already begun mapping fields.

Closes https://github.com/elastic/elasticsearch/issues/82818.
2022-01-25 13:51:42 -05:00
James Rodewig
84429e6ff2
[DOCS] Fix typo in action.destructive_requires_name breaking change (#83085)
In 8.0+, the `action.destructive_requires_name` setting defaults to `true`, not `false`.
2022-01-25 11:03:28 -05:00
James Rodewig
3845a41804
[DOCS] Fix stored script example snippet (#83056)
Changes:

* Updates the example Painless script to be valid and aligns it with the example in [How to write a script](https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting-using.html#script-stored-scripts).
* Adds a hidden snippets to delete the script for cleanup.

Relates to https://github.com/elastic/elasticsearch/issues/83038
2022-01-25 10:30:48 -05:00
James Rodewig
b552d5cb0e
[DOCS] Re-add network traffic para to term query (#83047)
Re-adds a paragraph about minimizing network traffic for a terms lookup.

This paragraph was erroneously removed as part of https://github.com/elastic/elasticsearch/pull/42889.
2022-01-25 10:27:10 -05:00
James Rodewig
b41397111c
[DOCS] Rename example stored script (#83054)
Changes:

* Renames the example stored script to avoid naming collisions with the [stored script API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/create-stored-script-api.html).
* Adds a hidden snippet to delete the script for cleanup.

Relates to https://github.com/elastic/elasticsearch/issues/83038
2022-01-25 10:17:33 -05:00
David Kyle
04d520c212
[ML][DOCS] Add Trained model APIs to the REST APIs index (#82791) 2022-01-25 15:14:48 +00:00
István Zoltán Szabó
a5affc7104
[DOCS] Fixes field names in ML sum functions. (#83048) 2022-01-25 15:28:06 +01:00
Hendrik Muhs
f412ce486c
[Transform][Docs] Delete advise about group_by order (#82886)
Since 7.15 transform automatically optimizes the grouping part of the query. We therefore can delete group_by order advise in the transform at scale documentation so it gets simpler.
2022-01-25 10:22:33 +01:00
István Zoltán Szabó
2715db8103
[DOCS] Updates Painless transform examples (#82802) 2022-01-25 10:17:49 +01:00
Yannick Welsch
d9f77fa3a6
Allow doc-values only search on ip fields (#82929)
Allows searching on ip fields when those fields are not indexed (index: false) but just doc values are enabled.

This enables searches on archive data, which has access to doc values but not index structures. When combined with
searchable snapshots, it allows downloading only data for a given (doc value) field to quickly filter down to a select set
of documents.

Relates #81210 and #52728
2022-01-25 09:24:12 +01:00
James Rodewig
6b841325f1
[DOCS] Fix headings for Azure, GCS, and S3 snapshot repo pages (#82996)
Updates the headings to use sentence case.
2022-01-24 17:14:55 -05:00
James Rodewig
8ac973f0df
[DOCS] Remove compress param from example snippets (#82994)
Per [this comment](https://github.com/elastic/elasticsearch/pull/56827#discussion_r425928626) in #56827, we don't need to highlight the `compress` parameter. The parameter defaults to `true` anyway.
2022-01-24 17:11:18 -05:00
James Rodewig
cbeb2c2ce1
[DOCS] Fix typo (#82988) 2022-01-24 15:50:07 -05:00
Stef Nestor
6ce61b6b34
Clarify es-users effects per node (#82099)
@jrodewig 🙏🏼 - updates that `elasticsearch-users` effects per node (i.e. users need to update the same info across all nodes)
2022-01-24 14:33:55 -05:00
Adam Locke
2684b97c73
[DOCS] Remove unused tag from rolling restart docs (#82967) 2022-01-24 12:54:23 -05:00
Rory Hunter
997880f518
Mention bind-mounting plugins dir in Docker docs (#82622)
Closes #69533.

The Docker docs mention bind-mounting the `config`, `data` and
`logs` directories when using an arbitrary UID / GID, but they fail
to mention that the `plugins` dir must also be mounted in order to
install plugins.
2022-01-24 17:10:29 +00:00
Alex Perrin
db9fb02267
Rolling restart instructions (#82387)
* Rolling restart instructions

In a rolling restart scenario, indexing do not need to be stopped. This step is optional. I have updated Rolling restart/ step 2.

Note: I am not sure how to check if the doc, once generated, will keep the numbering as section 1 and 3 are references to the full restart, can you check this detail?

* Clarify that shard recovery can be faster

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-01-24 11:56:13 -05:00
James Rodewig
c7917d7996
[DOCS] Remove Hunspell dictionaries location config (#82704) (#82954)
User can no longer set location for Hunspell dictionaries. `<config-dir>/hunspell` directory is silently used everytime no matter what configuration is used.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
(cherry picked from commit 1a4fd34129)

Co-authored-by: Jan Jíša <jenda.jisa@gmail.com>
2022-01-24 11:17:12 -05:00
David Turner
dc26886ee1
Clarify cluster state API docs (#82930)
The `GET _cluster/state` API is really only suitable for debugging or
diagnostics. Its response format is not documented since it changes
fairly freely between versions.

Today we mention in its docs that this API is unstable, and deliberately
omit a description of its response format, but we don't explicitly say
that it's only for diagnostics and is unsuitable for consumption by
external tools that might try and use it for monitoring.

This commit adjusts the docs to give some more explicit guidance about
how it should and shouldn't be used.
2022-01-24 10:09:45 -05:00
Yannick Welsch
0592c4cd7e
Allow doc-values only search on boolean fields (#82925)
Allows searching on boolean fields when those fields are not indexed (index: false) but just doc values are enabled.

This enables searches on archive data, which has access to doc values but not index structures. When combined with
searchable snapshots, it allows downloading only data for a given (doc value) field to quickly filter down to a select set
of documents.

Relates #81210 and #52728
2022-01-24 14:27:06 +01:00
Yannick Welsch
fd7f69cea6
Allow doc-values only search on keyword fields (#82846)
Allows searching on keyword fields when those fields are not indexed (index: false) but just doc values are enabled.

This enables searches on archive data, which has access to doc values but not index structures. When combined with
searchable snapshots, it allows downloading only data for a given (doc value) field to quickly filter down to a select set
of documents.

Relates #81210 and #52728
2022-01-24 08:57:11 +01:00
Mat Schaffer
b2f2e3a7a3
Upgrade documentation for xpack.monitoring.history.duration (#82295)
* Upgrade documentation for xpack.monitoring.history.duration

* A few updates now that https://github.com/elastic/elasticsearch/pull/82498 has been opened with a concrete policy.

* Grammar fix

* Update docs/reference/migration/migrate_8_0/cluster-node-setting-changes.asciidoc

Co-authored-by: James Baiera <james.baiera@gmail.com>

Co-authored-by: James Baiera <james.baiera@gmail.com>
2022-01-24 11:10:16 +09:00
Lisa Cawley
0a16177f40
[DOCS] Fix formatting in cat transforms API (#82899) 2022-01-20 17:45:43 -08:00
Adam Locke
c098af1172
[DOCS] Update enrollment token docs for multi-node configuration (#82829)
* [DOCS] Update enrollment token docs for multi-node configuration

* Update transport.host guidance based on review feedback

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2022-01-20 13:00:57 -05:00
James Rodewig
b32476c22b
[DOCS] Remove duplicated text (#82637) (#82880)
(cherry picked from commit 376e500e9c)

Co-authored-by: Daeho Ro <lamanus@outlook.kr>
2022-01-20 12:48:46 -05:00
Artem Prigoda
1ddaf253d5
Add support for HTTP Proxies for the GCS repository (#82737)
* Add support for HTTP Proxies for the GCS repository

The change adds 3 new client properties for the GCS repository:

* gcs.client.default.proxy.type
* gcs.client.default.proxy.host
* gcs.client.default.proxy.port

They allow to configure a [java.net.Proxy](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Proxy.html)
for the GCS SDK to use when communicating with the GCS API.

Resolves #82444
2022-01-20 15:46:59 +01:00
Lisa Cawley
91cd38df57
[DOCS] Fix links to anomaly detection docs (#82836) 2022-01-19 17:54:18 -08:00
Adam Locke
943a12e4fb
[DOCS] Fix typo (extra +) (#82823) 2022-01-19 16:28:20 -05:00
Adam Locke
12d47983e4
[DOCS] Remove extraneous Elasticsearch Docker image information (#82821)
* [DOCS] Remove extraneous Elasticsearch Docker image information

In the step for starting Elasticsearch with the generated enrollment token, `docker.elastic.co/elasticsearch/elasticsearch:` was included in conjunction with the `{docker-image}` variable. This include led to a duplicate Docker image that displayed as `ocker.elastic.co/elasticsearch/elasticsearch:docker.elastic.co/elasticsearch/elasticsearch:8.0.0-rc1`. This PR removes the duplicate image information.

* Update ifeval statements and add sub-heading for setting JVM heap size
2022-01-19 14:59:31 -05:00
James Rodewig
d8229ddd5b
[DOCS] Clarify that null values don't create dynamic field mappings (#82769)
Closes #82641.
2022-01-19 09:08:36 -05:00