es_mgmt

Unified Elasticsearch tools library: client construction, waiters, checkpointed list actions, and related helpers.

Overview

• Client: create_client with schema validation
• Wait: Health, Exists, Relocate, Restore, Snapshot, Task, ILM phase/step
• Checkpoint: Workbook / Job / Step and ActionRun
• Index actions: open, close, delete, data-stream delete/rollover, settings, shrink, reindex, ILM confirm, …
• Snapshot: SnapshotTool and snapshot list actions
• Reindex: ReindexTask / ReindexMonitor
• Redact: RedactIlm (clone / apply / confirm)
• Docker: ElasticsearchDocker for tests
• Select: es_mgmt.select pattern/alias/query/data_stream/snapshot_indices name lists; PatternFilter + target="snapshot" lists snapshot names
• CLI extra: es-mgmt[cli] Click option kit (es_mgmt.client.cli)
• Utils: lists, chunking, config helpers

Installation

From source:

cd /path/to/es-mgmt
uv sync

Quick Start

from es_mgmt.client import create_client
from es_mgmt.checkpoint import ActionRun, EventBus
from es_mgmt.index.actions import OpenIndices
from es_mgmt.wait import Health

client = create_client(
    {"elasticsearch": {"client": {"hosts": ["http://localhost:9200"]}}}
)

Health(client).wait()

wb = ActionRun(client, EventBus(), "es-checkpoint").run(
    OpenIndices(), ["logs-1", "logs-2"]
)

Modules

Client (es_mgmt.client)

from es_mgmt.client import create_client, ConfigParser, validate_config

config = validate_config(
    {"elasticsearch": {"client": {"hosts": ["http://localhost:9200"]}}}
)
client = create_client(config)

Wait (es_mgmt.wait)

from es_mgmt.wait import Exists, Health, IlmPhase, Relocate, Restore, Snapshot, Task

Exists(client, index="my_index").wait()
Health(client, check_type="status").wait()
Task(client, task_id="my_task_id").wait()

Checkpoint (es_mgmt.checkpoint)

from es_mgmt.checkpoint import ActionRun, EventBus
from es_mgmt.index.actions import OpenIndices

run = ActionRun(client, EventBus(), "es-checkpoint")
workbook = run.run(OpenIndices(), ["logs-1", "logs-2"])
# Journal writes: ActionRun(..., persist=True)

Snapshot (es_mgmt.snapshot)

from es_mgmt.snapshot import SnapshotTool

tool = SnapshotTool(client)
tool.snapshot("my_snapshot", repository="my_repo")

Reindex (es_mgmt.reindex)

from es_mgmt.reindex import ReindexTask, ReindexMonitor

task = ReindexTask(client, task_id="abc123")
task.wait_for_completion()

Index (es_mgmt.index)

List actions such as OpenIndices, CloseIndices, DeleteIndices, ConfirmIlmPhase, PromoteIlm. Run them through ActionRun.

Redact (es_mgmt.redact)

from es_mgmt.redact import RedactIlm

RedactIlm(client, EventBus(), "es-checkpoint").run(source_index, mounted_index)

es_mgmt.redact exports RedactFields.

Cluster (es_mgmt.cluster)

es_mgmt.cluster exports SetClusterRouting.

Select (es_mgmt.select)

from es_mgmt.select import PatternFilter, SelectContext, apply_filters

ctx = SelectContext(client=client, target="index")
names = apply_filters(ctx, [PatternFilter(pattern_kind="prefix", value="logs-")])

Docker (es_mgmt.docker)

ElasticsearchDocker() uses docker.elastic.co/elasticsearch/elasticsearch:9.5.2 by default. Override with ES_MGMT_DOCKER_IMAGE.

from es_mgmt.docker import ElasticsearchDocker

docker = ElasticsearchDocker()
docker.start()
client = docker.get_client()

Utils (es_mgmt.utils)

from es_mgmt.utils import (
    chunk_names, ensure_list, get_version,
    log_exception, pluralize, redact, to_bool, to_int, to_str,
    ConfigManager, load_config, save_config
)

get_version() works only when the es-mgmt distribution is installed.

Testing

cd /path/to/es-mgmt
uv run pytest tests/unit -v

Docker-marked tests need a local Docker daemon.

Building

cd /path/to/es-mgmt
uv build

Dependencies

• elasticsearch9>=9.0.0
• pydantic>=2.0.0
• pyyaml>=6.0
• tiered_debug>=1.5.1

License

Apache 2.0

Author

Aaron Mildenstein