Skip to content

[DOCS] Drafts docs for Upgrade Transforms API #79139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 19, 2021
Merged

[DOCS] Drafts docs for Upgrade Transforms API #79139

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2593e5d
[DOCS] Adds docs for Upgrade Transforms API.
szabosteve Oct 14, 2021
fce1ec4
[DOCS] Fine-tunes content.
szabosteve Oct 14, 2021
2b71806
[DOCS] Addresses feedback.
szabosteve Oct 14, 2021
f453ef5
[DOCS] Clarifies permission info.
szabosteve Oct 15, 2021
0af729d
[DOCS] Rephrase description.
szabosteve Oct 18, 2021
7e5b3f5
[DOCS] Fine-tunes description.
szabosteve Oct 18, 2021
404fd2b
[DOCS] Updates description and example response.
szabosteve Oct 19, 2021
7dbbfef
[DOCS] Amends response test.
szabosteve Oct 19, 2021
1e51377
[DOCS] Fixes response.
szabosteve Oct 19, 2021
4d45871
[DOCS] Skips testing response.
szabosteve Oct 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/reference/transform/apis/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ include::preview-transform.asciidoc[leveloffset=+2]
include::start-transform.asciidoc[leveloffset=+2]
//STOP
include::stop-transform.asciidoc[leveloffset=+2]
//UPDATE
include::update-transform.asciidoc[leveloffset=+2]
//UPDATE-UPGRADE
include::update-transform.asciidoc[leveloffset=+2]
include::upgrade-transforms.asciidoc[leveloffset=+2]
25 changes: 19 additions & 6 deletions docs/reference/transform/apis/upgrade-transforms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[role="xpack"]
[testenv="basic"]
[[upgrade-transforms]]
= Upgrade {transform} API
= Upgrade {transforms} API

[subs="attributes"]
++++
<titleabbrev>Upgrade {transform}</titleabbrev>
<titleabbrev>Upgrade {transforms}</titleabbrev>
++++

Upgrades all {transform}s.
Upgrades all {transforms}.

[[upgrade-transforms-request]]
== {api-request-title}
Expand All @@ -29,24 +29,37 @@ Requires the following privileges:
[[upgrade-transforms-desc]]
== {api-description-title}

This API upgrades all existing {transform}s.
This API upgrades all existing {transforms} that are necessary to be upgraded.
The {transforms} are rewritten into the latest format including internal data
structures that store state and checkpoints. Resources are also freed up by
cleaning up previous versions.

If an upgrade step fails, the upgrade stops, and an error is returned that
informs about the underlying issues. It might be necessary to manually resolve
the problems then the process can be re-run again. A summary is returned when
the upgrade is finished.


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

`dry_run`::
(Optional, Boolean) When `true`, only checks for updates but does not execute them.
(Optional, Boolean) When `true`, only checks for updates but does not execute
them. Defaults to `false`.


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

To upgrade the {transforms}, perform the following API call:

[source,console]
--------------------------------------------------
POST _transform/_upgrade
--------------------------------------------------
// TEST[setup:simple_kibana_continuous_pivot]

When all {transform}s are upgraded, you receive a summary:
When all {transforms} are upgraded, you receive a summary:

[source,console-result]
----
Expand Down