CURATOR(1)

📦 version 9.0.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 CURATOR(1) — like, the manual page for curator, bestie 💖

okay so welcome to the group chat, the topic today is curator — she's an Elasticsearch time-series index manager and she's booked and busy. this page lives in the User Commands section, and honestly? iconic. let's get into it 🦋

✨ NAME ✨

curator — Elasticsearch time-series index manager 🌸

the way she literally just manages your time-series indices. main character energy fr fr.

🌈 SYNOPSIS 🌈

curator [--config CONFIG.YML] [--dry-run] ACTION_FILE.YML

that's the whole vibe. config optional, dry-run optional, action file very much required 💅

🎀 DESCRIPTION 🎀

so curator helps you manage Elasticsearch time-series indices, and she makes it so easy, no cap. she gives you a chill way to do all your index admin tasks, like:

  • managing aliases
  • optimizing indices
  • changing the replica count
  • modifying index allocation using routing tags

like she just handles it. obsessed. 💖

✨ OPTIONS ✨

  • -h, --help — shows you the program usage and then dips out. your lil "wait what do i type" bestie 🫶
  • -v, --version — shows the program's version number and exits. identity check, slay 💅
  • --config PATH — the path to your configuration file. Default: ~/.curator/curator.yml — that's her home base 🏠
  • --dry-run — literally does not perform any changes. it's giving "just looking, not buying" 🙈 perfect for a vibe check before you commit.
okay so ACTION_FILE is a YAML curator action file. for more info on action files, go consult /usr/share/doc/elasticsearch-curator/reference.txt.gz — it's all in there, iykyk 📖

🔥 EXIT CODES 🔥

the exit codes will tell you if things went good or if things went bad:

  • 0 — Success 🎉 ate and left no crumbs
  • 1 — Failure 😭 we do not love this
  • -1 — an exception was raised that does not result in an exit code of 1 💀

🌸 SEE ALSO 🌸

more docs for curator can be found at the project's wiki at https://github.com/elasticsearch/curator/wiki and, on Debian systems, under /usr/share/doc/elasticsearch-curator/reference.txt.gz. go read, bestie 🧚

👑 AUTHOR 👑

curator was originally written by Aaron Mildenstein <aaron@mildensteins.com>. she is currently maintained by Elasticsearch <http://www.elasticsearch.org/>. legends only, honestly.

this manual page was written by Apollon Oikonomopoulos <apoikos@debian.org> for the Debian project (but like, may be used by others too, she shares 💜).

⭐ LICENSE ⭐

this software is released under the Apache License, Version 2.0. see /usr/share/doc/elasticsearch-curator/copyright for more details.

Copyright 2011-2016 Elasticsearch and contributors.

and that's the whole page!! this was curator version 4.2, from December 2016, and that's the teaaaa 💅✨ thanks for coming to my ted talk, love u, bye 🎀🦋💖
📦 where this page comes from