Skip to content

Commit

Permalink
Add deprecation warning to Changelog and documentation for `setup.tem…
Browse files Browse the repository at this point in the history
…plate.type` (#28618)
  • Loading branch information
kvch authored Oct 25, 2021
1 parent 43897fe commit 6d1909c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,7 @@ for a few releases. Please use other tools provided by Elastic to fetch data fro

*Affecting all Beats*

- Deprecate `setup.template.type`. In the future Beats will load data streams instead of regular indices.

*Filebeat*

Expand Down
8 changes: 6 additions & 2 deletions libbeat/docs/howto/load-index-templates.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ lifecycle policy used to manage indices as they grow and age.

The recommended index template file for {beatname_uc} is installed by the
{beatname_uc} packages. If you accept the default configuration in the
+{beatname_lc}.yml+ config file, {beatname_uc} loads the template automatically
+{beatname_lc}.yml+ config file, {beatname_uc} loads the {ref}/index-templates.html[composable template] automatically
after successfully connecting to {es}. If the template already exists,
it's not overwritten unless you configure {beatname_uc} to do so.

Expand All @@ -33,7 +33,7 @@ For a full list of template setup options, see <<configuration-template>>.
[[load-custom-template]]
=== Load your own index template

To load your own index template, set the following options:
To load your own composable index template, set the following options:

[source,yaml]
-----
Expand All @@ -44,6 +44,10 @@ setup.template.fields: "path/to/fields.yml"
If the template already exists, it’s not overwritten unless you configure
{beatname_uc} to do so.

If your template is still in the legacy format, please set `setup.template.type` to
`legacy`. Please, convert your index template to the composable format, because
in the future support for legacy templates is going to be removed.

[float]
[[overwrite-template]]
=== Overwrite an existing index template
Expand Down
10 changes: 6 additions & 4 deletions libbeat/docs/template-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ existing one.
you must <<load-template-manually,load the template manually>>.

ifndef::apm-server[]
*`setup.template.type`*:: The type of template to use. Available options: `legacy` (default), index templates
before Elasticsearch v7.8. Use this to avoid breaking existing deployments. New options are `component`
and `index`. Selecting `component` loads a component template which can be included in new index templates.
The option `index` loads the new index template.
*`setup.template.type`*:: Deprecated in 7.16. The type of template to use. The default value is `index`,
that loads {ref}/index-templates.html[index templates].
Further options: `legacy`, {ref}/indices-templates-v1.html[legacy index templates] before Elasticsearch v7.8.
Use this to avoid breaking existing deployments.
And `component`, selecting it loads a component template which can be included in index templates.
The option `index` loads the new composable index template.
endif::[]

*`setup.template.name`*:: The name of the template. The default is
Expand Down

0 comments on commit 6d1909c

Please sign in to comment.