Skip to content

Commit 9aa6dc8

Browse files
szabostevelcawl
andauthored
[DOCS] Expands transforms docs with CCS info (elastic#70156) (elastic#70242)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
1 parent 4675711 commit 9aa6dc8

File tree

3 files changed

+30
-15
lines changed

3 files changed

+30
-15
lines changed

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -936,8 +936,12 @@ end::source-transforms[]
936936
tag::source-index-transforms[]
937937
The _source indices_ for the {transform}. It can be a single index, an index
938938
pattern (for example, `"my-index-*"`), an array of indices (for example,
939-
`["my-index-000001", "my-index-000002"]`), or an array of index patterns (for example,
940-
`["my-index-*", "my-other-index-*"]`.
939+
`["my-index-000001", "my-index-000002"]`), or an array of index patterns (for
940+
example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax
941+
`"remote_name:index_name"`.
942+
943+
NOTE: If any indices are in remote clusters then the master node and at least
944+
one transform node must have the `remote_cluster_client` node role.
941945
end::source-index-transforms[]
942946

943947
tag::source-query-transforms[]
@@ -946,7 +950,9 @@ A query clause that retrieves a subset of data from the source index. See
946950
end::source-query-transforms[]
947951

948952
tag::source-runtime-mappings-transforms[]
949-
Definitions of search-time runtime fields that can be used by the transform.
953+
Definitions of search-time runtime fields that can be used by the transform. For
954+
search runtime fields all data nodes, including remote nodes, must be 7.12 or
955+
later.
950956
end::source-runtime-mappings-transforms[]
951957

952958
tag::state-transform[]

docs/reference/transform/apis/put-transform.asciidoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,17 @@ structure (known as a {dataframe}). The ID for each document in the {dataframe}
4444
is generated from a hash of the entity, so there is a unique row per entity. For
4545
more information, see <<transforms>>.
4646

47-
When the {transform} is created, a series of validations occur to
48-
ensure its success. For example, there is a check for the existence of the
49-
source indices and a check that the destination index is not part of the source
50-
index pattern. You can use the `defer_validation` parameter to skip these
51-
checks.
52-
53-
Deferred validations are always run when the {transform} is started,
54-
with the exception of privilege checks. When {es} {security-features} are
55-
enabled, the {transform} remembers which roles the user that created
56-
it had at the time of creation and uses those same roles. If those roles do not
57-
have the required privileges on the source and destination indices, the
58-
{transform} fails when it attempts unauthorized operations.
47+
When the {transform} is created, a series of validations occur to ensure its
48+
success. For example, there is a check for the existence of the source indices
49+
and a check that the destination index is not part of the source index pattern.
50+
You can use the `defer_validation` parameter to skip these checks.
51+
52+
Deferred validations are always run when the {transform} is started, with the
53+
exception of privilege checks. When {es} {security-features} are enabled, the
54+
{transform} remembers which roles the user that created it had at the time of
55+
creation and uses those same roles. If those roles do not have the required
56+
privileges on the source and destination indices, the {transform} fails when it
57+
attempts unauthorized operations.
5958

6059
IMPORTANT: You must use {kib} or this API to create a {transform}. Do not put a
6160
{transform} directly into any `.transform-internal*` indices using the {es}

docs/reference/transform/limitations.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,3 +275,13 @@ accessed. If the time field is a {ref}/runtime.html[runtime field], the
275275
performance impact of calculating field values at query time can significantly
276276
slow the {transform}. Use an indexed field as a time field when using
277277
{transforms}.
278+
279+
280+
[discrete]
281+
[[transforms-ccs-limitation]]
282+
=== {transforms-cap} support {ccs} if the remote cluster is configured properly
283+
284+
If you use <<modules-cross-cluster-search,{ccs}>>, the remote cluster must
285+
support the search and aggregations you use in your {transforms}.
286+
{transforms-cap} validate their configuration; if you use {ccs} and the validation fails,
287+
make sure that the remote cluster supports the query and aggregations you use.

0 commit comments

Comments
 (0)