github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 15:17:30 -04:00
Code Issues Projects Releases Packages Wiki Activity

[ML] Update documentation regarding versioning. (#98320)

Browse source 
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>
This commit is contained in:
Ed Savage 2023-08-10 11:20:58 +01:00 • committed by GitHub
parent 693ab3dee8
commit 3682a88199
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 73 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/reference/transform/apis/get-transform.asciidoc
View file

@ -24,7 +24,7 @@ Retrieves configuration information for {transforms}.
[[get-transform-prereqs]]
== {api-prereq-title}
Requires the `monitor_transform` cluster privilege. This privilege is included
Requires the `monitor_transform` cluster privilege. This privilege is included
in the `transform_user` built-in role.
[[get-transform-desc]]
@ -77,8 +77,12 @@ value in ascending order. For the full list of properties, see
This property is informational; you cannot change its value.
`version`::
(string) The version of {es} that existed on the node when the {transform} was
created.
(string) The {transform} configuration version number at which the trained model was created.
NOTE: From {es} 8.10.0, a new version number is used to
track the configuration and state changes in the {transform} plugin. This new
version number is decoupled from the product version and will increment
independently. The `version` value represents the new version number.
[[get-transform-response-codes]]
== {api-response-codes-title}

39
docs/reference/transform/apis/upgrade-transforms.asciidoc
View file

@ -26,30 +26,35 @@ Requires the following privileges:
[[upgrade-transforms-desc]]
== {api-description-title}
{transforms-cap} are compatible across minor versions and between supported
major versions. However, over time, the format of {transform} configuration
information may change. This API identifies {transforms} which have a legacy
configuration format and upgrades them to the latest version; including clean up
of the internal data structures that store {transform} state and checkpoints.
{transforms-cap} are compatible across minor versions and between supported
major versions. However, over time, the format of {transform} configuration
information may change. This API identifies {transforms} which have a legacy
configuration format and upgrades them to the latest version; including clean up
of the internal data structures that store {transform} state and checkpoints.
{transform-cap} upgrade does not affect the source and destination indices.
If a {transform} upgrade step fails, the upgrade stops, and an error is returned
about the underlying issue. Resolve the issue then re-run the process again. A
NOTE: From {es} 8.10.0, a new version number is used to
track the configuration and state changes in the {transform} plugin. This new
version number is decoupled from the product version and will increment
independently.
If a {transform} upgrade step fails, the upgrade stops, and an error is returned
about the underlying issue. Resolve the issue then re-run the process again. A
summary is returned when the upgrade is finished.
To ensure {ctransforms} remain running during a major version upgrade of the
cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade
{transforms} before upgrading the cluster. You may want to perform a recent
To ensure {ctransforms} remain running during a major version upgrade of the
cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade
{transforms} before upgrading the cluster. You may want to perform a recent
cluster backup prior to the upgrade.
[IMPORTANT]
====
* When {es} {security-features} are enabled, your {transform} remembers the
roles of the user who created or updated it last. In contrast to
<<update-transform,update transform>>, a {transform} upgrade does not change the
stored roles, therefore the role used to read source data and write to the
* When {es} {security-features} are enabled, your {transform} remembers the
roles of the user who created or updated it last. In contrast to
<<update-transform,update transform>>, a {transform} upgrade does not change the
stored roles, therefore the role used to read source data and write to the
destination index remains unchanged.
====
@ -59,7 +64,7 @@ destination index remains unchanged.
== {api-query-parms-title}
`dry_run`::
(Optional, Boolean) When `true`, only checks for updates but does not execute
(Optional, Boolean) When `true`, only checks for updates but does not execute
them. Defaults to `false`.
`timeout`::
@ -77,7 +82,7 @@ expires, the request fails and returns an error. Defaults to `30s`.
`no_action`::
(integer) The number of {transforms} that don't require upgrading.
`updated`::
`updated`::
(integer) The number of {transforms} that have been upgraded.
@ -85,7 +90,7 @@ expires, the request fails and returns an error. Defaults to `30s`.
[[upgrade-transforms-example]]
== {api-examples-title}
To upgrade the legacy {transforms} to the latest configuration format, perform
To upgrade the legacy {transforms} to the latest configuration format, perform
the following API call:
[source,console]