From d9b98fad1bc1da720db546bae932145fa6990922 Mon Sep 17 00:00:00 2001 From: bowenlan-amzn Date: Mon, 1 Nov 2021 09:58:51 -0700 Subject: [PATCH] ism doc changes 1. suggest setup error notification 2. mention rollover_skip index setting Signed-off-by: bowenlan-amzn --- _im-plugin/ism/index.md | 4 ++-- _im-plugin/ism/policies.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_im-plugin/ism/index.md b/_im-plugin/ism/index.md index 8004146c..f8dabe06 100644 --- a/_im-plugin/ism/index.md +++ b/_im-plugin/ism/index.md @@ -39,7 +39,7 @@ You can use the visual editor or JSON editor to create policies. Compared to the 2. Choose **Create policy**. 3. Choose **Visual editor**. 4. In the **Policy info** section, enter a policy ID and an optional description. -5. In the **Error notification** section, set up an optional error notification that gets sent whenever a policy execution fails. For more information, see [Error notifications]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#error-notifications). +5. In the **Error notification** section, set up an optional error notification that gets sent whenever a policy execution fails. Please set up this if you are using ISM for auto rollover. This helps to prevent unexpected huge index when rollover action failed. For more information, see [Error notifications]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#error-notifications). 6. In **ISM templates**, enter any ISM template patterns to automatically apply this policy to existing and future indices. For example, if you specify a template of `sample-index*`, the ISM plugin automatically applies this policy to any indices whose names start with `sample-index`. 7. In **States**, add any states you want to include in the policy. Each state has [actions]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#actions) the plugin executes when the index enters a certain state, and [transitions]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#transitions), which have conditions that, when met, transition the index into a destination state. The first state you create in a policy is automatically set as the initial state. Each policy must have at least one state, but actions and transitions are optional. 8. Choose **Create**. @@ -76,7 +76,7 @@ PUT _plugins/_ism/policies/policy_id If you have more than one template that matches an index pattern, ISM uses the priority value to determine which template to apply. -For an example ISM template policy, see [Sample policy with ISM template]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#sample-policy-with-ism-template). +For an example ISM template policy, see [Sample policy with ISM template for auto rollover]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#sample-policy-with-ism-template-for-auto-rollover). Older versions of the plugin include the `policy_id` in an index template, so when an index is created that matches the index template pattern, the index will have the policy attached to it: diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 1d8f44b1..b8d64a66 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -517,9 +517,9 @@ The destination system **must** return a response otherwise the `error_notificat You can use the same options for `ctx` variables as the [notification](#notification) operation. -## Sample policy with ISM template +## Sample policy with ISM template for auto rollover -The following sample template policy is for a rollover use case. +If you want to skip the rollover action for an index, you can set this index setting `index.plugins.index_state_management.rollover_skip` to true. 1. Create a policy with an `ism_template` field: