Skip to content

Commit b3fc44d

Browse files
Add restrictions for synthetic _source (#1622) (#1640)
* Add restrictions for synthetic * Fixes for Martijn's review * Remove note about synthetic _source not supported on TSDS (cherry picked from commit 42b052f) Co-authored-by: David Kilfoyle <[email protected]>
1 parent 98c2a41 commit b3fc44d

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

docs/en/ingest-management/data-streams.asciidoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -937,6 +937,7 @@ Refer to <<data-streams-pipelines>> to learn more.
937937
* link:{ref}/mapping-source-field.html#synthetic-source[Synthetic `_source`]
938938

939939
These features can be enabled and disabled for {fleet}-managed data streams by using the index template API and a few key settings.
940+
Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license.
940941

941942
NOTE: If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in <<data-streams-ilm-tutorial,Tutorial: Customize data retention policies>>), exercise care to ensure you don't overwrite your customizations when making these requests.
942943

@@ -1098,16 +1099,18 @@ For example, the following payload disables TSDS on `nginx.stubstatus`:
10981099
[source,json]
10991100
----
11001101
PUT _component_template/<NAME>@custom
1101-
11021102
{
1103-
"template": {
1104-
"mappings": {
1105-
"_source": {
1106-
"mode": "synthetic"
1103+
"settings": {
1104+
"index": {
1105+
"mapping": {
1106+
"source": {
1107+
"mode": "synthetic"
1108+
}
11071109
}
11081110
}
11091111
}
11101112
}
1113+
11111114
----
11121115

11131116
[discrete]
@@ -1117,11 +1120,12 @@ PUT _component_template/<NAME>@custom
11171120
[source,json]
11181121
----
11191122
PUT _component_template/<NAME>@custom
1120-
11211123
{
1122-
"template": {
1123-
"mappings": {
1124-
"_source": {}
1124+
"settings": {
1125+
"index": {
1126+
"mapping": {
1127+
"source": {"mode": "stored"}
1128+
}
11251129
}
11261130
}
11271131
}

0 commit comments

Comments
 (0)