Skip to content

Commit

Permalink
Add setting and component templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Apr 2, 2021
1 parent 41604f3 commit dfb987a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/reference/indices/put-component-template.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,29 @@ except before the opening curly bracket.
`<component-template>`::
(Required, string)
Name of the component template to create.

+
[IMPORTANT]
====
{es} includes the following built-in component templates:
// tag::built-in-component-templates[]
- `logs-mappings`
- `logs-settings`
- `metrics-mappings`
- `metrics-settings`
- `synthetics-mapping`
- `synthetics-settings`
// end::built-in-component-templates[]
The {fleet-guide}/fleet-overview.html[{agent}] uses these templates to configure
backing indices for its data streams. If you use {agent} and want to overwrite
one of these templates, set the `version` for your replacement template higher
than the current version.
If you don't use {agent} and want to disable all built-in component and index
templates, set <<stack-templates-enabled,`stack.templates.enabled`>> to `false`
in <<config-files-location,`elasticsearch.yml`>>.
====

[[put-component-template-api-query-params]]
==== {api-query-parms-title}
Expand Down
19 changes: 19 additions & 0 deletions docs/reference/modules/indices/index_management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,22 @@ IMPORTANT: Closed indices are a data loss risk because they are not included whe
(<<static-cluster-setting,Static>>)
Specifies the hosts that can be <<reindex-from-remote,reindexed from remotely>>. Expects a YAML array of `host:port` strings. Consists of a comma-delimited list of `host:port` entries. Defaults to `["\*.io:*", "\*.com:*"]`.
// end::reindex-remote-whitelist[]

[[stack-templates-enabled]]
`stack.templates.enabled` {ess-icon}::
+
--
(<<static-cluster-setting,Static>>)
If `true`, enables built-in index and component templates. The
{fleet-guide}/fleet-overview.html[{agent}] uses these templates to create data
streams. If `false`, {es} disables these index and component templates. Defaults
to `true`.

This setting affects the following built-in index templates:

include::{es-repo-dir}/indices/index-templates.asciidoc[tag=built-in-index-template-patterns]

This setting also affects the following built-in component templates:

include::{es-repo-dir}/indices/put-component-template.asciidoc[tag=built-in-component-templates]
--

0 comments on commit dfb987a

Please sign in to comment.