A newer version is available. For the latest information, see the current release documentation.

› ›

Installation

Summary

There are a few ways to install curator. This document covers a few of them. If you are trying to upgrade curator, please see Upgrading.

pip (recommended)

edit

The recommended installation procedure utilizes python pip:

pip install elasticsearch-curator

PIP installation of a specific version:

edit

pip install elasticsearch-curator==3.4.1

Any other version-sepecific installation will follow this basic pattern.

Installation: PIP installation from source

edit

Download and install the urllib3 dependency (1.8.3 or greater):

wget https://pypi.python.org/packages/source/u/urllib3/urllib3-1.12.tar.gz
pip install urllib3-1.12.tar.gz

Download and install the click dependency (3.3 or greater):

wget https://pypi.python.org/packages/source/c/click/click-6.2.tar.gz -O click-6.2.tar.gz
pip install click-6.2.tar.gz

Download and install the elasticsearch-py dependency:

wget https://github.com/elastic/elasticsearch-py/archive/2.2.0.tar.gz -O elasticsearch-py.tar.gz
pip install elasticsearch-py.tar.gz

Download and install Curator:

wget https://github.com/elastic/curator/archive/v3.4.1.tar.gz -O elasticsearch-curator.tar.gz
pip install elasticsearch-curator.tar.gz

APT repository

edit

Starting with Elasticsearch Curator 3.2.0, repositories are available for APT and YUM based distributions. Note that we only provide binary packages, but no source packages, as the packages are created as part of the build process.

We use the PGP key D88E42B4, Elastic’s Signing Key, with fingerprint

4609 5ACC 8548 582C 1A26 99A9 D27D 666C D88E 42B4

to sign all our packages. It is available from http://pgp.mit.edu.

Signing Key

edit

Download and install the Public Signing Key:

wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -

Repository Configuration

edit

Add the following in your /etc/apt/sources.list.d/ directory in a file with a .list suffix, for example curator.list

deb http://packages.elastic.co/curator/3/debian stable main

Use the file edit method described above to add the Curator repository. Do not use add-apt-repository as it will add a deb-src entry as well, but we do not provide a source package. If you have added the deb-src entry, you will see an error like the following:

Unable to find expected entry 'main/source/Sources' in Release file (Wrong sources.list entry or malformed file)

Just delete the deb-src entry from the /etc/apt/sources.list.d/curator.list file and the installation should work as expected.

Installation

edit

Run sudo apt-get update and the repository is ready for use. You can install it with:

sudo apt-get update && sudo apt-get install python-elasticsearch-curator

YUM repository

edit

We use the PGP key D88E42B4, Elastic’s Signing Key, with fingerprint

4609 5ACC 8548 582C 1A26 99A9 D27D 666C D88E 42B4

to sign all our packages. It is available from http://pgp.mit.edu.

Signing Key

edit

Download and install the public signing key:

rpm --import https://packages.elastic.co/GPG-KEY-elasticsearch

Repository Configuration

edit

Add the following in your /etc/yum.repos.d/ directory in a file with a .repo suffix, for example curator.repo

The repositories are different for CentOS/RHEL 6 and 7 due to python library path differences. Be sure to use the correct version!

RHEL/CentOS 6:

[curator-3]
name=CentOS/RHEL 6 repository for Elasticsearch Curator 3.x packages
baseurl=http://packages.elastic.co/curator/3/centos/6
gpgcheck=1
gpgkey=http://packages.elastic.co/GPG-KEY-elasticsearch
enabled=1

RHEL/CentOS 7:

[curator-3]
name=CentOS/RHEL 7 repository for Elasticsearch Curator 3.x packages
baseurl=http://packages.elastic.co/curator/3/centos/7
gpgcheck=1
gpgkey=http://packages.elastic.co/GPG-KEY-elasticsearch
enabled=1

Installation

edit

And your repository is ready for use. You can install it with:

yum install python-elasticsearch-curator

Troubleshooting

edit

There are some pitfalls you may encounter:

ImportError: No module named pkg_resources

If you see this error:

Traceback (most recent call last):
  File "/usr/bin/curator", line 5, in <module>
    from pkg_resources import load_entry_point
ImportError: No module named pkg_resources

Then you will need to install python-setuptools (provided in the Curator repository):

yum install python-setuptools

Requires: python-unittest2 (RHEL/CentOS 6 only)

If you see an error like this:
```
Error: Package: python-elasticsearch-1.6.0-1.noarch (curator-3)
           Requires: python-unittest2
```
Then you will need to install python-unittest2, which is available in the epel-release repository:
```
yum install epel-release
```
After this is installed, run the yum install python-elasticsearch-curator command again.

Windows Binary Package

edit

If you do not wish to install and maintain Python on Windows, there is a compiled binary version available. It is in a directory with EXE files and all necessary libraries that Python requires. You can navigate to the directory and run the curator and es_repo_mgr commands just as you otherwise would.

If you do have Python installed, do not uncompress the zip file into your Python directory. It can cause library path collisions which will prevent Curator from properly functioning.

Download Curator
- MD5
- SHA1

Experimental: Windows MSI Installer

edit

There is now a rudimentary MSI installer available for you to try. One known issue is that upgrades are not possible. Subsequent installs will be side-by-side. The recommended course of action is to uninstall the old version, then install the new one.

The installation will default to "C:\Program Files (x86)\elasticsearch-curator". The same binaries and libraries found in the Windows Binary Package will be installed into this directory.

Download Curator Installer
- MD5
- SHA1

« Getting Started Upgrading »