Skip to content

Commit

Permalink
[DOCS] Adds new transform limitation item and a note to the tutorial (e…
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Oct 26, 2021
1 parent e862470 commit e831b03
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
5 changes: 5 additions & 0 deletions docs/reference/transform/ecommerce-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,11 @@ destination index. In {kib}, if you copied the API request to your
clipboard, paste it into the console, then refer to the `generated_dest_index`
object in the API response.

NOTE: {transforms-cap} might have more configuration options provided by the
APIs than the options available in {kib}. For example, you can set an ingest
pipeline for `dest` by calling the <<put-transform>>. For all the {transform}
configuration options, refer to the <<transform-apis,documentation>>.

.API example
[%collapsible]
====
Expand Down
10 changes: 9 additions & 1 deletion docs/reference/transform/limitations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -294,4 +294,12 @@ nodes have been upgraded to the newer version before using the {transforms} UI.
[[transform-kibana-limitations]]
=== Up to 1,000 {transforms} are listed in {kib}

The {transforms} management page in {kib} lists up to 1000 {transforms}.
The {transforms} management page in {kib} lists up to 1000 {transforms}.

[discrete]
[[transform-ui-support]]
=== {kib} might not support every {transform} configuration option

There might be configuration options available via the {transform} APIs that are
not supported in {kib}. For an exhaustive list of configuration options, refer
to the <<transform-apis,documentation>>.
10 changes: 8 additions & 2 deletions docs/reference/transform/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,14 @@
You can choose either of the following methods to transform your data:
<<pivot-transform-overview,pivot>> or <<latest-transform-overview,latest>>.

IMPORTANT: All {transforms} leave your source index intact. They create a new
index that is dedicated to the transformed data.
[IMPORTANT]
====
* All {transforms} leave your source index intact. They create a new
index that is dedicated to the transformed data.
* {transforms-cap} might have more configuration options provided by the APIs
than the options available in {kib}. For all the {transform} configuration
options, refer to the <<transform-apis,API documentation>>.
====

{transforms-cap} are persistent tasks; they are stored in cluster state which
makes them resilient for node failures. Refer to <<transform-checkpoints>> and
Expand Down

0 comments on commit e831b03

Please sign in to comment.