浏览代码

[DOCS] Add beta warning to ILM pages. (#35571)

debadair 7 年之前
父节点
当前提交
fc63ea5357

+ 2 - 0
docs/reference/ilm/apis/delete-lifecycle.asciidoc

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

+ 2 - 0
docs/reference/ilm/apis/explain.asciidoc

@@ -6,6 +6,8 @@
 <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 - 0
docs/reference/ilm/apis/get-lifecycle.asciidoc

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

+ 2 - 0
docs/reference/ilm/apis/get-status.asciidoc

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

+ 2 - 0
docs/reference/ilm/apis/ilm-api.asciidoc

@@ -1,6 +1,8 @@
 [[index-lifecycle-management-api]]
 [[index-lifecycle-management-api]]
 == Index Lifecycle Management API
 == Index Lifecycle Management API
 
 
+beta[]
+
 You can use the following APIs to manage policies on indices.
 You can use the following APIs to manage policies on indices.
 
 
 [float]
 [float]

+ 2 - 0
docs/reference/ilm/apis/move-to-step.asciidoc

@@ -6,6 +6,8 @@
 <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 - 0
docs/reference/ilm/apis/put-lifecycle.asciidoc

@@ -6,6 +6,8 @@
 <titleabbrev>Create Policy</titleabbrev>
 <titleabbrev>Create Policy</titleabbrev>
 ++++
 ++++
 
 
+beta[]
+
 Creates or updates lifecycle policy.
 Creates or updates lifecycle policy.
 
 
 ==== Request
 ==== Request

+ 2 - 0
docs/reference/ilm/apis/remove-policy.asciidoc

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

+ 2 - 0
docs/reference/ilm/apis/retry-policy.asciidoc

@@ -6,6 +6,8 @@
 <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 - 0
docs/reference/ilm/apis/start.asciidoc

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

+ 2 - 0
docs/reference/ilm/apis/stop.asciidoc

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

+ 3 - 0
docs/reference/ilm/error-handling.asciidoc

@@ -3,6 +3,8 @@
 [[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
@@ -142,6 +144,7 @@ PUT _ilm/policy/shrink-the-index
 // CONSOLE
 // CONSOLE
 // TEST[continued]
 // TEST[continued]
 
 
+[float]
 === Retrying failed index lifecycle management steps
 === Retrying failed index lifecycle management steps
 
 
 Once the underlying issue that caused an index to move to the error step has
 Once the underlying issue that caused an index to move to the error step has

+ 8 - 0
docs/reference/ilm/getting-started-ilm.asciidoc

@@ -3,6 +3,8 @@
 [[getting-started-index-lifecycle-management]]
 [[getting-started-index-lifecycle-management]]
 == Getting started with {ilm}
 == Getting started with {ilm}
 
 
+beta[]
+
 Let's jump into {ILM} by working through a hands-on scenario.
 Let's jump into {ILM} by working through a hands-on scenario.
 This section will leverage many new concepts unique to {ILM} that
 This section will leverage many new concepts unique to {ILM} that
 you may not be familiar with. The following sections will explore
 you may not be familiar with. The following sections will explore
@@ -17,6 +19,8 @@ after 90 days.
 
 
 === Setting up a new policy
 === Setting up a new policy
 
 
+beta[]
+
 There are many new features introduced by {ILM}, but we will only focus on
 There are many new features introduced by {ILM}, 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
@@ -66,6 +70,8 @@ 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
@@ -137,6 +143,8 @@ 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

+ 3 - 1
docs/reference/ilm/index.asciidoc

@@ -8,6 +8,8 @@
 :ILM:             ILM
 :ILM:             ILM
 [partintro]
 [partintro]
 --
 --
+beta[]
+
 The <<index-lifecycle-management-api, {ilm} (ILM) APIs>> enable you to automate how you
 The <<index-lifecycle-management-api, {ilm} (ILM) APIs>> enable you to automate how you
 want to manage your indices over time. Rather than simply performing management
 want to manage your indices over time. Rather than simply performing management
 actions on your indices on a set schedule, you can base actions on other factors
 actions on your indices on a set schedule, you can base actions on other factors
@@ -60,7 +62,7 @@ include::using-policies-rollover.asciidoc[]
 
 
 include::update-lifecycle-policy.asciidoc[]
 include::update-lifecycle-policy.asciidoc[]
 
 
-include::get-index-lifecycle-information.asciidoc[]
+// include::get-index-lifecycle-information.asciidoc[]
 
 
 include::error-handling.asciidoc[]
 include::error-handling.asciidoc[]
 
 

+ 9 - 0
docs/reference/ilm/policy-definitions.asciidoc

@@ -1,8 +1,11 @@
+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.
 
 
@@ -23,6 +26,8 @@ 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
@@ -68,6 +73,8 @@ relative to when data was written last to a rolled over index.
 
 
 === 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
@@ -491,6 +498,8 @@ 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 20g or 7 days. After 30 days it enters the warm phase
 rolling over every 20g or 7 days. After 30 days it enters the warm phase

+ 8 - 3
docs/reference/ilm/set-up-lifecycle-policy.asciidoc

@@ -3,6 +3,8 @@
 [[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
 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
 a policy called `my_policy` in Elasticsearch which we can later use to manage
@@ -30,12 +32,12 @@ PUT _ilm/policy/my_policy
     }
     }
   }
   }
 }
 }
