[DOCS] Move searchable snapshots to beta (#63436) (#63478)

This commit is contained in:
James Rodewig 2020-10-08 09:27:52 -04:00 committed by GitHub
parent 517d3e4336
commit 5e623522d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 8 additions and 38 deletions

View File

@ -72,11 +72,9 @@ tier should be configured to use one or more replicas.
The cold tier is made of one or more nodes that have the <<data-cold-node, data_cold>> role.
Once the data in the <<warm-tier, warm tier>> is not updated anymore it can transition to the
cold tier. The cold tier is still a responsive query tier but as the data transitions into this
tier it can be compressed, shrunken, or configured to have zero replicas and be backed by snapshot. The cold tier is usually hosting the data from recent
tier it can be compressed, shrunken, or configured to have zero replicas and be backed by
a <<ilm-searchable-snapshot, snapshot>>. The cold tier is usually hosting the data from recent
months or years.
ifdef::permanently-unreleased-branch[]
See <<ilm-searchable-snapshot>>.
endif::[]
[discrete]
[[data-tier-allocation]]

View File

@ -6,17 +6,16 @@ Phases allowed: delete.
Permanently removes the index.
ifdef::permanently-unreleased-branch[]
[[ilm-delete-options]]
==== Options
`delete_searchable_snapshot`::
beta:[]
(Optional, boolean)
Deletes the searchable snapshot created in the cold phase.
Defaults to `true`.
This option is applicable when the <<ilm-searchable-snapshot-action,searchable
snapshot>> action is used in the cold phase.
endif::[]
[[ilm-delete-action-ex]]
==== Example

View File

@ -2,6 +2,8 @@
[[ilm-searchable-snapshot]]
=== Searchable snapshot
beta::[]
Phases allowed: cold.
Takes a snapshot of the managed index in the configured repository

View File

@ -10,20 +10,11 @@ to be be performed safely on follower indices.
You can also use unfollow directly when moving follower indices through the lifecycle.
Has no effect on indices that are not followers, phase execution just moves to the next action.
ifdef::permanently-unreleased-branch[]
[NOTE]
This action is triggered automatically by the <<ilm-rollover-action, rollover>>,
<<ilm-shrink-action, shrink>>, and
<<ilm-searchable-snapshot-action, searchable snapshot>> actions when they are
applied to follower indices.
endif::[]
ifndef::permanently-unreleased-branch[]
[NOTE]
This action is triggered automatically by the <<ilm-rollover-action, rollover>>
and <<ilm-shrink-action, shrink>> actions when they are applied to follower
indices.
endif::[]
This action waits until is it safe to convert a follower index into a regular index.
The following conditions must be met:

View File

@ -29,11 +29,10 @@ Block write operations to the index.
Remove the index as the write index for the rollover alias and
start indexing to a new index.
ifdef::permanently-unreleased-branch[]
[[ilm-searchable-snapshot-action]]<<ilm-searchable-snapshot, Searchable snapshot>>::
beta:[]
Take a snapshot of the managed index in the configured repository
and mount it as a searchable snapshot.
endif::[]
[[ilm-set-priority-action]]<<ilm-set-priority,Set priority>>::
Lower the priority of an index as it moves through the lifecycle
@ -44,12 +43,7 @@ Reduce the number of primary shards by shrinking the index into a new index.
[[ilm-unfollow-action]]<<ilm-unfollow,Unfollow>>::
Convert a follower index to a regular index.
ifdef::permanently-unreleased-branch[]
Performed automatically before a rollover or shrink action.
endif::[]
ifndef::permanently-unreleased-branch[]
Performed automatically before a rollover, shrink, or searchable snapshot action.
endif::[]
[[ilm-wait-for-snapshot-action]]<<ilm-wait-for-snapshot,Wait for snapshot>>::
Ensure that a snapshot exists before deleting the index.
@ -61,9 +55,7 @@ include::actions/ilm-freeze.asciidoc[]
include::actions/ilm-migrate.asciidoc[]
include::actions/ilm-readonly.asciidoc[]
include::actions/ilm-rollover.asciidoc[]
ifdef::permanently-unreleased-branch[]
include::actions/ilm-searchable-snapshot.asciidoc[]
endif::[]
include::actions/ilm-set-priority.asciidoc[]
include::actions/ilm-shrink.asciidoc[]
include::actions/ilm-unfollow.asciidoc[]

View File

@ -91,9 +91,7 @@ the rollover criteria, it could be 20 minutes before the rollover is complete.
- <<ilm-unfollow-action,Unfollow>>
- <<ilm-allocate,Allocate>>
- <<ilm-freeze,Freeze>>
ifdef::permanently-unreleased-branch[]
- <<ilm-searchable-snapshot, Searchable Snapshot>>
endif::[]
* Delete
- <<ilm-wait-for-snapshot-action,Wait For Snapshot>>
- <<ilm-delete,Delete>>

View File

@ -1169,9 +1169,7 @@ We have removed documentation for this API. This a low-level API used to get
information about snapshot-backed indices. We plan to remove or drastically
change this API as part of a future release.
ifdef::permanently-unreleased-branch[]
For other searchable snapshot APIs, see <<searchable-snapshots-apis>>.
endif::[]
[role="exclude",id="searchable-snapshots-api-stats"]
=== Searchable snapshot statistics API
@ -1180,9 +1178,7 @@ We have removed documentation for this API. This a low-level API used to get
information about snapshot-backed indices. We plan to remove or drastically
change this API as part of a future release.
ifdef::permanently-unreleased-branch[]
For other searchable snapshot APIs, see <<searchable-snapshots-apis>>.
endif::[]
[role="exclude",id="searchable-snapshots-repository-stats"]
=== Searchable snapshot repository statistics API
@ -1191,9 +1187,7 @@ We have removed documentation for this API. This a low-level API used to get
information about snapshot-backed indices. We plan to remove or drastically
change this API as part of a future release.
ifdef::permanently-unreleased-branch[]
For other searchable snapshot APIs, see <<searchable-snapshots-apis>>.
endif::[]
[role="exclude",id="point-in-time"]
=== Point in time API

View File

@ -33,9 +33,7 @@ endif::[]
* <<repositories-metering-apis,Repositories Metering APIs>>
* <<rollup-apis,Rollup APIs>>
* <<search, Search APIs>>
ifdef::permanently-unreleased-branch[]
* <<searchable-snapshots-apis, Searchable snapshots APIs>>
endif::[]
* <<security-api,Security APIs>>
* <<snapshot-restore-apis,Snapshot and restore APIs>>
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
@ -67,9 +65,7 @@ include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[]
include::{es-repo-dir}/repositories-metering-api/repositories-metering-apis.asciidoc[]
include::{es-repo-dir}/rollup/rollup-api.asciidoc[]
include::{es-repo-dir}/search.asciidoc[]
ifdef::permanently-unreleased-branch[]
include::{es-repo-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[]
endif::[]
include::{xes-repo-dir}/rest-api/security.asciidoc[]
include::{es-repo-dir}/snapshot-restore/apis/snapshot-restore-apis.asciidoc[]
include::{es-repo-dir}/slm/apis/slm-api.asciidoc[]

View File

@ -6,7 +6,7 @@
<titleabbrev>Mount snapshot</titleabbrev>
++++
experimental[]
beta::[]
Mount a snapshot as a snapshot backed index.

View File

@ -3,7 +3,7 @@
[[searchable-snapshots-apis]]
== Searchable snapshots APIs
experimental[]
beta::[]
You can use the following APIs to perform searchable snapshots operations.