Commit Graph

30 Commits

Author SHA1 Message Date
James Rodewig cb943dbe9b
[DOCS] Reuse index template body params in simulate template API (#73177)
Changes:

* Reuses and reorders the index template API's body parameters in the simulate template API docs.
* Replaces several includes with a shorter xref.
* Reformats a sidebar on naming collisions with built-in index templates.
2021-05-20 12:21:20 -04:00
James Rodewig d3c56e6fca [DOCS] Remove unneeded articles for Elasticsearch Service and Elastic Agent 2021-04-02 16:01:59 -04:00
James Rodewig f41320616c
[DOCS] Refactor data stream setup tutorial (#71074) 2021-03-31 17:28:55 -04:00
James Rodewig 955df4337b
[DOCS] Fix typos for Elasticsearch Service and Elastic Agent (#71076) 2021-03-31 08:36:21 -04:00
James Rodewig d58ab817a2
[DOCS] Fix sidebar for built-in index patterns (#70788) 2021-03-23 20:18:33 -04:00
Adam Locke f2cd547364
[DOCS] Removing wildcard from DELETE index template request (#70418) 2021-03-15 13:44:24 -04:00
Adam Locke ebeb0a9d4c
[DOCS] Add runtime fields to index templates (#70172)
* [DOCS] Add runtime fields to index templates

* Apply suggestions from code review

Co-authored-by: debadair <debadair@elastic.co>

* Deemphasize runtime fields and Kibana.

* Remove duplicate timestamp from component template.

Co-authored-by: debadair <debadair@elastic.co>
2021-03-15 11:50:10 -04:00
James Rodewig 9b88ae92e6
[DOCS] Fix typos for duplicate words (#69125) 2021-02-17 10:34:20 -05:00
James Rodewig 14ea0072e9
[DOCS] Update priority recommendation for index templates (#69006) 2021-02-16 10:53:28 -05:00
James Rodewig 4a2a97a058
[DOCS] Document the `stack.templates.enabled` setting (#68328) 2021-02-02 08:35:21 -05:00
James Rodewig ebf08c0c83
[DOCS] Reuse built-in index templates admon (#68314) 2021-02-01 12:34:21 -05:00
James Rodewig da0188fb45
[DOCS] Fix Fleet links (#66553) (#66557) 2020-12-17 15:27:15 -05:00
DeDe Morton fb53dc3167
Fix links to Fleet overview (#65174) 2020-11-18 10:26:04 -08:00
Lee Hinman d21ddb57a3
Add "synthetics-*-*" templates for synthetics fleet data (#62193)
* Add "synthetics-*-*" templates for synthetics fleet data

For the Elastic Agent we currently have `logs` and `metrics`, however, synthetic data doesn't belong
with those and thus we should have a place for it to live. This would be data reported from
heartbeat and under the 'monitoring' category.

This commit adds a composable index template for `synthetics-*-*` indices similar to the work in
 #56709 and #57629.

Resolves #61665
2020-09-14 16:37:21 -06:00
James Rodewig a405002b39
[DOCS] Update admon for built-in templates (#61549) (#61559) 2020-08-26 08:10:49 -04:00
James Rodewig cd6304ae6b
[DOCS] Add admon for built-in index templates (#61063)
Adds an important admonition for the built-in `metrics-*-*` and `logs-*-*` index
templates.

Updates several put index template snippets to include a priority.
2020-08-17 11:37:08 -04:00
debadair db0adfd2b8
[DOCS] Refactored index-templates topic. (#59737)
* [DOCS] Refactored index-templates topic.

* [DOCS] Add separate files.

* [DOCS] Add delete component template.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* [DOCS] Incorporated review comments
2020-07-23 19:02:11 -07:00
Julie Tibshirani 0e15cc588d
Expand docs for component template merging. (#59466)
This change clarifies the order in which components are merged. It also adds
information on mapping merging, now that this has been implemented.
2020-07-14 11:07:26 -07:00
James Rodewig 1e8970985d
[DOCS] Add data streams to index template API docs (#59462) 2020-07-14 11:49:24 -04:00
Andrei Dan 5609353c5d
Default to @timestamp in composable template datastream definition (#59317)
This makes the data_stream timestamp field specification optional when
defining a composable template.
When there isn't one specified it will default to `@timestamp`.
2020-07-14 11:45:48 +01:00
debadair 07fda012a3
[DOCS] Add simulate ref (#58579)
* [DOCS] Add simulate ref pages

* Add links & experimental tags

* Fixed simulate index response

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

*Incorporate review feedback.
2020-07-02 18:47:24 -07:00
debadair 181b1a2fbb
[DOCS] Fix chunking in template API docs (#57632)
* [DOCS] Fix chunking in template API docs

* Fixed typo in xref

* Added anchor for beats xref

* Fixed example
2020-06-03 17:14:20 -07:00
Lisa Cawley 8b9293b3bf
[DOCS] Replace docdir attribute with es-repo-dir (#57489) 2020-06-01 15:55:05 -07:00
Martijn van Groningen f8b090b641
Ensure template exists when creating data stream (#56888)
Limit the creation of data streams only for namespaces that have a composable template with a data stream definition.

This way we ensure that mappings/settings have been specified and will be used at data stream creation and data stream rollover.

Also remove `timestamp_field` parameter from create data stream request and
let the create data stream api resolve the timestamp field
from the data stream definition snippet inside a composable template.

Relates to #53100
2020-05-28 13:11:15 +02:00
Lee Hinman 4dc32611fc
Rename template V2 classes to ComposableTemplate (#57183)
This PR changes the name of the Index Template V2 classes to "Composable Templates", it also ensures there are no mentions of "V2" in the documentation or error/warning messages. V1 templates are referred to as "legacy" templates.

Resolves #56609
2020-05-27 09:32:10 -06:00
Lee Hinman d3ccada06f
Add template simulation API for simulating template composition (#56842)
This adds an API for simulating template composition with or without an index template.

It looks like:

```
POST /_index_template/_simulate/my-template
```

To simulate a template named `my-template` that already exists, or, to simulate a template that does
not already exist:

```
POST /_index_template/_simulate
{
  "index_patterns": ["my-index"]
  "composed_of": ["ct1", "ct2"],
}
```

This is related to #55686, which adds an API to simulate composition based on an index name (hence
the `_simulate_index` vs `_simulate`).

This commit also adds reference documentation for both simulation APIs.

Relates to #53101
Resolves #56390
Resolves #56255
2020-05-18 15:11:42 -06:00
Lee Hinman cad030d8d7
Don't allow invalid template combinations (#56397)
This commit removes the ability to put V2 index templates that reference missing component templates.
It also prevents removing component templates that are being referenced by an existing V2 index
template.

Relates to #53101
Resolves #56314
2020-05-14 15:33:35 -06:00
Lee Hinman fc708ccca4
Remove prefer_v2_templates query string parameter (#56546)
This commit removes the `prefer_v2_templates` flag and setting. This was a brief setting that
allowed specifying whether V1 or V2 template should be used when an index is created. It has been
removed in favor of V2 templates always having priority.

Relates to #53101
Resolves #56528

This is not a breaking change because this flag was never in a released version.
2020-05-11 14:56:48 -06:00
Lee Hinman cd6a89288f
Validate non-negative priorities for V2 index templates (#56139)
This also fixes an issue where a `null` priority was treated as below a 0 priority. `null` is now
treated as 0 priority when it comes to comparing V2 templates.

Relates to #53101
2020-05-04 14:46:08 -06:00
Lee Hinman fa22b10d4c
Initial documentation for index templates V2 (#55755)
This commit adds the initial document for version two index templates. Since these are intended to
be used in favor of V1 index templates, this re-uses the anchors for index templates to point to the
V2 APIs, renaming the V1 template docs' anchors (this was a suggestion from the docs team).

There is more documentation that can be written, but this is a start.

Relates to #53101
2020-04-28 15:58:40 -06:00