По-умолчанию предполагается использование config.yaml в котором описаны параметры запуска. Для автоматического выполнения команд можно использовать параметр action.
Все, что указано в конфгиах можно переопределять через флаги, а также большинство команд поддерживают --dry-run.
# Создать config.yaml с нужной командой
cat > config.yaml << EOF
action: "snapshots"
opensearch_url: "https://your-opensearch:9200"
cert_file: "/path/to/cert.pem"
key_file: "/path/to/key.pem"
EOF
# Запустить osctl - команда выполнится автоматически
osctl
osctl --dry-runosctl snapshots --config=custom_config.yaml --osctl-indices-config=custom_osctl_indices_config.yaml| Команда | Назначение |
|---|---|
snapshots |
Создание снапшотов согласно конфигурации |
snapshotsdelete |
Удаление снапшотов согласно конфигурации |
indicesdelete |
Удаление индексов согласно конфигурации |
snapshotschecker |
Нахождение отсутствующих снапшотов |
snapshot-manual |
Создание снапшотов по флагам |
retention |
Удаление индексов со снапшотами при превышении некоторого порога |
dereplicator |
Уменьшение числа реплик |
coldstorage |
Миграция в холодное хранилище |
extracteddelete |
Удаление extracted индексов |
danglingchecker |
Проверка dangling индексов |
sharding |
Автоматическое выставление оптимального числа шардов |
indexpatterns |
Управление index patterns в Kibana |
datasource |
Создание Kibana data-source |
Пример в config.yaml
Пример в config-example/osctlindicesconfig.yaml
Пример в config-example/osctltenants.yaml
- Флаги командной строки (наивысший приоритет)
- Переменные окружения
- Единый конфиг (
config.yaml) - Значения по умолчанию (наименьший приоритет)
- ENVIRONMENT_VARIABLES_AND_FLAGS.md - Полный справочник по всем флагам и переменным окружения
- ARCHITECTURE.md - Подробные алгоритмы и архитектура системы
- DEVELOPMENT.md - Как вносить изменения и вариант тестирования
- Встроенная справка:
osctl [команда] --help