/lambda-curator

Lambda curator is a lambda function deletes old AWS ElasticSearch indices using curator.

Primary LanguagePythonApache License 2.0Apache-2.0

Lambda Curator

Lambda curator is a lambda function deletes old AWS ElasticSearch indices using curator.

All you need to do is tagging existing ES cluster.

Getting Started

Installation

It's as easy as launching a CloudFormation (or Terraform) stack and setting the prefix=retention_period tag on existing ES cluster. All the required infrastructure and configuration will be created automatically, so you can get started as fast as possible.

Launch

A single installation can handle all enabled clusters across all available AWS regions, but can be restricted to fewer regions if desired.

Usage

By adding one or more tags to existing ES cluster, you enabled lambda curator to manage it.

A tag should follow one pattern, which is prefix=retention_period.

ScreenShot

Example:

Key Value Comment
logstash- 7d indices starting with logstash- and older than 7 days will be deleted
curator.default 1m indices not matched by other prefixes and older than 1 month will be deleted

A manageable index name takes the following form:

^prefix-(\d{4}([-/.]w?\d{2}){,3})$

Example:

Index Comment
logstash-2018-02-01-01 OneHour Rotation
logstash-2018-02-01 OneDay Rotation
logstash-2018-02 OneMonth Rotation
logstash-2018-w02 OneWeek Rotation
logstash-2018 OneYear Rotation
logstash-2018.05.10 . as delimiter
logstash-2018/05/10 / as delimiter

A retention period takes the following form:

\d+[y|m|w|d|h]

Example:

Retention Comment
12h retain 12 hours
7d retain 7 days
1w retain 1 week
1m retain 1 month
1y retain 1 year

License

This software is distributed under the terms of the Apache-2.0 license.