mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 21:18:31 +00:00
8a662c7e62
* [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 * 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
95 lines
1.7 KiB
Plaintext
95 lines
1.7 KiB
Plaintext
////
|
|
This is a template for ILM action reference documentation.
|
|
|
|
To document a new action, copy this file, remove comments like this, and
|
|
replace "sample" with the appropriate action name.
|
|
|
|
Ensure the new action docs are linked and included in
|
|
docs/reference/ilm/actions.asciidoc
|
|
////
|
|
|
|
[role="xpack"]
|
|
[[ilm-sample]]
|
|
=== Sample
|
|
|
|
Phases allowed: hot, warm, cold, delete.
|
|
|
|
////
|
|
INTRO
|
|
Include a brief, 1-2 sentence description.
|
|
////
|
|
|
|
Does a cool thing.
|
|
|
|
[[ilm-sample-options]]
|
|
==== Options
|
|
|
|
////
|
|
Definition list of the options that can be specified for the action:
|
|
|
|
If there are no options:
|
|
|
|
None.
|
|
////
|
|
|
|
`sample_option1`::
|
|
(Optional, integer)
|
|
Number of something.
|
|
|
|
`sample_option2`::
|
|
(Required, string)
|
|
Name of something.
|
|
|
|
[[ilm-sample-ex]]
|
|
==== Example
|
|
|
|
////
|
|
Basic example of configuring the action in an ILM policy.
|
|
|
|
Additional examples are optional.
|
|
////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"warm": {
|
|
"actions": {
|
|
"sample" : {
|
|
"sample_option1" : 2
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[skip: Replace fake actions and remove this comment.]
|
|
|
|
[[ilm-sample2-ex]]
|
|
===== Describe example
|
|
|
|
The sample action in the following policy does something interesting.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"warm": {
|
|
"actions": {
|
|
"sample" : {
|
|
"sample_option1" : 100,
|
|
"sample_option2" : "interesting"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TEST[skip: Replace fake actions and remove this comment.]
|