1
1
[role="xpack"]
2
2
[testenv="basic"]
3
3
[[upgrade-transforms]]
4
- = Upgrade {transform } API
4
+ = Upgrade {transforms } API
5
5
6
6
[subs="attributes"]
7
7
++++
8
- <titleabbrev>Upgrade {transform }</titleabbrev>
8
+ <titleabbrev>Upgrade {transforms }</titleabbrev>
9
9
++++
10
10
11
- Upgrades all {transform}s .
11
+ Upgrades all {transforms} .
12
12
13
13
[[upgrade-transforms-request]]
14
14
== {api-request-title}
@@ -22,36 +22,68 @@ Requires the following privileges:
22
22
23
23
* cluster: `manage_transform` (the `transform_admin` built-in role grants this
24
24
privilege)
25
- * source indices: `read`, `view_index_metadata`
26
- * destination index: `read`, `index`.
27
25
28
26
29
27
[[upgrade-transforms-desc]]
30
28
== {api-description-title}
31
29
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
+
33
59
34
60
[[upgrade-transforms-query-parms]]
35
61
== {api-query-parms-title}
36
62
37
63
`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
+
39
67
40
68
[[upgrade-transforms-example]]
41
69
== {api-examples-title}
42
70
71
+ To upgrade the legacy {transforms} to the latest configuration format, perform
72
+ the following API call:
73
+
43
74
[source,console]
44
75
--------------------------------------------------
45
76
POST _transform/_upgrade
46
77
--------------------------------------------------
47
78
// TEST[setup:simple_kibana_continuous_pivot]
48
79
49
- When all {transform}s are upgraded, you receive a summary:
80
+ When all {transforms} are upgraded, you receive a summary:
50
81
51
82
[source,console-result]
52
83
----
53
84
{
85
+ "updated": 2,
54
86
"no_action": 1
55
87
}
56
88
----
57
- // TESTRESPONSE[s/"no_action" : 1/"no_action" : $body.no_action/ ]
89
+ // TESTRESPONSE[skip:TBD ]
0 commit comments