From c10bf9be848cd78951021e0de5e698a6afcf527c Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 25 Oct 2021 08:08:18 -0700 Subject: [PATCH] [DOCS] Add transform breaking changes (#79531) --- docs/reference/migration/migrate_8_0.asciidoc | 2 ++ .../migration/migrate_8_0/transform.asciidoc | 21 +++++++++++++++++++ .../apis/upgrade-transforms.asciidoc | 2 +- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/reference/migration/migrate_8_0/transform.asciidoc diff --git a/docs/reference/migration/migrate_8_0.asciidoc b/docs/reference/migration/migrate_8_0.asciidoc index 4c22a66c71883..9a31e82f5d537 100644 --- a/docs/reference/migration/migrate_8_0.asciidoc +++ b/docs/reference/migration/migrate_8_0.asciidoc @@ -38,6 +38,7 @@ coming[8.0.0] * <> * <> * <> +* <> * <> * <> @@ -141,6 +142,7 @@ include::migrate_8_0/security.asciidoc[] include::migrate_8_0/settings.asciidoc[] include::migrate_8_0/snapshots.asciidoc[] include::migrate_8_0/threadpool.asciidoc[] +include::migrate_8_0/transform.asciidoc[] include::migrate_8_0/transport.asciidoc[] include::migrate_8_0/watcher.asciidoc[] include::migrate_8_0/migrate_to_java_time.asciidoc[] diff --git a/docs/reference/migration/migrate_8_0/transform.asciidoc b/docs/reference/migration/migrate_8_0/transform.asciidoc new file mode 100644 index 0000000000000..690b175fabf10 --- /dev/null +++ b/docs/reference/migration/migrate_8_0/transform.asciidoc @@ -0,0 +1,21 @@ +[discrete] +[[breaking_80_transform_changes]] +==== Transform changes + +//NOTE: The notable-breaking-changes tagged regions are re-used in the +//Installation and Upgrade Guide + +//tag::notable-breaking-changes[] +.{transforms-cap} created in 7.4 or earlier versions must be upgraded +[%collapsible] +==== +*Details* + +Early beta versions of {transforms} had configuration information in a format +that is no longer supported. + + +*Impact* + +Use the {ref}/upgrade-transforms.html[upgrade {transforms} API] to fix your +{transforms}. This upgrade does not affect the source or destination indices. +==== +// end::notable-breaking-changes[] diff --git a/docs/reference/transform/apis/upgrade-transforms.asciidoc b/docs/reference/transform/apis/upgrade-transforms.asciidoc index b813c47ca2c36..8daf3768466d2 100644 --- a/docs/reference/transform/apis/upgrade-transforms.asciidoc +++ b/docs/reference/transform/apis/upgrade-transforms.asciidoc @@ -32,7 +32,7 @@ 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 effect the source and destination indices. +{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