What is the Curator?¶
Curator is a tool that allows you to define the criteria for triggering actions against the indexes in your Elasticsearch instance. At ObjectRocket, we’ve integrated Curator into our service so you can configure it via the UI and let us handle the day to day maintenance and execution of Curator itself.
Curator functions generally consist of actions to perform and filters to determine which index(es) to take action against. Today the actions that we support on ObjectRocket are:
- Delete: Delete the indices that match the specified filters
- Close: Close the indices that match the specified filters
- Create: Create a new index. Today, this must follow a Delete/Close action.
Curator Task options¶
Once you select your Elasticsearch instance from the ObjectRocket UI and select ‘Add Task’ under the Curator section, you’ll be presented with the following fields:
- Task Name: The name for the task. This is a required field and just a description of what this task will do.
- Task Type: You can select to Delete the indexes which match the filters, or Close them to writes and queries. This is a required field.
- Filter by age: Allows you to set a filter based on the age of the index. The age is based on the creation date of the index.
- Filter by name: Allows you to set a filter based on the naming convention or RegEx.
- Schedule: Determines how often to run Curator. The default is every 5 minutes, but tasks can also be scheduled to run at specific times.
- Create a new index…: If a Close or Delete event occurs, you have the option of creating a new index based on the name pattern provided.
You are required to select at least one of the filters and if both are selected, action will only be taken against indexes that match BOTH filters.
How often are the tasks run?¶
By default each task is run at least once every 5 minutes. If there are no indexes returned by the filters, no action is performed.
There is also an option to set a schedule to run Curator tasks at a specific time, such as:
- Every hour at the specified minute
- Every day at the specified time
- Every week at the specified day and time
- Every month on the specified day and time. If you select day 31, that task will run on the last day of the month in shorter months.