浏览代码

[DOCS] Update index template API docs for data stream aliases (#75688)

With #73867, you can use component and index templates to add data stream
aliases.
James Rodewig 4 年之前
父节点
当前提交
6078349106

+ 1 - 1
docs/reference/indices/create-index.asciidoc

@@ -77,7 +77,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
 .Properties of `aliases` objects
 =======
 `<alias>`::
-(Required, object) The key is the alias name. Supports
+(Required, object) The key is the alias name. Index alias names support
 <<date-math-index-names,date math>>.
 +
 The object body contains options for the alias. Supports an empty object.

+ 3 - 2
docs/reference/indices/put-component-template.asciidoc

@@ -132,8 +132,9 @@ This is the template to be applied, may optionally include a `mappings`,
 [%collapsible%open]
 ====
 `aliases`::
-(Optional, object of objects) Aliases for the index. If an index template
-includes `data_stream`, this parameter is not supported.
+(Optional, object of objects) Aliases to add.
++
+include::{es-repo-dir}/indices/put-index-template.asciidoc[tag=template-ds-alias]
 +
 include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props]
 

+ 7 - 2
docs/reference/indices/put-index-template.asciidoc

@@ -137,8 +137,13 @@ Template to be applied. It may optionally include an `aliases`, `mappings`, or
 [%collapsible%open]
 ====
 `aliases`::
-(Optional, object of objects) Aliases for the index. If the index template
-includes `data_stream`, this parameter is not supported.
+(Optional, object of objects) Aliases to add.
++
+// tag::template-ds-alias[]
+If the index template includes a `data_stream` object, these are data stream
+aliases. Otherwise, these are index aliases. Data stream aliases ignore the
+`index_routing`, `routing`, and `search_routing` options.
+// end::template-ds-alias[]
 +
 include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props]