Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Support switch_aliases in shrink action. #5511

Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _im-plugin/ism/policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ Allows you to reduce the number of primary shards in your indexes. With this act
"my-alias": {}
}
],
"switch_aliases": true,
"force_unsafe": false
}
```
Expand All @@ -198,6 +199,7 @@ Parameter | Description | Type | Example | Required
`percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards`
`target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | `string` or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No
ikibo marked this conversation as resolved.
Show resolved Hide resolved
`aliases` | Aliases to add to the new index. | object | `myalias` | No, but must be an array of alias objects
ikibo marked this conversation as resolved.
Show resolved Hide resolved
`switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default.
ikibo marked this conversation as resolved.
Show resolved Hide resolved
hdhalter marked this conversation as resolved.
Show resolved Hide resolved
`force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No
ikibo marked this conversation as resolved.
Show resolved Hide resolved

If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example,
Expand Down