<commit_before>[![Puppet Forge](http://img.shields.io/puppetforge/v/evenup/curator.svg)](https://forge.puppetlabs.com/evenup/curator)
[![Build Status](https://travis-ci.org/evenup/evenup-curator.png?branch=master)](https://travis-ci.org/evenup/evenup-curator)

#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with curator](#setup)
    * [What curator affects](#what-curator-affects)
    * [Beginning with curator](#beginning-with-curator)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
8. [Changelog/Contributors](#changelog-contributors)


## Overview

A puppet module for installing and configuring [elastic-curator](https://github.com/elastic/curator).

## Module Description

Curator is used to manaage and clean up time-series elasticsearch indexes, this module manages curator.

NOTE: If you are using curator < 3.0.0 use a previous version of this module.


## Setup

### What curator affects
<commit_msg>fix typo in readme<commit_after>[![Puppet Forge](http://img.shields.io/puppetforge/v/evenup/curator.svg)](https://forge.puppetlabs.com/evenup/curator)
[![Build Status](https://travis-ci.org/evenup/evenup-curator.png?branch=master)](https://travis-ci.org/evenup/evenup-curator)

#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with curator](#setup)
    * [What curator affects](#what-curator-affects)
    * [Beginning with curator](#beginning-with-curator)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
8. [Changelog/Contributors](#changelog-contributors)


## Overview

A puppet module for installing and configuring [elastic-curator](https://github.com/elastic/curator).

## Module Description

Curator is used to manage and clean up time-series elasticsearch indexes, this module manages curator.

NOTE: If you are using curator < 3.0.0 use a previous version of this module.


## Setup

### What curator affects

{'fraction_non_alphanumeric': 0.12996108949416343, 'fraction_numerical': 0.008560311284046693, 'mean_word_length': 4.951388888888889, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1132857', 'n_tokens_mistral': 838, 'n_tokens_neox': 765, 'n_words': 233}