{"id":15787156,"url":"https://github.com/tubemogul/puppet-curator","last_synced_at":"2025-03-14T11:31:33.561Z","repository":{"id":57665924,"uuid":"43489466","full_name":"tubemogul/puppet-curator","owner":"tubemogul","description":"Puppet module to deploy Elasticsearch Curator","archived":false,"fork":false,"pushed_at":"2017-06-16T15:05:43.000Z","size":39,"stargazers_count":2,"open_issues_count":1,"forks_count":5,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-10-11T21:44:44.341Z","etag":null,"topics":["curator","logstash","puppet-module"],"latest_commit_sha":null,"homepage":"https://forge.puppet.com/TubeMogul/curator","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tubemogul.png","metadata":{"files":{"readme":"README.markdown","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-01T09:56:11.000Z","updated_at":"2024-03-27T10:09:50.000Z","dependencies_parsed_at":"2022-09-14T13:01:22.402Z","dependency_job_id":null,"html_url":"https://github.com/tubemogul/puppet-curator","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tubemogul%2Fpuppet-curator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tubemogul%2Fpuppet-curator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tubemogul%2Fpuppet-curator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tubemogul%2Fpuppet-curator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tubemogul","download_url":"https://codeload.github.com/tubemogul/puppet-curator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243569649,"owners_count":20312474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["curator","logstash","puppet-module"],"created_at":"2024-10-04T21:05:52.224Z","updated_at":"2025-03-14T11:31:30.861Z","avatar_url":"https://github.com/tubemogul.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/tubemogul/puppet-curator.svg?branch=master)](https://travis-ci.org/tubemogul/puppet-curator)\n[![Puppet Forge latest release](https://img.shields.io/puppetforge/v/TubeMogul/curator.svg)](https://forge.puppetlabs.com/TubeMogul/curator)\n[![Puppet Forge downloads](https://img.shields.io/puppetforge/dt/TubeMogul/curator.svg)](https://forge.puppetlabs.com/TubeMogul/curator)\n[![Puppet Forge score](https://img.shields.io/puppetforge/f/TubeMogul/curator.svg)](https://forge.puppetlabs.com/TubeMogul/curator/scores)\n\n#### Table of Contents\n\n1. [Overview](#overview)\n2. [Module Description - What the module does and why it is useful](#module-description)\n3. [Setup - The basics of getting started with curator](#setup)\n    * [What curator affects](#what-curator-affects)\n    * [Setup requirements](#setup-requirements)\n    * [Beginning with curator](#beginning-with-curator)\n4. [Usage - Configuration options and additional functionality](#usage)\n5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n## Overview\n\nThis module manages Elasticsearch Curator (https://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html)\n\n## Module Description\n\nThe module will install Curator via the Python PIP package and manage the cronjobs to schedule different Curator commands.\n\nSee the official Curator documentation for more details : https://www.elastic.co/guide/en/elasticsearch/client/curator/current/commands.html\n\n## Setup\n\n### What curator affects\n\n* Install Python PIP if not present\n* Install elasticsearch-curator PIP package\n* Change the crontab\n\n### Setup Requirements\n\n* puppetlabs/stdlib\n\n### Beginning with curator\n\nSee : https://www.elastic.co/guide/en/elasticsearch/client/curator/current/getting-started.html\n\n## Usage\n\n### Install Curator\n\n```puppet\nclass { 'curator': }\n```\n\n### Install Curator with a specific version and deploy jobs\n\n```puppet\nclass { 'curator':\n  version =\u003e '3.3.0',\n  crons   =\u003e {\n    'logstash-cleanup' =\u003e {\n      command     =\u003e 'delete',\n      subcommand  =\u003e 'indices',\n      parameters  =\u003e \"--time-unit days --older-than 7 --timestring '\\%Y.\\%m.\\%d' --prefix logstash-\",\n      cron_minute =\u003e 0,\n      cron_hour   =\u003e 0,\n    }\n  }\n}\n```\n\n### Example using Hiera\n\n```puppet\nclass { 'curator': }\n```\n\n```yaml\n---\ncurator::version: 3.3.0\ncurator::crons:\n  logstash:\n    command: 'delete'\n    subcommand: 'indices'\n    parameters: \"--time-unit hours --older-than 7 --timestring '\\\\%Y.\\\\%m.\\\\%d.\\\\%H' --prefix logstash-\"\n    cron_minute: '30'\n    cron_hour: '*/1'\n  puppet-report:\n    command: 'delete'\n    parameters: \"--time-unit days --older-than 14 --timestring \\\\%Y.\\\\%m.\\\\%d --prefix puppet-report-\"\n```\n\n\n## Limitations\n\nThis module has been tested on Ubuntu and should work on Redhat/CentOS too.\n\nFor 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.\n\n## Development\n\nSee the CONTRIBUTING.md file. Pull requests are welcome :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftubemogul%2Fpuppet-curator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftubemogul%2Fpuppet-curator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftubemogul%2Fpuppet-curator/lists"}