Commit graph

143 commits

Author SHA1 Message Date
Mikołaj Przybysz
9e8d8ee38a
[DOCS] Add line break to get ILM lifecycle API docs (#61892) 2020-09-04 09:00:11 -04:00
James Rodewig
0acd6e619d
[DOCS] Add force merge to hot phase list (#61725) 2020-08-31 10:44:16 -04:00
James Rodewig
c688cb6bfd
[DOCS] Fix hyphenation for "time series" (#61472) 2020-08-24 10:34:41 -04:00
Andrei Dan
6d0148001c
ILM: add frozen phase (#60983)
This adds a frozen phase to ILM that will allow the execution of the
set_priority, unfollow, allocate, freeze and searchable_snapshot actions.

The frozen phase will be executed after the cold and before the delete phase.
2020-08-12 15:50:11 +01:00
Andrei Dan
d0a17b2d35
ILM: add force-merge step to searchable snapshots action (#60819)
This adds a force-merge step to the searchable snapshot action, enabled by default,
but parameterizable using the `force_merge-index" optional boolean.

eg.
```
PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "cold": {
        "actions": {
          "searchable_snapshot" : {
            "snapshot_repository" : "backing_repo",
            "force_merge_index": true
          }
        }
      }
    }
  }
}
```
2020-08-10 10:45:20 +01:00
James Rodewig
1cf928c58a
[DOCS] Update ILM docs to use composable index templates (#60323) 2020-08-04 12:44:02 -04:00
debadair
5bcd2058c8
[DOCS] Update link to ILM tutorial (#60557) 2020-07-31 15:46:55 -07:00
James Rodewig
441c3a21b1
[DOCS] Update my-index examples (#60132)
Changes the following example index names to `my-index-000001` for consistency:

* `my-index`
* `my_index`
* `myindex`
2020-07-27 14:46:39 -04:00
James Rodewig
4c69f3dd97
[DOCS] Add Kibana screenshots to data stream docs (#60118) 2020-07-27 10:19:00 -04:00
James Rodewig
0f145ace6f
[DOCS] Simplify index template snippets for data streams (#59533)
Removes the `@timestamp` field mapping from several data stream index
template snippets.

With #59317, the `@timestamp` field defaults to a `date` field data type
for data streams.
2020-07-14 12:08:54 -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
James Rodewig
55b6c1ab82
[DOCS] Add data streams to ILM explain API (#59343) 2020-07-13 08:49:10 -04:00
James Rodewig
786104eef7
[DOCS] Update snapshot/restore and SLM docs for data streams (#58513)
Updates the existing snapshot/restore and SLM docs to make them
aware of data streams.
2020-07-13 08:34:42 -04:00
James Rodewig
2be9db01c8
[DOCS] Replace datatype with data type (#58972) 2020-07-07 13:52:10 -04:00
debadair
f80f603c1e
[DOCS] Combo version of ILM docs. (#57909)
* [DOCS] Combo version of ILM docs.

* [DOCS] Moved tutorial from Kibana.

* Adds documentation for index lifecycle policies (#28705)

* [DOCS] Adds documentation for index lifecycle policies

* [DOCS] Updated image for policy options to show all menu items

* Update create-policy.asciidoc

* [DOCS] Incorporated review comments on hot and warm phase

* [DOCS] Additional changes to warm phase

* [DOCS] Removed the word open in the warm phase

* Adds X-Pack icon for ILM (#34178)

* Add ILM tutorial (#59502)

* Add tutorial for ILM with filebeat

* Change screenshots and add additional steps

* Update screenshots, add numbered steps, and other minor edits

* Incorporate feedback: update links, formatting, and minor edits

* Move tip inline with list

* Apply suggestions from code review

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Move TIP inline . . . again

* Put TIP inline

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

* Updates for navigation redesign (#68709)

* [DOCS] Updates for navigation redesign

* Getting started

* Set up text

* Discover

* Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools

* Dev Tools, Stack Monitoring, Management

* Management

* Final changes

* [DOCS] Updates for navigation redesign

* [DOCS] Updates CCR monitoring screenshots

* updates SIEM screenshot and Cases overview text

* Added Brandon's APM image

* [DOCS] Refines CCR shard screenshot

* Removed merge conflict image file

Co-authored-by: lcawl <lcawley@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>

* [DOCS] Put API examples in collapsible sections like ML does

* Fix include

* Added tutorial images

* Fixed images

* Add short title for FB tutorial

* Add missing files

* Incorporate review feedback

* review feedback

* Incorporated review feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Melori Arellano <melori@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
2020-07-03 12:40:31 -07:00
James Rodewig
b99eb6d988
[DOCS] Add data streams to remove lifecycle policy API (#58777) 2020-07-02 09:40:12 -04:00
James Rodewig
682615a15e
[DOCS] Suppress searchable snapshots in releases (#58740) (#58743)
Fixes a searchable snapshot reference overlooked in #58652
2020-06-30 09:22:40 -04:00
David Turner
f52f5c1f02
Suppress searchable snapshots docs in releases (#58652)
This commit adds conditional logic to the docs to avoid including any
docs on searchable snapshots in released versions.

Rework of #58556 which was reverted.
2020-06-30 12:24:35 +01:00
David Turner
01b666bbdc Revert "Suppress searchable snapshots docs in releases (#58556)"
This reverts commit e5c3e5625c.
2020-06-29 09:27:54 +01:00
David Turner
e5c3e5625c
Suppress searchable snapshots docs in releases (#58556)
This commit adds conditional logic to the docs to avoid including any
docs on searchable snapshots in released versions.
2020-06-29 08:33:49 +01:00
James Rodewig
9f86ce6c0e
[DOCS] Remove composable index template refs (#58567)
Replaces `composable index template` and `composable template` with
`index template` throughout data stream-related docs.

`Composable index template` is only used to contrast with legacy index
templates.
2020-06-26 11:12:36 -04:00
Andrei Dan
25cbbe56dd
[DOCS] Make ILM documentation data stream aware (#58035)
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
2020-06-15 14:14:07 +01:00
Andrew Wilkins
2d21c214ca
docs: fix asciidoc cross-reference syntax in ILM rollover docs 2020-06-09 09:18:01 +08:00
debadair
e0e5572f34
[DOCS] Editorial ILM cleanup (#57565)
* [DOCS] Editorial cleanup

* Moved example of applying a template to multiple indices.

* Combine existing indices topics

* Fixed test

* Add skip rollover file.

* Revert rename.

* Update include.

* Revert rename

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Apply suggestions from code review

* Fixed callout

* Update docs/reference/ilm/ilm-with-existing-indices.asciidoc

Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Update docs/reference/ilm/ilm-with-existing-indices.asciidoc

Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Apply suggestions from code review

* Restored policy to template example.

* Fixed JSON parse error

Co-authored-by: Adam Locke <adam.locke@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
2020-06-05 16:24:03 -07:00
James Rodewig
6a769ea699
[DOCS] Replace docdir attribute with es-repo-dir (#57564) 2020-06-02 17:52:41 -04:00
Lisa Cawley
8b9293b3bf
[DOCS] Replace docdir attribute with es-repo-dir (#57489) 2020-06-01 15:55:05 -07:00
James Rodewig
0f078e066f
[DOCS] Add redirects for 404 pages (#57161) (#57484)
Adds several redirects for removed pages that return a
404 response.
2020-06-01 16:52:03 -04:00
debadair
cf40c96477
[DOCS] Added info about automatic config for Beats & Logstash. (#56317)
* [DOCS] Added info about automatic config for Beats & Logstash.

* Update docs/reference/ilm/set-up-lifecycle-policy.asciidoc

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

* Update docs/reference/ilm/set-up-lifecycle-policy.asciidoc

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

* Update docs/reference/ilm/index.asciidoc

* Updated note in GS tutorial

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-05-13 17:21:27 -07:00
debadair
a900e3b0f4
[DOCS] Add info about ILM and unallocated shards. (#56655)
* [DOCS] Add info about ILM and unallocated shards.

* Incorporated review feedback.

* Update docs/reference/ilm/actions/ilm-allocate.asciidoc

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

* Apply suggestions from code review

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

* Fix xref

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-05-13 15:53:43 -07:00
debadair
2d0ca5205d
[DOCS] Clarify definition of max_size (#56561) 2020-05-12 14:41:18 -07:00
debadair
52a494cea7
[DOCS] Add request body param descriptions for move to step (#56560) 2020-05-12 14:30:12 -07:00
debadair
410b079de9
[DOCS] Added info about refresh interval & max_docs and step execution. Closes #49151. (#56315) 2020-05-11 14:46:44 -07:00
Nicole Albee
b4c87f8e9f
[DOCS] Fix broken link in the ilm-tutorial. (#56310) (#56311) 2020-05-08 11:25:01 -05:00
debadair
f7cd772402
[DOCS] Align with ILM changes. (#55953)
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
2020-05-08 01:06:16 -07:00
debadair
f8413eb07a
Edit actions for consistency and add action template. (#55632)
* Edit actions for consistency and add action template.

* Update docs/reference/ilm/actions/ilm-readonly.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Apply suggestions from code review
2020-04-27 19:32:32 -07:00
debadair
cb5fdc5226
[DOCS] Rework conceptual info for ILM. (#52181)
* [DOCS] Rework conceptual info for ILM.

* Split the actions out of concepts.

* Added xpack role to actions.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Apply suggestions from code review
2020-04-22 13:53:30 -07:00
Andrei Dan
3fd05435c5
ILM DOCS: mention forcemerge is best effort (#54794) 2020-04-17 14:50:56 +01:00
Jake Landis
2ae8ea610a
[master] Advise a simpler curator migration (#54457) (#55186)
Advice for migrating from Curator should simply be to phase out curator managed indices, 
since curator will ignore ILM indices
https://www.elastic.co/guide/en/elasticsearch/client/curator/5.7/ilm-and-curator.html#ilm-and-curator.

Co-authored-by: Jay Greenberg <PhaedrusTheGreek@users.noreply.github.com>
2020-04-15 07:54:50 -05:00
Peter Dyson
437c62f2fb
[DOCS] Note where ILM policies are stored and backup caveats (#54859) 2020-04-13 09:09:32 -06:00
Dan Roscigno
e05d6180a2
Update policy-definitions.asciidoc (#54592)
* Update policy-definitions.asciidoc

The docs show how to create an ILM policy, but not how to add the attr `node.attr.data: warm` (or hot).

This PR adds to the hot,warm example.
2020-04-10 15:35:22 -04:00
Tanguy Leroux
f6feb6c2c8
Merge feature/searchable-snapshots branch into master (#54803)
This commit merges the searchable-snapshots feature branch into master.
See #54803 for the complete list of squashed commits.

Co-authored-by: David Turner <david.turner@elastic.co>
Co-authored-by: Yannick Welsch <yannick@welsch.lu>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
2020-04-06 15:51:05 +02:00
Dan Hermann
365d7b3dfa
Rename examples in ILM guide to avoid association with data streams 2020-04-01 08:29:11 -05:00
Romain Gonord
d1bd3957a4
[DOCS] Fix "Wait for Snapshot" link in ILM actions reference (#53269)
Corrects an anchor for the `Wait for Snapshot` action, which previously linked to the `Delete` action.
2020-03-09 08:40:00 -04:00
bellengao
ef88f77c45
[DOCS] Correct policy name in ILM docs example (#52354)
Updates an example snippet to use a consistent policy name.
2020-02-25 09:35:26 -05:00
Lee Hinman
e95cc14d13
Allow forcemerge in the hot phase for ILM policies (#52073)
* Allow forcemerge in the hot phase for ILM policies

This commit changes the `forcemerge` action to also be allowed in the `hot` phase for policies. The
forcemerge will occur after a rollover, and allows users to take advantage of higher disk speeds for
performing the force merge (on a separate node type, for example).

On caveat with this is that a `forcemerge` in the `hot` phase *MUST* be accompanied by a `rollover`
action. ILM validates policies to ensure this is the case.

Resolves #43165

* Use anyMatch instead of findAny in validation

* Make randomTimeseriesLifecyclePolicy single-pass
2020-02-07 15:26:00 -07:00
Edu González de la Herrán
f03b6ff789
added note for allocation during hot phase (#51149)
ILM takes care of allocation during warm and cold phases, but it doesn't take care of it for new indices (hot phase). We should add a note mentioning that fact, as if the user wants a hot / warm architecture they should ensure new indices are allocated by default on hot nodes, or they might end up on warm/cold nodes.
2020-02-05 18:06:51 +01:00
Lee Hinman
b475b2872b
Add documentation about ILM forcemerge with best_compression (#51893)
This adds the option to the parameter list and a warning about the index being unavailable during
the close and open operations.

Relates to #49974
2020-02-05 09:37:12 -07:00
debadair
8c5cdfff07
[DOCS] Edit ILM GS tutorial (#51513)
* [DOCS] Edit ILM GS tutorial

* [DOCS] Incorporated review feedback from @andreidan.

* [DOCS] Removed test link & fixed anchor & title.

* Update docs/reference/ilm/getting-started-ilm.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2020-02-04 15:37:45 -08:00
Yannick Welsch
a57a9a31c3 Stricter checks of setup and teardown in docs tests (#51430)
Made checks stricter after backporting PR.
2020-01-28 17:53:57 +01:00
debadair
d5cacd8676
[DOCS] Split off ILM overview to a separate topic. (#51287)
* [DOCS} Split off overview to a separate topic.

* [DOCS] Incorporated feedback from @jrodewig.
2020-01-27 19:39:24 -08:00