Commit graph

172 commits

Author SHA1 Message Date
Liam Thompson
be6a058a67
[DOCS] Improve/fix documentation on stored scripts (#119921) (#119971)
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
(cherry picked from commit 1e608dc223)

Co-authored-by: Valentin Crettaz <valentin.crettaz@consulthys.com>
2025-01-11 04:17:15 +11:00
shainaraskas
f4e2537ed0
[8.17] [DOCS] Concept cleanup 2 - ES settings (#119373) (#119643) 2025-01-10 10:31:05 -05:00
Lisa Cawley
d9c6b679da
[8.17] [DOCS] More links to new API site (#119380) (#119419)
* [DOCS] More links to new API site (#119380)

* Fix example test failure
2025-01-01 10:06:07 +11:00
István Zoltán Szabó
568a637dcc
[DOCS] Adds an admonition to the transform painless examples. (#113706) (#113762) 2024-09-30 17:57:33 +10:00
István Zoltán Szabó
2b0d2c9c23
[DOCS] updates transforms at scale doc with date rounding. (#109073) 2024-05-27 16:34:01 +02:00
Lisa Cawley
a079cdc17d
[DOCS] Update transform and anomaly detection rule creation steps (#107975) 2024-05-07 07:52:45 -07: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
Lisa Cawley
dcc3d830ea
[DOCS] Unhealthy transform rule check (#106521) 2024-03-21 07:20:56 -07:00
Lisa Cawley
d8da8fa61a
[DOCS] Update transform health rule details (#105719) 2024-03-12 07:33:19 -07:00
Lisa Cawley
3418c6a2af
[DOCS] Alerts-as-data for anomaly detection rules (#100864) 2023-10-17 07:37:22 -07:00
James Rodewig
255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00
Ed Savage
3682a88199
[ML] Update documentation regarding versioning. (#98320)
Update the ml and transform reference documentation to provide information regarding the new versioning schemes independent from the product versions.

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2023-08-10 11:20:58 +01:00
István Zoltán Szabó
eaadf351c2
[DOCS] Fixes transform scheduled_now documentation (#96766) 2023-06-12 16:07:30 +02:00
Abdon Pijpelink
d68a2e04ce
[DOCS] Fixes a typo in the stop transform API docs (#96358) 2023-05-25 19:43:45 +02:00
István Zoltán Szabó
ff5c86eb7c
[DOCS] Adds example of using stored scripts in Transforms (#96285) 2023-05-23 15:57:08 +02:00
Przemysław Witek
2b70165ffd
[Transform] Allow specifying destination index aliases in the Transform's dest config (#94943) 2023-04-17 15:08:43 +02:00
Przemysław Witek
a3f34a39c8
[Transform] Add delete_dest_index parameter to the Delete Transform API (#94162) 2023-03-10 13:02:19 +01:00
Lisa Cawley
f49bb09503
[DOCS] Refresh screenshots for machine learning rules (#93805) 2023-02-15 15:43:30 -08:00
Lisa Cawley
2c4ef7c26a
[DOCS] Refresh screenshots for transform health rules (#93761) 2023-02-14 10:11:49 -08:00
István Zoltán Szabó
a6f365c51c
[DOCS] Modifies schedule now transform API docs (#93519) 2023-02-08 17:16:59 +01:00
Przemysław Witek
f60401a61c
[Transform] Transform _schedule_now API (#92948) 2023-02-02 19:03:16 +01:00
Przemysław Witek
40d32205db
[Transform] Add from parameter to Transform Start API (#91116) 2023-01-17 10:36:21 +01:00
István Zoltán Szabó
6561c47317
[DOCS] Adds example of better index resolve to transforms at scale (#92234)
Co-authored-by: Przemysław Witek <przemyslaw.witek@elastic.co>
2022-12-12 15:18:49 +01:00
István Zoltán Szabó
e16bee0e72
[DOCS] Adds bullet points to the statuses of the health object in transform stats API docs (#91790) 2022-11-22 15:18:08 +01:00
Hendrik Muhs
82a71f6ef6
[Transform] add a health section to transform stats (#90760)
adds a health section to the transform stats endpoint and implements reporting assignment, indexing/search and persistence problems, together with a overall health state.
2022-10-25 09:01:21 +02:00
István Zoltán Szabó
45646b78e2
[DOCS] Adds missing_bucket setting to transform APIs (#90111) 2022-09-19 15:22:48 +02:00
István Zoltán Szabó
a23c77ceaa
[DOCs] Orders transform API parameters in alphabetical order. (#89746) 2022-08-31 11:42:07 +02:00
István Zoltán Szabó
accf737145
[DOCS] Adds unattended setting to transforms API docs. (#89335) 2022-08-29 11:46:52 +02:00
eltomello
df7ea6afcd
[DOCS] Fix transform painless example syntax (#88364)
Corrects the syntax of an example for a scripted metric aggregation.
2022-07-21 08:05:17 -07:00
Lisa Cawley
4e18993f55
[DOCS] Add authorization info to get and update transform APIs (#87994) 2022-07-04 09:51:59 -07:00
István Zoltán Szabó
f09f2b2617
[DOCS] Fixes collapsible section title in preview transform API docs. (#88161) 2022-06-29 12:28:39 +02:00
István Zoltán Szabó
d48e1a2488
[DOCS] Adds section about how to use ingest timestamp to sync a transform (#87650)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-06-15 15:00:44 +02:00
Przemysław Witek
8656a29675
[Transform] Implement per-transform num_failure_retries setting. (#87361) 2022-06-09 15:22:06 +02:00
István Zoltán Szabó
a71ad6e407
[DOCS] Expands AD and Transform alert docs with info on context for recovered alerts (#87118) 2022-06-02 09:52:47 +02:00
Leaf-Lin
ad0228fd2f
[DOCS] Adding Getting Help section to troubleshooting docs (#87095)
* Adding Getting Help section

Add getting help section in the troubleshooting guide to be pointed by health API when issues are too complicated to be addressed. 

This is taken from https://www.elastic.co/guide/en/cloud/current/ec-get-help.html, someone might want to elaborate it a bit more?

* Fix broken partintro, modify headings, and update wording

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-05-25 15:58:41 -04:00
István Zoltán Szabó
2804ff49b6
[DOCS] Improves warning message in Update transform API docs (#86920)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-05-23 10:10:03 +02:00
Lisa Cawley
adb391bd6d
[DOCS] Edits transform secondary auth header details (#86815) 2022-05-17 07:25:23 -07:00
Benjamin Trent
b90b3450a2
[ML] [Transforms] prefer secondary auth headers for transforms (#86757)
When creating and updating transforms, it is possible for clients to provide secondary headers.

When PUT, _preview, _update is called with secondary authorization headers, those are then used or stored with the transform.

closes: https://github.com/elastic/elasticsearch/issues/86731
2022-05-16 10:13:21 -04:00
Benjamin Trent
88a5da9560
[ML] [Transforms] fix transform _start permissions to use stored headers in the config (#86802)
It was previously required that the _start API caller required the same roles as the create API caller.

This does not make sense as when the transform is actually running (after _start) we rely solely on the roles of the caller who created the transform.

Consequently, this commit does the permission validations and various checks with the roles of user who created the transform, not the one calling _start
2022-05-16 09:10:01 -04:00
István Zoltán Szabó
15ea957df6
[DOCS] Expands transform setup page with info on spaces. (#86479) 2022-05-09 11:14:24 +02:00
István Zoltán Szabó
0c0c97070d
[DOCS] Adds limitation on deprecated painless scripts and edits limitation regarding spaces in Transform docs (#86397)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-05-05 13:31:16 +02:00
Lisa Cawley
dd885e28fa
[DOCS] Add transform limitation for underscore field names (#86195) 2022-04-26 12:44:14 -07:00
Benjamin Trent
463a3bb41e
[ML] fix transform privilege requirements documentation (#85544)
This updates the privileges required when a retention_policy is configured.

See related PR: #85413
2022-03-31 09:41:26 -04:00
Benjamin Trent
5f03cab87e
[ML] correctly validate permissions when retention policy is configured (#85413)
When a transform has a `retention_policy` it needs to be able to delete documents in the destination index. 

`create_index` does not necessitate that we can delete documents from it. So, even if we create the index, we need to verify that we can delete documents given the `retention_policy` definition.

This is not a crucial bug as the transform will simply fail later. Its nicer to fail sooner.

closes https://github.com/elastic/elasticsearch/issues/85409
2022-03-29 07:54:31 -04:00
István Zoltán Szabó
614f089e82
[DOCS] Expands description of the reset transform API (#84270) 2022-02-24 10:01:28 +01:00
István Zoltán Szabó
030d87074b
[DOCS] Adds reference of transform reset option to the tutorial (#84194) 2022-02-23 10:00:44 +01:00
Lisa Cawley
5ae96e5f23
[DOCS] Add read_pipeline privilege to transform setup (#84151) 2022-02-22 07:47:44 -08:00
Lisa Cawley
f871bfc4ae
[DOCS] Clarify transform requirements (#83295) 2022-02-07 16:08:57 -08: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