https://github.com/elastic/curator

Curator: Tending your Elasticsearch indices
https://github.com/elastic/curator

Last synced: 3 days ago
JSON representation

Curator: Tending your Elasticsearch indices

• Host: GitHub
• URL: https://github.com/elastic/curator
• Owner: elastic
• License: other
• Created: 2013-08-20T05:45:34.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-12-05T23:52:51.000Z (6 days ago)
• Last Synced: 2024-12-08T19:18:57.815Z (4 days ago)
• Language: Python
• Homepage:
• Size: 3.81 MB
• Stars: 3,046
• Watchers: 409
• Forks: 635
• Open Issues: 117
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-modern-devops - Curator - Tending your Elasticsearch indices. (Search)
• awesome-elastic-resources - Link
• awesome-starts - elastic/curator - Curator: Tending your Elasticsearch indices (Python)

README

        
.. _readme:

Curator

=======

Have indices in Elasticsearch? This is the tool for you!

Like a museum curator manages the exhibits and collections on display,

Elasticsearch Curator helps you curate, or manage your indices.

ANNOUNCEMENT

------------

Curator is breaking into version dependent releases. Curator 6.x will work with

Elasticsearch 6.x, Curator 7.x will work with Elasticsearch 7.x, and when it is

released, Curator 8.x will work with Elasticsearch 8.x.

Watch this space for updates when that is coming.

New Client Configuration

------------------------

Curator now connects using the ``es_client`` Python module. This separation makes it much easier

to update the client connection portion separate from Curator. It is largely derived from the

original Curator client configuration, but with important updates.

The updated configuration file structure requires ``elasticsearch`` at the root level::

    ---

    elasticsearch:

      client:

        hosts: https://10.11.12.13:9200

        cloud_id:

        bearer_auth:

        opaque_id:

        request_timeout: 60

        http_compress:

        verify_certs:

        ca_certs:

        client_cert:

        client_key:

        ssl_assert_hostname:

        ssl_assert_fingerprint:

        ssl_version:

      other_settings:

        master_only:

        skip_version_test:

        username:

        password:

        api_key:

          id:

          api_key:

    logging:

      loglevel: INFO

      logfile: /path/to/file.log

      logformat: default

      blacklist: []

Action File Configuration

-------------------------

Action file structure is unchanged, for now. A few actions may have had the options modified a bit.