Commit graph

79 commits

Author SHA1 Message Date
Liam Thompson
d0f4966431
[DOCS] Add local dev setup instructions (#107913)
* [DOCS] Add local dev setup instructions

- Replace existing Run ES in Docker locally page, with simpler no-security local dev setup
- Move this file into Quickstart folder, along with existing quickstart guide
- Update self-managed instructions in Quickstart guide to use local dev approach
2024-05-07 18:10:48 +02:00
Keith Massey
8adc2926a2
Fixed the spelling of the word successful in docs (#107595) 2024-04-18 08:08:30 -05: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
Mark J. Hoy
624a5b1fe5
Add Docs for Azure OpenAI Embeddings Inference (#107498)
* Update docs for Azure OpenAI Embeddings inference

* cleanups

* update link for dot_product similarity

* final cleanups
2024-04-16 10:52:27 -04:00
István Zoltán Szabó
1587dada58
[DOCS] Fixes a typo in the HugggingFace tutorial. (#107321) 2024-04-10 18:50:44 +02:00
István Zoltán Szabó
afb492272a
[DOCS] Adds HuggingFace example to inference API tutorial (#107298) 2024-04-10 17:57:18 +02:00
István Zoltán Szabó
331d7831ff
[DOCS] Fixes search request in semantic search tutorial. (#107034) 2024-04-03 11:30:14 +02:00
István Zoltán Szabó
a3d96b9333
[DOCS] Changes model_id path param to inference_id (#106719) 2024-03-26 08:20:34 +01:00
István Zoltán Szabó
e92a7a7168
[DOCS] Adds note to inference tutorial about similarity (#106567) 2024-03-21 14:33:10 +01:00
István Zoltán Szabó
09b6072afd
[DOCS] Changes Cohere inference examples in tutorial and API docs (#106524) 2024-03-20 15:07:41 +01:00
Jack Conradson
68b0acac8f
Add retrievers using the parser-only approach (#105470)
This enhancement adds a new abstraction to the _search API called "retriever." A 
retriever is something that returns top hits. This adds three initial retrievers called
"standard", "knn", and "rrf". The retrievers use a parser-only approach where they
are parsed and then translated into a SearchSourceBuilder to execute the actual
search.
---------

Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co>
2024-03-12 10:11:55 -07:00
István Zoltán Szabó
265461fb1b
[DOCS] Changes element_type in index mapping for the infrence tutorial. (#106233) 2024-03-12 14:43:58 +01:00
István Zoltán Szabó
3dcfbe0732
[DOCS] Changes the cohere example to use a different model (#106037) 2024-03-06 19:40:04 +01:00
István Zoltán Szabó
6ae9dbfda7
[DOCS] Adds cohere service example to the inference API tutorial (#105904)
Co-authored-by: Jonathan Buttner <56361221+jonathan-buttner@users.noreply.github.com>
2024-03-04 16:43:41 +01:00
Niels Bauman
64891011d3
Extend repository_integrity health indicator for unknown and invalid repos (#104614)
This PR extends the repository integrity health indicator to cover also unknown and invalid repositories. Because these errors are local to a node, we extend the `LocalHealthMonitor` to monitor the repositories and report the changes in their health regarding the unknown or invalid status.
To simplify this extension in the future, we introduce the `HealthTracker` abstract class that can be used to create new local health checks.
Furthermore, we change the severity of the health status when the repository integrity indicator reports unhealthy from `RED` to `YELLOW` because even though this is a serious issue, there is no user impact yet.
2024-02-07 15:18:55 +01:00
Abdon Pijpelink
cacef35467
[DOCS] Use shortened URL to link to ES|QL demo env (#103862) 2024-01-04 09:38:55 +01:00
Abdon Pijpelink
3ace422668
[DOCS] More ES|QL getting started updates (#102980)
* [DOCS] More ES|QL getting started updates

* Change 'server.ip' into 'server_ip'
2023-12-05 14:37:52 +01:00
Abdon Pijpelink
df097aae01
[DOCS] Change ES|QL getting started guide for updated dataset (#102970) 2023-12-05 12:53:21 +01:00
Abdon Pijpelink
ac973f0064
[DOCS] Improve enrich policy execute 'wait_for_completion' docs (#102291)
* [DOCS] Improve enrich policy execute 'wait_for_completion' docs

* Update docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc

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

---------

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-11-27 17:17:06 +01:00
Liam Thompson
d44e05d2c2
[DOCS] Add ES quickstart (#102226)
* [DOCS] TEST restore quickstart

* Use up to date Docker instructions, minor user-friendly modifications

* Use books dataset, update verbiage, add examples

* Update verbiage

* Updated Elasticsearch 'Getting Started' docs: added SSL, Docker setup, Python resources, and expanded next steps

* minor formatting

* Collapse responses, TODO comment tests

* Add request tests

* Edit superfluities

* Apply suggestions

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/tab-widgets/quick-start-install.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

---------

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2023-11-24 15:27:41 +01:00
Abdon Pijpelink
b03939ec9d
[DOCS] Update ES|QL getting started for demo environment (#102134) 2023-11-14 13:17:48 +01:00
István Zoltán Szabó
c303ab885a
[DOCS] Simplifies dense vector mapping in semantic search example (#102080) 2023-11-14 10:52:56 +01:00
Abdon Pijpelink
c6a1f831e0
[DOCS] Getting started with ES|QL queries guide (#101634)
* Page structure

* More getting started content

* Fix build errors

* Small improvements

* Typo

* Add link to public demo environment

* Review feedback

* Update docs/reference/esql/esql-get-started.asciidoc

Co-authored-by: Andrei Stefan <astefan@users.noreply.github.com>

* Review feedback

---------

Co-authored-by: Andrei Stefan <astefan@users.noreply.github.com>
2023-11-03 13:47:09 +01:00
István Zoltán Szabó
9b404099b4
[DOCS] Adds links to token section in ESLER conceptual. (#101033) 2023-10-18 11:30:38 +02:00
István Zoltán Szabó
446ac9f378
[DOCS] Updates ELSER tutorial with inference processor changes (#100420)
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-11 17:33:20 +02:00
Carlos Delgado
f2dfbfe8c4
[DOCS] Add sparse-vector field type to docs, changed references (#100348) 2023-10-06 14:25:27 +02:00
István Zoltán Szabó
9d01def3dc
[DOCS] Changes semantic search tutorials to use ELSER v2 and sparse_vector field type (#100021)
* [DOCS] Changes semantic search tutorials to use ELSER v2 and sparse_vector field type.

* [DOCS] More edits.
2023-09-29 09:24:36 +02:00
James Rodewig
73293dca86
[DOCS] Remove unused widgets (#98953)
No-op change to remove a few unused Asciidoc widgets. These aren't referenced or published anywhere in the docs.
2023-08-29 07:53:26 -04:00
James Rodewig
31408bddc1
[DOCS] Add $ELASTIC_PASSWORD env var to install docs (#98898)
- Removes duplicated security autoconfiguration output from the docs. This is difficult to keep updated and makes the docs longer.
- Encourages the user to store the `elastic` password as an environment variable. Users don't need to rely on curl's password prompts.
- Removes unused `api-call-widget` files. These aren't published anywhere in the docs currently.
2023-08-28 08:25:13 -04:00
Dianna Hohensee
a25e176692
Add node "roles" to allocation explain response (#98550)
Report node "roles" in the /_cluster/allocation/explain response.
Nodes with limited sets of roles may affect shard distribution in ways
users did not originally consider, so it is helpful to surface this
information along with node allocation decision explanations.
2023-08-23 08:30:35 -04:00
David Kilfoyle
4d3069a986
Fix broken links to Cloud snapshot restore info (#98213) 2023-08-04 16:38:27 -04:00
Jeffrey Chu
7797e27689
Update cpu-usage.asciidoc (#97883)
In 8.8.2, Column `name` contains the node name, instead of column `node`
2023-07-24 13:47:06 +02:00
Abdon Pijpelink
40409bf8ca
[DOCS] Semantic search page (#97715)
Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
Co-authored-by: David Roberts <dave.roberts@elastic.co>
2023-07-20 10:45:13 +02:00
Pablo Alcantar Morales
253fe6325d
Add shards capacity troubleshooting guide (#95208) 2023-04-19 09:24:07 +02:00
Andrei Dan
9170113036
[HealthAPI] Add support for the FEATURE_STATE affected resource (#92296)
The `shards_availability` indicator diagnoses the condition where
indices need to be restored from snapshot.
Starting with 8.0 using feature_states when restoring from snapshot is
mandatory.

This adds support for the `FEATURE_STATE` affected resource to aid with
building up the snapshot restore API call (which will need to include
all the indices and feature states reported by the restore-from-snapshot
diagnosis).

Note that the health API will not report any indices that are part of a
feature state.
2022-12-20 13:39:41 +00:00
Mary Gouseti
cfd23d512f
Disk indicator troubleshooting guides (#90504) 2022-10-14 15:24:21 +02:00
James Baiera
db73aa0498
Add repeated snapshot failure troubleshooting guide (#89762)
This troubleshooting guide is what will be returned from the SLM health indicator 
when a SLM policy has suffered from too many repeat failures without a successful 
execution.
2022-09-15 17:01:32 -04:00
Iraklis Psaroudakis
d83ed3315a
Re-registering corrupt repository unblocks it (#89719)
Fixes #89130
2022-09-12 20:21:35 +03:00
Mary Gouseti
89903bbe23
Troubleshooting docs for ACTION_RESTORE_FROM_SNAPSHOT (#87692)
Troubleshooting guide to restore indices and data streams that have
missing data from a snapshot.

This will be associated with the user action
`ACTION_RESTORE_FROM_SNAPSHOT`.

Preview link:
https://elasticsearch_87692.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/restore-from-snapshot.html
2022-07-27 23:37:08 +09:30
Mary Gouseti
0f670404f6
Fix Note in troubleshooting docs (#88846) 2022-07-27 14:31:06 +02:00
Andrei Dan
f3431e1bff
Add troubleshooting guide for corrupt repository (#88391)
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
2022-07-14 13:37:02 +01:00
Andrei Dan
3e1242b63e
Replace ilm/slm with their full names (#88060) 2022-06-30 09:44:46 +01:00
Andrei Dan
4e869860d6
Fix StableMasterHealthIndicatorServiceTests and start-slm doc test (#87962) 2022-06-23 12:48:25 +01:00
Andrei Dan
6e98072db5
Add start slm user action (#87854)
This creates a user action for the slm health indicator that will help
the user to start SLM.
2022-06-23 11:04:45 +01:00
Andrei Dan
a4e7064b0e
Create ILM not running user action (#87852)
This creates a user action for the ilm health indicator that will help
the user to start ILM.
2022-06-23 09:54:31 +01:00
Andrei Dan
2ec4a9e006
Add troubleshooting doc for missing tier (#87526)
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
2022-06-17 12:24:33 +01:00
Keith Massey
6caf39c109
How to increase node capacity docs (#87188)
This adds troubleshooting documentation for the case when the ShardsAvailabilityHealthIndicatorService
reports that there are not enough nodes in the data tier (user action "increase_node_capacity_for_allocations" or
"increase_tier_capacity_for_allocations_". This covers both the cloud and self-managed environments. For
cloud we first recommend increasing the number of availability zones (because you cannot directly add nodes), and
decreasing index.number_of_replicas if that is not possible. For self-managed, we first recommend adding nodes,
and decreasing index.number_of_replicas if that is not possible.
2022-06-08 14:06:47 -05:00
Andrei Dan
15b8fc3151
Fix troubleshooting doc tab to point to self-managed (#87465)
This fixes the Self Managed tab to load the
self-managed instructions.
2022-06-07 16:29:54 +01:00
Andrei Dan
3fb60a1551
Update get kibana guide in troubleshooting docs (#87075) 2022-05-25 16:11:18 +01:00
Andrei Dan
08b323131f
Troubleshooting guides for disabled allocations (#86789)
This adds the troubleshooing guides when index and cluster allocations are
disabled.

Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
2022-05-24 10:27:15 +01:00