Skip to content
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.

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

[DOCS] Add transform breaking changes #79531

Merged
merged 7 commits into from
Oct 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/reference/migration/migrate_8_0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ coming[8.0.0]
* <<breaking_80_settings_changes>>
* <<breaking_80_snapshots_changes>>
* <<breaking_80_threadpool_changes>>
* <<breaking_80_transform_changes>>
* <<breaking_80_transport_changes>>
* <<breaking_80_watcher_changes>>

Expand Down Expand Up @@ -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[]
Expand Down
21 changes: 21 additions & 0 deletions docs/reference/migration/migrate_8_0/transform.asciidoc
Original file line number Diff line number Diff line change
@@ -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[]
2 changes: 1 addition & 1 deletion docs/reference/transform/apis/upgrade-transforms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down