Skip to content
untergeek edited this page Sep 24, 2014 · 40 revisions

Curator Documentation

Like a museum curator manages the exhibits and collections on display, Elasticsearch Curator helps you curate, or manage your time-series indices.

Curator API Documentation (External)

The documentation in this wiki is intended to bridge the Curator API documentation and the functionality provided by the entry-point script usually installed by pip as /usr/bin/curator or /usr/local/bin/curator. Since Curator 2.0, this entry-point script points to curator_script.py which, once installed, resides in the dist-packages/curator path for your particular Python installation. The endtry-point enables this script to still be callable as curator in order to preserve reverse-compatibility with your previous command structure.

Since Curator 2.0, the API calls and the wrapper script (curator_script.py) have been separated. This allows you to write your own scripts to accomplish similar goals, or even new and different things with the Curator API, and the Elasticsearch Python API.

Curator Script Documentation (this wiki)

The wiki, being extensible, can contain information about both the API and the script. Unless otherwise specified, however, this wiki documentation should be presumed to refer to the behavior of the Curator script, with commands like:

delete
optimize
close
snapshot
alias

…and more!

Browse through the documentation here for more information.

Usage

Commands

Flags and settings

Errata

Clone this wiki locally