From cd5e0ac390b37dd0826d727dbd13de6443234ac3 Mon Sep 17 00:00:00 2001 From: keithhc2 Date: Thu, 7 Oct 2021 15:15:58 -0700 Subject: [PATCH] Added instructions about ISM visual editor --- _im-plugin/ism/index.md | 14 +++++++++++++- _im-plugin/ism/policies.md | 6 +++--- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/_im-plugin/ism/index.md b/_im-plugin/ism/index.md index 4202b849..8004146c 100644 --- a/_im-plugin/ism/index.md +++ b/_im-plugin/ism/index.md @@ -31,7 +31,19 @@ To get started, choose **Index Management** in OpenSearch Dashboards. A policy is a set of rules that describes how an index should be managed. For information about creating a policy, see [Policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/). -You can use the JSON editor or visual editor to create policies. Compared to the JSON editor, the visual editor offers a more structured way of defining policies by separating the process into creating error notifications, defining ISM templates, and adding states. We recommend using the visual editor if you want to see pre-defined fields, such as which actions you can assign to a state or under what conditions a state can transition into a destination state. +You can use the visual editor or JSON editor to create policies. Compared to the JSON editor, the visual editor offers a more structured way of defining policies by separating the process into creating error notifications, defining ISM templates, and adding states. We recommend using the visual editor if you want to see pre-defined fields, such as which actions you can assign to a state or under what conditions a state can transition into a destination state. + +#### Visual editor + +1. Choose the **Index Policies** tab. +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). +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**. + #### JSON editor diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index ec4bf737..dbde4874 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -39,7 +39,7 @@ Field | Description | Type | Required | Read Only --- -## States +## States A state is the description of the status that the managed index is currently in. A managed index can be in only one state at a time. Each state has associated actions that are executed sequentially on entering a state and transitions that are checked after all the actions have been completed. @@ -71,7 +71,7 @@ The `retry` operation has the following parameters: Parameter | Description | Type | Required | Default :--- | :--- |:--- |:--- | `count` | The number of retry counts. | `number` | Yes | - -`backoff` | The backoff policy type to use when retrying. | `string` | No | Exponential +`backoff` | The backoff policy type to use when retrying. Valid values are Exponential, Constant, and Linear. | `string` | No | Exponential `delay` | The time to wait between retries. Accepts time units for minutes, hours, and days. | `time unit` | No | 1 minute The following example action has a timeout period of one hour. The policy retries this action three times with an exponential backoff policy, with a delay of 10 minutes between each retry: @@ -659,6 +659,6 @@ After 30 days, the policy moves this index into a `delete` state. The service se } ``` -This diagram shows the `states`, `transitions`, and `actions` of the above policy as a finite-state machine. For more information about finite-state machines, see [Wikipedia](https://en.wikipedia.org/wiki/Finite-state_machine). +This diagram shows the `states`, `transitions`, and `actions` of the above policy as a finite-state machine. For more information about finite-state machines, see [Wikipedia](https://en.wikipedia.org/wiki/Finite-state_machine). ![Policy State Machine]({{site.baseurl}}/images/ism.png)