Templated Snapshot Name

Plugins Index Management
1

Versions (relevant - OpenSearch/Dashboard/Server OS/Browser):

  • 1.2
  • 2.3
  • 2.4

Describe the issue:
I’m in the process of attempting to schedule automated snapshots using the ISM plugin. I’ve configured my snapshot policy similar to the one detailed on the AWS documentation page.

The plugin documentation indicates that the plugin name may either be a string or a mustache template. I want to include a timestamp in any snapshots which get generated by ISM. How would I go about leveraging a mustache template to inject the timestamp which the snapshot was triggered into the ISM generated snapshot?

2

From this part of the code

  1. snapshot name will always get a timestamp suffix, format is fixed.

  2. The mustache template here gives 2 context fields (index, indexUuid) to be used in snapshot name.
    e.x. "snapshot": "my_snapshot_{{ctx.index}}"

3

I have another related question.
If I wanted indices to apply the ISM policy upon creation, how would I go about configuring the index template?

Also, could I attach multiple ISM policies to a single index?

4

If I wanted indices to apply the ISM policy upon creation, how would I go about configuring the index template?

Read the documentation:

After you create a policy, your next step is to attach it to an index or indexes. You can set up an ism_template in the policy so when an index that matches the ISM template pattern is created, the plugin automatically attaches the policy to the index.

It looks like if you specify the index_patterns key in the ism_template field in the ISM policy, it’ll auto-detect indices which match the index patterns and apply the policy to the index.

5

Looks like 2.5 introduces new pages in Dashboards for snapshot management.