Forge Home

curator

Installs, configures, and manages Elasticsearch Curator.

59,808 downloads

2,469 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.9 (latest)
  • 1.0.8
  • 1.0.7
  • 1.0.5
  • 1.0.4
  • 1.0.2
  • 1.0.1
released Jul 31st 2022
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.3.0 < 8.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'mvisonneau-curator', '1.0.9'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install mvisonneau-curator --version 1.0.9

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

mvisonneau/curator — version 1.0.9 Jul 31st 2022

puppet-curator

Puppet Forge Puppet Forge downloads Puppet Forge score test

This module installs, configures, and manages curator, an elastic product that allows management of an elasticsearch cluster indices.

It has been inspired of the jlambert121-curator module but designed to support curator > 4.x

Usage

This is a example usage of how you can use this module

Include the main class


include ::curator

Define an action


curator::action { 'purge_logstash_over_45_days':
  entities => {
    1 => {
      'action' => 'delete_indices',
      'description' => 'Delete indices older than 45 days (based on index name)',
      'options' => {
        'continue_if_exception' => 'True',
        'disable_action'        => 'False',
        'ignore_empty_list'     => 'True',
      },
      'filters' => [
        {
          'filtertype' => 'pattern',
          'kind'       => 'prefix',
          'value'      => 'logstash-',
        },
        {
          'filtertype' => 'age',
          'source'     => 'name',
          'direction'  => 'older',
          'timestring' => '%Y.%m.%d',
          'unit'       => 'days',
          'unit_count' => '45',
        },
      ],
    },
  },
}

Define a job that automates the trigger of the action


curator::job { 'purge_logstash_over_45_days_everyday':
  action => 'purge_logstash_over_45_days',
  minute => 0,
  hour   => 2,
}

Builtin Hiera support

You can also directly use hiera in order to manage your resources :

  • Include those additionnal classes in Puppet

include ::curator::actions
include ::curator::jobs

  • And then in Hiera :

curator::actions::values:
  'purge_logstash_over_45_days':
    entities:
      1:
        action: delete_indices
        description: Delete indices older than 45 days (based on index name)
        options:
          continue_if_exception: 'True'
          disable_action: 'False'
          ignore_empty_list: 'True'
        filters:
          - filtertype: pattern
            kind: prefix
            value: logstash-
          - filtertype: age
            source: name
            direction: older
            timestring: '%Y.%m.%d'
            unit: days
            unit_count: '45'

curator::jobs::values:
  'purge_logstash_over_45_days_everyday':
    action: 'purge_logstash_over_45_days'
    minute: 0
    hour: 2

Limitations

This module has been built on and tested from Puppet 4.3 up to 7.14.

The module has been tested on:

  • Debian 7 -> 11
  • RHEL/CentOS 6/7
  • Ubuntu 14 -> 20

Testing on other platforms has been light and cannot be guaranteed.

Contributing

Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint to follow the recommended Puppet style guidelines from the Puppet Labs style guide.