Commit Graph

84 Commits

Author SHA1 Message Date
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
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
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
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ó 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
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ó 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
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
Przemysław Witek 7be74a8046
Introduce `deduce_mappings` transform setting (#82256) 2022-01-18 09:01:23 +01:00
Lisa Cawley 4ed6e8ad3c
[DOCS] Adds missing timeout parameter to transform APIs (#81129) 2021-12-02 13:28:28 -08:00
Lisa Cawley 8ab03d021c
[DOCS] Edits reset transforms API (#81027) 2021-11-25 08:40:50 -08:00
Przemysław Witek 9b058da548
[Transform] Transform Reset API (#79828) 2021-11-09 10:21:57 +01:00
James Rodewig f56a0f4b66
[DOCS] Remove `testenv` annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00
Lisa Cawley c10bf9be84
[DOCS] Add transform breaking changes (#79531) 2021-10-25 08:08:18 -07:00
István Zoltán Szabó 8c262f0edf
[DOCS] Updates transforms upgrade API docs (#79608) 2021-10-21 19:03:01 +02:00
István Zoltán Szabó f13912c1b3
[DOCS] Drafts docs for Upgrade Transforms API (#79139) 2021-10-19 16:03:54 +02:00
Przemysław Witek 1595d3a20f
[Transform] Add _meta field to TransformConfig (#79003) 2021-10-15 08:12:03 +02:00
Hendrik Muhs 939f81e557
[Transform] add transform upgrade endpoint (#77566)
Add an _upgrade endpoint to bulk upgrade transforms. _upgrade rewrites all transforms and its
artifacts into the latest format to the latest storage(index). If all transforms are upgraded old
indices and outdated documents get deleted. Using the dry_run option it is possible to check if
upgrades are necessary without applying changes.
2021-10-13 08:49:45 +02:00
Lisa Cawley 1575d34822
[DOCS] Fix formatting (#77567)
This PR fixes a missing backtick.
2021-09-10 09:33:32 -07:00
Przemysław Witek 676d4de3de
[Transform] Implement the ability to preview the existing transform (#76697) 2021-08-24 14:41:49 +02:00
Przemysław Witek ec07e4213e
[Transform] Rename interim_results to align_checkpoints (#76609) 2021-08-18 13:58:50 +02:00
Lisa Cawley 5273011f98
[DOCS] Update transforms tutorial with index mapping details (#73395) 2021-06-02 13:45:01 -07:00
István Zoltán Szabó 090690d17a
[DOCS] Revises required privileges info in Transforms API docs (#72803) 2021-05-06 15:19:28 +02:00
Lisa Cawley 0074ba6d5a
[DOCS] Clarify update transform API (#72427) 2021-04-29 07:57:58 -07:00
James Rodewig 693807a6d3
[DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
James Rodewig 5c75d004fa
[DOCS] Replace `put` with `create or update` in API names (#70330)
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-15 14:49:44 -04:00
James Rodewig 010a973018
[DOCS] Refactor ingest pipeline docs (#70253) 2021-03-15 12:22:57 -04:00
István Zoltán Szabó a3fdaceeb1
[DOCS] Expands transforms docs with CCS info (#70156)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2021-03-10 15:54:31 +01:00
István Zoltán Szabó 300031b247
[DOCS] Removes beta from latest Transform docs. (#69964) 2021-03-04 16:36:47 +01:00
István Zoltán Szabó 4443cb2f0e
[DOCS] Adds retention_policy to PUT Transform API docs (#68656)
Co-authored-by: lcawl <lcawley@elastic.co>
2021-02-09 08:00:47 +01:00
Hendrik Muhs 54ed2e37d9
[Transform] implement retention policy to delete data from a transform (#67832)
add a retention policy to transform to delete data that is considered outdated as part of a
transform checkpoint.

fixes #67916
2021-02-08 15:06:15 +01:00
Hendrik Muhs cf08c0e6ab
[Transform] refactor cat transform to show more useful information (#68232)
Refactoring of cat transform to show more relevant information. The current cat transform shows a
lot of configuration details, however cat should show operationally useful information. This PR
changes the defaults and also adds when transform did a search last.
2021-02-02 07:29:20 +01:00