fest/elasticsearch-curator repository overview

⁠elasticsearch-curator

This image provide data retention possibilities for Elasticsearch.

Sources: elasticsearch-curator⁠ · Dockerfile⁠ · monasca-docker⁠

⁠Tags

Images in this repository are tagged as follows:

• latest: refers to the latest stable point release, e.g. 5.8.3-0.0.1
• 5.8.3-0.0.1: a.k.a. [elasticsearch-curator version]-[image version]. In this case the image revision 0.0.1 has been built from a snapshot of Elasticsearch Curator 5.8.3
• fest/elasticsearch-curator:2.0.1, fest/elasticsearch-curator:2.1.2, etc. : old naming convention

⁠Usage

This image requires access to a running Elasticsearch instance.

If needed, connection parameters can be provided via environment variables as described below.

Example of configuration for Docker Compose that will delete indices that are older than 60 days:

elasticsearch-curator:
  image: monasca/elasticsearch-curator:latest
  environment:
    CURATOR_DELETE_BY_AGE: 60
    LOGSTASH_FIELDS: "service=elasticsearch-curator"
  depends_on:
    - elasticsearch

⁠Configuration

By default Elasticsearch Curator is running thanks to cron every day at 12 a.m.. You could get more information how to set it to different time at http://corntab.com⁠.

⁠Actions configuration

You are able to configure Elasticsearch Curator to delete oldest data by age and/or space. For example to delete indices older than 60 days or bigger than 5 GB set both variables:

CURATOR_DELETE_BY_AGE: 60
CURATOR_DELETE_BY_SPACE: 5

CURATOR_DELETE_BY_SPACE could contain number smaller than 1, like 0.05.

You can exclude specific index from processing with CURATOR_EXCLUDED_INDEX_NAME:

CURATOR_EXCLUDED_INDEX_NAME: .kibana