Skip to content

Commit f13912c

Browse files
authored
[DOCS] Drafts docs for Upgrade Transforms API (#79139)
1 parent c3f12a1 commit f13912c

File tree

2 files changed

+44
-11
lines changed

2 files changed

+44
-11
lines changed

docs/reference/transform/apis/index.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,6 @@ include::preview-transform.asciidoc[leveloffset=+2]
1313
include::start-transform.asciidoc[leveloffset=+2]
1414
//STOP
1515
include::stop-transform.asciidoc[leveloffset=+2]
16-
//UPDATE
17-
include::update-transform.asciidoc[leveloffset=+2]
16+
//UPDATE-UPGRADE
17+
include::update-transform.asciidoc[leveloffset=+2]
18+
include::upgrade-transforms.asciidoc[leveloffset=+2]
Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[upgrade-transforms]]
4-
= Upgrade {transform} API
4+
= Upgrade {transforms} API
55

66
[subs="attributes"]
77
++++
8-
<titleabbrev>Upgrade {transform}</titleabbrev>
8+
<titleabbrev>Upgrade {transforms}</titleabbrev>
99
++++
1010

11-
Upgrades all {transform}s.
11+
Upgrades all {transforms}.
1212

1313
[[upgrade-transforms-request]]
1414
== {api-request-title}
@@ -22,36 +22,68 @@ Requires the following privileges:
2222

2323
* cluster: `manage_transform` (the `transform_admin` built-in role grants this
2424
privilege)
25-
* source indices: `read`, `view_index_metadata`
26-
* destination index: `read`, `index`.
2725

2826

2927
[[upgrade-transforms-desc]]
3028
== {api-description-title}
3129

32-
This API upgrades all existing {transform}s.
30+
{transforms-cap} are compatible across minor versions and between supported
31+
major versions. However, over time, the format of {transform} configuration
32+
information may change. This API identifies {transforms} which have a legacy
33+
configuration format and upgrades them to the latest version; including clean up
34+
of the internal data structures that store {transform} state and checkpoints.
35+
{transform-cap} upgrade does not effect the source and destination indices.
36+
37+
If a {transform} upgrade step fails, the upgrade stops, and an error is returned
38+
about the underlying issue. Resolve the issue then re-run the process again. A
39+
summary is returned when the upgrade is finished.
40+
41+
For a major version update – for example, from 7.16 to 8.0 –, it is recommended
42+
to have a recent cluster backup prior to performing a {transform} upgrade which
43+
can be run either before or after an {es} upgrade. However, it is recommended to
44+
perform it before upgrading {es} to the next major version to ensure
45+
{ctransforms} remain running.
46+
47+
48+
[IMPORTANT]
49+
====
50+
51+
* When {es} {security-features} are enabled, your {transform} remembers the
52+
roles of the user who created or updated it last. In contrast to
53+
<<update-transform,update transform>>, a {transform} upgrade does not change the
54+
stored roles, therefore the role used to read source data and write to the
55+
destination index remains unchanged.
56+
57+
====
58+
3359

3460
[[upgrade-transforms-query-parms]]
3561
== {api-query-parms-title}
3662

3763
`dry_run`::
38-
(Optional, Boolean) When `true`, only checks for updates but does not execute them.
64+
(Optional, Boolean) When `true`, only checks for updates but does not execute
65+
them. Defaults to `false`.
66+
3967

4068
[[upgrade-transforms-example]]
4169
== {api-examples-title}
4270

71+
To upgrade the legacy {transforms} to the latest configuration format, perform
72+
the following API call:
73+
4374
[source,console]
4475
--------------------------------------------------
4576
POST _transform/_upgrade
4677
--------------------------------------------------
4778
// TEST[setup:simple_kibana_continuous_pivot]
4879

49-
When all {transform}s are upgraded, you receive a summary:
80+
When all {transforms} are upgraded, you receive a summary:
5081

5182
[source,console-result]
5283
----
5384
{
85+
"updated": 2,
5486
"no_action": 1
5587
}
5688
----
57-
// TESTRESPONSE[s/"no_action" : 1/"no_action" : $body.no_action/]
89+
// TESTRESPONSE[skip:TBD]

0 commit comments

Comments
 (0)