You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: docs/im/api.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
2
layout: default
3
-
title: ISM API
4
-
parent: Index State Management
3
+
title: IM API
4
+
parent: Index Management
5
5
nav_order: 5
6
6
---
7
7
8
-
# ISM API
8
+
# IM API
9
9
10
10
Use the index state management operations to programmatically work with policies and managed indices.
11
11
@@ -179,7 +179,7 @@ POST _opendistro/_ism/add/<index>
179
179
180
180
## Update policy
181
181
182
-
Updates a policy. Use the `seq_no` and `primary_term` parameters to update an existing policy. If these numbers don't match the existing policy or the policy doesn't exist, ISM throws an error.
182
+
Updates a policy. Use the `seq_no` and `primary_term` parameters to update an existing policy. If these numbers don't match the existing policy or the policy doesn't exist, IM throws an error.
@@ -459,7 +459,7 @@ POST _opendistro/_ism/update_policy/<index>
459
459
460
460
## Retry failed index
461
461
462
-
Retries the failed action for an index. For the retry call to succeed, ISM must manage the index, and the index must be in a failed state. You can use index patterns (`*`) to retry multiple failed indices.
462
+
Retries the failed action for an index. For the retry call to succeed, IM must manage the index, and the index must be in a failed state. You can use index patterns (`*`) to retry multiple failed indices.
If you analyze time-series data, you likely prioritize new data over old data. You might periodically perform certain operations on older indices, such as reducing replica count or deleting them.
13
13
14
-
Index State Management (ISM) is a plugin that lets you automate these periodic, administrative operations by triggering them based on changes in the index age, index size, or number of documents. Using the ISM plugin, you can define *policies* that automatically handle index rollovers or deletions to fit your use case.
14
+
Index Management (IM) is a plugin that lets you automate these periodic, administrative operations by triggering them based on changes in the index age, index size, or number of documents. Using the IM plugin, you can define *policies* that automatically handle index rollovers or deletions to fit your use case.
15
15
16
16
For example, you can define a policy that moves your index into a `read_only` state after 30 days and then deletes it after a set period of 90 days.
17
17
18
18
You might want to perform an index rollover after a certain amount of time or run a `force_merge` operation on an index during off-peak hours to improve search performance during peak hours.
19
19
20
-
## Get started with ISM
20
+
## Get started with IM
21
21
22
22
To get started, choose **Index Management** in Kibana.
23
23
24
24
### Step 1: Set up policies
25
25
26
-
A policy is a set of rules that describes how an index should be managed. For information about creating a policy, see [Policies](../ism/policies/).
26
+
A policy is a set of rules that describes how an index should be managed. For information about creating a policy, see [Policies](../im/policies/).
27
27
28
28
1. Choose the **Index Policies** tab.
29
29
2. Choose **Create policy**.
@@ -42,23 +42,23 @@ You can also include the `policy_id` in an index template so when an index is cr
42
42
4. From the **Policy ID** menu, choose the policy that you created.
43
43
You can see a preview of your policy.
44
44
5. If your policy includes a rollover operation, specify a rollover alias.
45
-
Make sure that the alias that you enter already exists. For more information about the rollover operation, see [rollover](../ism/policies/#rollover).
45
+
Make sure that the alias that you enter already exists. For more information about the rollover operation, see [rollover](../im/policies/#rollover).
46
46
6. Choose **Apply**.
47
47
48
-
After you attach a policy to an index, a job is created that executes every 5 minutes by default to perform the actions set in the policy and check the conditions to transition the index into different states. To change the default time interval for this job, see [Settings](../ism/settings/).
48
+
After you attach a policy to an index, a job is created that executes every 5 minutes by default to perform the actions set in the policy and check the conditions to transition the index into different states. To change the default time interval for this job, see [Settings](../im/settings/).
49
49
50
-
If you want to use an Elasticsearch operation to create an index with a policy already attached to it, see [create index](../ism/api//#create-index).
50
+
If you want to use an Elasticsearch operation to create an index with a policy already attached to it, see [add policy at index creation](../im/api/#add-policy-at-index-creation).
51
51
52
52
### Step 3: Manage indices
53
53
54
54
1. Choose **Managed Indices**.
55
-
2. To change your policy, see [Change Policy](../ism/managedindices#changepolicy).
55
+
2. To change your policy, see [Change Policy](../im/managedindices#changepolicy).
56
56
3. To attach a rollover alias to your index, select your policy and choose **Add rollover alias**.
57
-
Make sure that the alias that you enter already exists. For more information about the rollover operation, see [rollover](../ism/policies/#rollover).
57
+
Make sure that the alias that you enter already exists. For more information about the rollover operation, see [rollover](../im/policies/#rollover).
58
58
4. To remove a policy, choose your policy, and then choose **Remove policy**.
59
59
5. To retry a policy, choose your policy, and then choose **Retry policy**.
60
60
61
-
For information about managing your policies, see [Managed Indices](../ism/managedindices/).
61
+
For information about managing your policies, see [Managed Indices](../im/managedindices/).
62
62
63
-
To use the ISM plugin, you need to have the correct admin privileges as set in the security plugin.
63
+
To use the IM plugin, you need to have the correct admin privileges as set in the security plugin.
Copy file name to clipboardExpand all lines: docs/im/managedindices.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
layout: default
3
3
title: Managed Indices
4
4
nav_order: 3
5
-
parent: Index State Management
5
+
parent: Index Management
6
6
has_children: false
7
7
---
8
8
@@ -58,11 +58,11 @@ The following example shows a managed index policy:
58
58
59
59
## Change policy
60
60
61
-
You can change any managed index policy, but ISM has a few constraints in place to make sure that policy changes don't break indices.
61
+
You can change any managed index policy, but IM has a few constraints in place to make sure that policy changes don't break indices.
62
62
63
-
If an index is stuck in its current state, never proceeding, and you want to update its policy immediately, make sure that the new policy includes the same state---same name, same actions, same order---as the old policy. In this case, even if the policy is in the middle of executing an action, ISM applies the new policy.
63
+
If an index is stuck in its current state, never proceeding, and you want to update its policy immediately, make sure that the new policy includes the same state---same name, same actions, same order---as the old policy. In this case, even if the policy is in the middle of executing an action, IM applies the new policy.
64
64
65
-
If you update the policy without including an identical state, ISM updates the policy only after all actions in the current state finish executing. Alternately, you can choose a specific state in your old policy after which you want the new policy to take effect.
65
+
If you update the policy without including an identical state, IM updates the policy only after all actions in the current state finish executing. Alternately, you can choose a specific state in your old policy after which you want the new policy to take effect.
66
66
67
67
To change a policy using Kibana, do the following:
Copy file name to clipboardExpand all lines: docs/im/settings.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
---
2
2
layout: default
3
3
title: Settings
4
-
parent: Index State Management
4
+
parent: Index Management
5
5
nav_order: 4
6
6
---
7
7
8
8
# Settings
9
9
10
10
We don't recommend changing these settings; the defaults should work well for most use cases.
11
11
12
-
ISM stores its configuration in the `.opendistro-ism-config` index. Don't modify this index without using the [ISM API operations](../api/).
12
+
IM stores its configuration in the `.opendistro-ism-config` index. Don't modify this index without using the [IM API operations](../api/).
13
13
14
14
All settings are available using the Elasticsearch `_cluster/settings` operation. None require a restart, and all can be marked `persistent` or `transient`.
15
15
16
16
Setting | Default | Description
17
17
:--| :- | :--------------
18
-
`opendistro.index_state_management.enabled` | True | Specifies whether ISM is enabled or not.
18
+
`opendistro.index_state_management.enabled` | True | Specifies whether IM is enabled or not.
19
19
`opendistro.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run.
20
20
`opendistro.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.
21
21
`opendistro.index_state_management.coordinator.backoff_millis` | 50 milliseconds | The backoff time between retries for failures in the `ManagedIndexCoordinator` (such as when we update managed indices).
0 commit comments