------------------------- 
+------------------------
 // CONSOLE
 // CONSOLE
 <1> Rollover the index when it reaches 25GB in size
 <1> Rollover the index when it reaches 25GB in size
 <2> Delete the index when its 30 days old
 <2> Delete the index when its 30 days old
 
 
-{ilm} will manage an index using the policy defined in the 
+{ilm} will manage an index using the policy defined in the
 `index.lifecycle.name` index setting. If this setting does not exist in the
 `index.lifecycle.name` index setting. If this setting does not exist in the
 settings for a particular index {ilm} will not manage that index.
 settings for a particular index {ilm} will not manage that index.
 
 
@@ -45,6 +47,8 @@ To set the policy for an index there are two options:
 
 
 === 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:
 
 
@@ -89,6 +93,8 @@ 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:
 
 
@@ -109,4 +115,3 @@ IMPORTANT: Its recommended not to use the create index API with a policy that
 defines a rollover action. If you do so, the new index as the result of the
 defines a rollover action. If you do so, the new index as the result of the
 rollover will not carry forward the policy. Always use index templates to
 rollover will not carry forward the policy. Always use index templates to
 define policies with rollover actions.
 define policies with rollover actions.
-

+ 5 - 1
docs/reference/ilm/start-stop-ilm.asciidoc

@@ -3,6 +3,8 @@
 [[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,
@@ -77,7 +79,8 @@ The operating modes of ILM:
 |STOPPED |This represents a state where no policies are executed
 |STOPPED |This represents a state where no policies are executed
 |===
 |===
 
 
-=== Stopping ILM
+[float]
+=== Stopping ILM=
 
 
 The ILM service can be paused such that no further steps will be executed
 The ILM service can be paused such that no further steps will be executed
 using the <<ilm-stop,Stop API>>.
 using the <<ilm-stop,Stop API>>.
@@ -134,6 +137,7 @@ GET _ilm/status
 // CONSOLE
 // CONSOLE
 // TESTRESPONSE
 // TESTRESPONSE
 
 
+[float]
 === Starting ILM
 === Starting ILM
 
 
 To start ILM and continue executing policies, use the <<ilm-start, Start API>>.
 To start ILM and continue executing policies, use the <<ilm-start, Start API>>.

+ 8 - 0
docs/reference/ilm/update-lifecycle-policy.asciidoc

@@ -6,6 +6,8 @@
 <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
@@ -17,6 +19,8 @@ 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
 
 
@@ -130,6 +134,8 @@ 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
@@ -358,6 +364,8 @@ 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.
 
 

+ 2 - 0
docs/reference/ilm/using-policies-rollover.asciidoc

@@ -3,6 +3,8 @@
 [[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