Forge Home

curator

Puppet Module for Elasticsearch Curator

28,170 downloads

7,928 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.1.0
released Jan 30th 2017
This version is compatible with:
  • , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'TubeMogul-curator', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add TubeMogul-curator
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install TubeMogul-curator --version 1.0.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

TubeMogul/curator — version 1.0.2 Jan 30th 2017

Build Status Puppet Forge latest release Puppet Forge downloads Puppet Forge score

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with curator
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module manages Elasticsearch Curator (https://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html)

Module Description

The module will install Curator via the Python PIP package and manage the cronjobs to schedule different Curator commands.

See the official Curator documentation for more details : https://www.elastic.co/guide/en/elasticsearch/client/curator/current/commands.html

Setup

What curator affects

  • Install Python PIP if not present
  • Install elasticsearch-curator PIP package
  • Change the crontab

Setup Requirements

  • puppetlabs/stdlib

Beginning with curator

See : https://www.elastic.co/guide/en/elasticsearch/client/curator/current/getting-started.html

Usage

Install Curator

class { 'curator': }

Install Curator with a specific version and deploy jobs

class { 'curator':
  version => '3.3.0',
  crons   => {
    'logstash-cleanup' => {
      command     => 'delete',
      subcommand  => 'indices',
      parameters  => "--time-unit days --older-than 7 --timestring '\%Y.\%m.\%d' --prefix logstash-",
      cron_minute => 0,
      cron_hour   => 0,
    }
  }
}

Example using Hiera

class { 'curator': }
---
curator::version: 3.3.0
curator::crons:
  logstash:
    command: 'delete'
    subcommand: 'indices'
    parameters: "--time-unit hours --older-than 7 --timestring '\\%Y.\\%m.\\%d.\\%H' --prefix logstash-"
    cron_minute: '30'
    cron_hour: '*/1'
  puppet-report:
    command: 'delete'
    parameters: "--time-unit days --older-than 14 --timestring \\%Y.\\%m.\\%d --prefix puppet-report-"

Limitations

This module has been tested on Ubuntu and should work on Redhat/CentOS too.

For Redhat/CentOS, you will need to deploy the EPEL repository before using the module (See : https://fedoraproject.org/wiki/EPEL). This module doesn't manage EPEL.

Development

See the CONTRIBUTING.md file. Pull requests are welcome :)