honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove "beta" modifier from ILM documentation (#37326)

This commit is contained in:
Lee Hinman 2019-01-10 13:38:14 -07:00 committed by GitHub
parent e6d3d85db4
commit 04dcb13ac4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 1 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/ilm/apis/delete-lifecycle.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Delete policy</titleabbrev> <titleabbrev>Delete policy</titleabbrev>
++++ ++++
beta[]
Deletes a lifecycle policy. Deletes a lifecycle policy.
==== Request ==== Request

2
docs/reference/ilm/apis/explain.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Explain lifecycle</titleabbrev> <titleabbrev>Explain lifecycle</titleabbrev>
++++ ++++
beta[]
Shows an index's current lifecycle status. Shows an index's current lifecycle status.
==== Request ==== Request

2
docs/reference/ilm/apis/get-lifecycle.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Get policy</titleabbrev> <titleabbrev>Get policy</titleabbrev>
++++ ++++
beta[]
Retrieves a lifecycle policy. Retrieves a lifecycle policy.
==== Request ==== Request

2
docs/reference/ilm/apis/get-status.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Get {ilm} status</titleabbrev> <titleabbrev>Get {ilm} status</titleabbrev>
++++ ++++
beta[]
Retrieves the current {ilm} ({ilm-init}) status. Retrieves the current {ilm} ({ilm-init}) status.
==== Request ==== Request

2
docs/reference/ilm/apis/ilm-api.asciidoc
View File

@ -1,8 +1,6 @@
[[index-lifecycle-management-api]] [[index-lifecycle-management-api]]
== {ilm-cap} API == {ilm-cap} API
beta[]
You can use the following APIs to manage policies on indices. See You can use the following APIs to manage policies on indices. See
<<index-lifecycle-management,Managing the index lifecycle>> for more information <<index-lifecycle-management,Managing the index lifecycle>> for more information
about Index Lifecycle Management. about Index Lifecycle Management.

2
docs/reference/ilm/apis/move-to-step.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Move to step</titleabbrev> <titleabbrev>Move to step</titleabbrev>
++++ ++++
beta[]
Triggers execution of a specific step in the lifecycle policy. Triggers execution of a specific step in the lifecycle policy.
==== Request ==== Request

2
docs/reference/ilm/apis/put-lifecycle.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Create policy</titleabbrev> <titleabbrev>Create policy</titleabbrev>
++++ ++++
beta[]
Creates or updates lifecycle policy. See <<ilm-policy-definition,Policy phases and actions>> Creates or updates lifecycle policy. See <<ilm-policy-definition,Policy phases and actions>>
for definitions of policy components. for definitions of policy components.

2
docs/reference/ilm/apis/remove-policy-from-index.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Remove policy</titleabbrev> <titleabbrev>Remove policy</titleabbrev>
++++ ++++
beta[]
Removes the assigned lifecycle policy from an index. Removes the assigned lifecycle policy from an index.
==== Request ==== Request

2
docs/reference/ilm/apis/retry-policy.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Retry policy</titleabbrev> <titleabbrev>Retry policy</titleabbrev>
++++ ++++
beta[]
Retry executing the policy for an index that is in the ERROR step. Retry executing the policy for an index that is in the ERROR step.
==== Request ==== Request

2
docs/reference/ilm/apis/start.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Start {ilm}</titleabbrev> <titleabbrev>Start {ilm}</titleabbrev>
++++ ++++
beta[]
Start the {ilm} ({ilm-init}) plugin. Start the {ilm} ({ilm-init}) plugin.
==== Request ==== Request

2
docs/reference/ilm/apis/stop.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Stop {ilm}</titleabbrev> <titleabbrev>Stop {ilm}</titleabbrev>
++++ ++++
beta[]
Stop the {ilm} ({ilm-init}) plugin. Stop the {ilm} ({ilm-init}) plugin.
==== Request ==== Request

2
docs/reference/ilm/error-handling.asciidoc
View File

@ -3,8 +3,6 @@
[[index-lifecycle-error-handling]] [[index-lifecycle-error-handling]]
== Index lifecycle error handling == Index lifecycle error handling
beta[]
During Index Lifecycle Management's execution of the policy for an index, it's During Index Lifecycle Management's execution of the policy for an index, it's
possible for a step to encounter an error during its execution. When this possible for a step to encounter an error during its execution. When this
happens, ILM will move the management state into an "error" step. This halts happens, ILM will move the management state into an "error" step. This halts

8
docs/reference/ilm/getting-started-ilm.asciidoc
View File

@ -3,8 +3,6 @@
[[getting-started-index-lifecycle-management]] [[getting-started-index-lifecycle-management]]
== Getting started with {ilm} == Getting started with {ilm}
beta[]
Let's jump into {ilm} ({ilm-init}) by working through a hands-on scenario. Let's jump into {ilm} ({ilm-init}) by working through a hands-on scenario.
This section will leverage many new concepts unique to {ilm-init} that This section will leverage many new concepts unique to {ilm-init} that
you may not be familiar with. The following sections will explore you may not be familiar with. The following sections will explore
@ -19,8 +17,6 @@ after 90 days.
=== Setting up a new policy === Setting up a new policy
beta[]
There are many new features introduced by {ilm-init}, but we will only focus on There are many new features introduced by {ilm-init}, but we will only focus on
a few that are needed for our example. For starters, we will use the a few that are needed for our example. For starters, we will use the
<<ilm-put-lifecycle,Put Policy>> API to define our first policy. Lifecycle <<ilm-put-lifecycle,Put Policy>> API to define our first policy. Lifecycle
@ -70,8 +66,6 @@ The index will be deleted 90 days after it is rolled over.
=== Applying a policy to our index === Applying a policy to our index
beta[]
There are <<set-up-lifecycle-policy,a few ways>> to associate a There are <<set-up-lifecycle-policy,a few ways>> to associate a
policy to an index. Since we wish specific settings to be applied to policy to an index. Since we wish specific settings to be applied to
the new index created from Rollover, we will set the policy via the new index created from Rollover, we will set the policy via
@ -143,8 +137,6 @@ alias to be read-only for the source index.
=== Checking progress === Checking progress
beta[]
Now that we have an index managed by our policy, how do we tell what is going Now that we have an index managed by our policy, how do we tell what is going
on? Which phase are we in? Is something broken? This section will go over a on? Which phase are we in? Is something broken? This section will go over a
few APIs and their responses to help us inspect our indices with respect few APIs and their responses to help us inspect our indices with respect

2
docs/reference/ilm/ilm-and-snapshots.asciidoc
View File

@ -3,8 +3,6 @@
[[index-lifecycle-and-snapshots]] [[index-lifecycle-and-snapshots]]
== Restoring snapshots of managed indices == Restoring snapshots of managed indices
beta[]
When restoring a snapshot that contains indices managed by Index Lifecycle When restoring a snapshot that contains indices managed by Index Lifecycle
Management, the lifecycle will automatically continue to execute after the Management, the lifecycle will automatically continue to execute after the
snapshot is restored. Notably, the `min_age` is relative to the original snapshot is restored. Notably, the `min_age` is relative to the original

1
docs/reference/ilm/index.asciidoc
View File

@ -5,7 +5,6 @@
[partintro] [partintro]
-- --
beta[]
The <<index-lifecycle-management-api,{ilm} ({ilm-init}) APIs>> enable you to The <<index-lifecycle-management-api,{ilm} ({ilm-init}) APIs>> enable you to
automate how you want to manage your indices over time. Rather than simply automate how you want to manage your indices over time. Rather than simply

11
docs/reference/ilm/policy-definitions.asciidoc
View File

@ -1,11 +1,8 @@
beta[]
[role="xpack"] [role="xpack"]
[testenv="basic"] [testenv="basic"]
[[ilm-policy-definition]] [[ilm-policy-definition]]
== Policy phases and actions == Policy phases and actions
beta[]
There are four stages in the index lifecycle, in the order There are four stages in the index lifecycle, in the order
they are executed. they are executed.
@ -26,8 +23,6 @@ phase and the delete phase, while another may define all four phases.
=== Timing === Timing
beta[]
Indices enter phases based on a phase's `min_age` parameter. Indices enter phases based on a phase's `min_age` parameter.
The index will not enter the phase until the index's age is older than that The index will not enter the phase until the index's age is older than that
of the `min_age`. The parameter is configured using a time of the `min_age`. The parameter is configured using a time
@ -76,8 +71,6 @@ and transition into the next phase.
=== Phase Execution === Phase Execution
beta[]
The current phase definition, of an index's policy being executed, is stored The current phase definition, of an index's policy being executed, is stored
in the index's metadata. The phase and its actions are compiled into a series in the index's metadata. The phase and its actions are compiled into a series
of discrete steps that are executed sequentially. Since some {ilm-init} actions of discrete steps that are executed sequentially. Since some {ilm-init} actions
@ -89,8 +82,6 @@ executing.
=== Actions === Actions
beta[]
The below list shows the actions which are available in each phase. The below list shows the actions which are available in each phase.
* Hot * Hot
@ -582,8 +573,6 @@ PUT _ilm/policy/my_policy
=== Full Policy === Full Policy
beta[]
With all of these actions, we can support complex management strategies for our With all of these actions, we can support complex management strategies for our
indices. This policy will define an index that will start in the hot phase, indices. This policy will define an index that will start in the hot phase,
rolling over every 50 GB or 7 days. After 30 days it enters the warm phase rolling over every 50 GB or 7 days. After 30 days it enters the warm phase

6
docs/reference/ilm/set-up-lifecycle-policy.asciidoc
View File

@ -3,8 +3,6 @@
[[set-up-lifecycle-policy]] [[set-up-lifecycle-policy]]
== Set up {ilm} policy == Set up {ilm} policy
beta[]
In order for an index to use an {ilm} policy to manage its lifecycle we must In order for an index to use an {ilm} policy to manage its lifecycle we must
first define a lifecycle policy for it to use. The following request creates a first define a lifecycle policy for it to use. The following request creates a
policy called `my_policy` in Elasticsearch which we can later use to manage our policy called `my_policy` in Elasticsearch which we can later use to manage our
@ -49,8 +47,6 @@ To set the policy for an index there are two options:
[[applying-policy-to-template]] [[applying-policy-to-template]]
=== Applying a policy to an index template === Applying a policy to an index template
beta[]
The `index.lifecycle.name` setting can be set in an index template so that it The `index.lifecycle.name` setting can be set in an index template so that it
is automatically applied to indexes matching the templates index pattern: is automatically applied to indexes matching the templates index pattern:
@ -95,8 +91,6 @@ create a new index and roll the alias over to use the new index automatically.
=== Apply a policy to a create index request === Apply a policy to a create index request
beta[]
The `index.lifecycle.name` setting can be set on an individual create index The `index.lifecycle.name` setting can be set on an individual create index
request so {ilm} immediately starts managing the index: request so {ilm} immediately starts managing the index:

2
docs/reference/ilm/start-stop-ilm.asciidoc
View File

@ -3,8 +3,6 @@
[[start-stop-ilm]] [[start-stop-ilm]]
== Start and stop {ilm} == Start and stop {ilm}
beta[]
All indices that are managed by ILM will continue to execute All indices that are managed by ILM will continue to execute
their policies. There may be times when this is not desired on certain their policies. There may be times when this is not desired on certain
indices, or maybe even all the indices in a cluster. For example, indices, or maybe even all the indices in a cluster. For example,

8
docs/reference/ilm/update-lifecycle-policy.asciidoc
View File

@ -6,8 +6,6 @@
<titleabbrev>Update policy</titleabbrev> <titleabbrev>Update policy</titleabbrev>
++++ ++++
beta[]
You can update an existing lifecycle policy to fix mistakes or change You can update an existing lifecycle policy to fix mistakes or change
strategies for newly created indices. It is possible to update policy definitions strategies for newly created indices. It is possible to update policy definitions
and an index's `index.lifecycle.name` settings independently. To prevent the situation and an index's `index.lifecycle.name` settings independently. To prevent the situation
@ -22,8 +20,6 @@ their effects on policy execution on indices.
=== Updates to policies not managing indices === Updates to policies not managing indices
beta[]
Indices not referencing an existing policy that is updated will not be affected. Indices not referencing an existing policy that is updated will not be affected.
If an index is assigned to the policy, it will be assigned the latest version of that policy If an index is assigned to the policy, it will be assigned the latest version of that policy
@ -137,8 +133,6 @@ the policy.
=== Updates to executing policies === Updates to executing policies
beta[]
Indices preserve the phase definition from the latest policy version that existed Indices preserve the phase definition from the latest policy version that existed
at the time that it entered that phase. Changes to the currently-executing phase within policy updates will at the time that it entered that phase. Changes to the currently-executing phase within policy updates will
not be reflected during execution. This means that updates to the `hot` phase, for example, will not affect not be reflected during execution. This means that updates to the `hot` phase, for example, will not affect
@ -445,8 +439,6 @@ GET my_index/_ilm/explain
=== Switching policies for an index === Switching policies for an index
beta[]
Setting `index.lifecycle.name` to a different policy behaves much like a policy update, but instead of just Setting `index.lifecycle.name` to a different policy behaves much like a policy update, but instead of just
switching to a different version, it switches to a different policy. switching to a different version, it switches to a different policy.

4
docs/reference/ilm/using-policies-rollover.asciidoc
View File

@ -3,8 +3,6 @@
[[using-policies-rollover]] [[using-policies-rollover]]
== Using policies to manage index rollover == Using policies to manage index rollover
beta[]
The rollover action enables you to automatically roll over to a new index based The rollover action enables you to automatically roll over to a new index based
on the index size, document count, or age. When a rollover is triggered, a new on the index size, document count, or age. When a rollover is triggered, a new
index is created, the write alias is updated to point to the new index, and all index is created, the write alias is updated to point to the new index, and all
@ -127,8 +125,6 @@ the new index, enabling indexing to continue uninterrupted.
=== Skipping Rollover === Skipping Rollover
beta[]
The `index.lifecycle.indexing_complete` setting indicates to {ilm} whether this The `index.lifecycle.indexing_complete` setting indicates to {ilm} whether this
index has already been rolled over. If it is set to `true`, that indicates that index has already been rolled over. If it is set to `true`, that indicates that
this index has already been rolled over and does not need to be rolled over this index has already been rolled over and does not need to be rolled over