[DOCS] Drafts docs for Upgrade Transforms API #79139
Conversation
elasticmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/ml-core (Team:ML) |
|
@hendrikmuhs I rephrased the API description via 0af729d. Please have a look at it when the time permits to check whether I tweaked the text in a way that does not convey precisely the same meaning that you wanted anymore. Thanks in advance! |
| {transform-cap} upgrade does not effect the source and destination indices. | ||
|
|
||
| It is recommended to have a recent cluster backup prior to performing a | ||
| {transform} upgrade which can be run either before or after an {es} upgrade. |
There was a problem hiding this comment.
I am not 100% sold regarding this statement. It is not required to make a full cluster backup prior to running this API. We want users to run upgrades often, this statement will keep them from doing so, which is the opposite of what we are aiming for.
There was a problem hiding this comment.
I suggest we add a heading "Major version upgrade" and put this content in there. The 1st sentence could start with: "For a major version upgrade, for example 7.16 to 8.0, it is recommended...".
The paragraph "If a transform upgrade step fail ..." should be moved before "Major version upgrade".
There was a problem hiding this comment.
@hendrikmuhs I switched the order of the second and the third paragraph and changed the first sentence to: "For a major version update – for example, from 7.16 to 8.0 –, it is recommended to...". This way we highlight that the cluster backup is only recommended in case of major version updates. However, I don't think it's necessary to add a separate heading inside the API description to segment it further. (via 404fd2b)
Overview
This PR adds documentation about the Upgrade Transforms API to the Transforms API docs section.
Preview
Upgrade transforms API