Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›Инструменты командной строки

elasticsearch-keystore

Команда elasticsearch-keystore управляет настройками безопасности в хранилище ключей Elasticsearch.

Синтаксис

bin/elasticsearch-keystore
( [add <settings>] [-f] [--stdin]
| [add-file (<setting> <path>)+]
| [create] [-p]
| [has-passwd]
| [list]
| [passwd]
| [remove <setting>]
| [show [-o <output-file>] <setting>]
| [upgrade]
) [-h, --help] ([-s, --silent] | [-v, --verbose])

Описание

Эту команду необходимо запускать от пользователя, под которым будет выполняться Elasticsearch.

В настоящее время все настройки безопасности являются узловыми настройками, которые должны иметь одинаковое значение на каждом узле. Поэтому вам необходимо запустить эту команду на каждом узле.

Если хранилище ключей защищено паролем, вам необходимо каждый раз при запуске Elasticsearch указывать пароль.

Изменения в хранилище ключей не применяются автоматически к работающему узлу Elasticsearch. Любые изменения в хранилище ключей вступят в силу при перезапуске Elasticsearch. Некоторые настройки безопасности можно явно перезагрузить без перезапуска.

Только некоторые настройки предназначены для чтения из хранилища ключей. Однако нет проверки, чтобы предотвратить использование неподдерживаемых настроек из хранилища ключей, что может привести к невозможности запуска Elasticsearch. Чтобы узнать, поддерживается ли настройка в хранилище ключей, см. справку по настройке.

Параметры

add <settings>
Добавляет настройки в хранилище ключей. Несколько имен настроек могут быть указаны в качестве аргументов к команде add. По умолчанию вам будет предложено ввести значения настроек. Если хранилище ключей защищено паролем, вам также будет предложено ввести пароль. Если настройка уже существует в хранилище ключей, вам необходимо подтвердить, что вы хотите перезаписать текущее значение. Если хранилище ключей не существует, вам необходимо подтвердить, что вы хотите создать хранилище ключей. Чтобы избежать этих двух запросов подтверждения, используйте параметр -f.
add-file (<setting> <path>)+
Добавляет файлы в хранилище ключей.
create
Создает хранилище ключей.
-f, --force
При использовании с параметром add команда больше не запрашивает подтверждение перед перезаписью существующих записей в хранилище ключей. Кроме того, если хранилище ключей еще не создано, оно создает хранилище ключей, которое зашифровано, но не защищено паролем.
-h, --help
Возвращает все параметры команды.
has-passwd
Возвращает сообщение об успехе, если хранилище ключей существует и защищено паролем. В противном случае команда завершается с кодом выхода 1 и возвращает сообщение об ошибке.
list
Выводит список настроек в хранилище ключей. Если хранилище ключей защищено паролем, вам будет предложено ввести пароль.
-p
При использовании с параметром create команда попросит вас ввести пароль хранилища ключей. Если вы не укажете флаг -p или введёте пустой пароль, хранилище ключей будет зашифровано, но не защищено паролем.
passwd
Изменяет или устанавливает пароль хранилища ключей. Если хранилище ключей защищено паролем, вам будет предложено ввести текущий пароль и новый. Вы можете по желанию использовать пустую строку для удаления пароля. Если хранилище ключей не защищено паролем, вы можете использовать эту команду для установки пароля.
remove <settings>
Удаляет настройки из хранилища ключей. Несколько имен настроек могут быть указаны в качестве аргументов к команде remove.
show <setting>
Отображает значение одной настройки в хранилище ключей. Передайте параметр -o (или --output), чтобы записать настройку в файл. Если запись производится в стандартный вывод (терминал), значение настройки всегда интерпретируется как строка UTF-8. Если настройка содержит двоичные данные (например, данные, добавленные с помощью команды add-file), всегда используйте параметр -o, чтобы записать в файл.
-s, --silent
Показывает минимальный вывод.
-x, --stdin
При использовании с параметром add вы можете передать значения настроек через стандартный ввод (stdin). Разделяйте несколько значений символами возврата каретки или новой строки. См. Добавление настроек в хранилище ключей.
upgrade
Обновляет внутренний формат хранилища ключей.
-v, --verbose
Показывает подробный вывод.

Примеры

Создание хранилища ключей

Чтобы создать хранилище ключей, используйте команду create:

bin/elasticsearch-keystore create -p

Вам будет предложено ввести пароль хранилища ключей. Файл, защищенный паролем elasticsearch.keystore, будет создан вместе с файлом elasticsearch.yml.

Изменение пароля хранилища ключей

Чтобы изменить пароль хранилища ключей, используйте команду passwd:

bin/elasticsearch-keystore passwd

Если хранилище ключей Elasticsearch защищено паролем, вам будет предложено ввести текущий пароль, а затем новый. Если хранилище ключей не защищено паролем, вам будет предложено установить пароль.

Список настроек в хранилище ключей

Чтобы вывести список настроек в хранилище ключей, используйте команду list.

bin/elasticsearch-keystore list

Если хранилище ключей Elasticsearch защищено паролем, вам будет предложено ввести пароль.

Добавление настроек в хранилище ключей

Конфиденциальные строковые настройки, такие как учетные данные аутентификации для плагинов облачных сервисов, могут быть добавлены с помощью команды add:

bin/elasticsearch-keystore add the.setting.name.to.set

Вам будет предложено ввести значение настройки. Если хранилище ключей Elasticsearch защищено паролем, вам также будет предложено ввести пароль.

Вы также можете добавить несколько настроек с помощью команды add:

bin/elasticsearch-keystore add \
  the.setting.name.to.set \
  the.other.setting.name.to.set

Вам будет предложено ввести значения настроек. Если хранилище ключей Elasticsearch защищено паролем, вам также будет предложено ввести пароль.

Чтобы передать значения настроек через стандартный ввод (stdin), используйте флаг --stdin:

cat /file/containing/setting/value | bin/elasticsearch-keystore add --stdin the.setting.name.to.set

Значения для нескольких настроек должны быть разделены символами возврата каретки или новой строки.

Добавление файлов в хранилище ключей

Вы можете добавить конфиденциальные файлы, такие как файлы ключей аутентификации для плагинов облачных сервисов, с помощью команды add-file. Настройки и пути к файлам указываются парами, состоящими из setting path. Значением настройки будет двоичное содержимое пути к файлу в момент добавления файла в хранилище ключей.

bin/elasticsearch-keystore add-file the.setting.name.to.set /path/example-file.json

Вы можете добавить несколько файлов с помощью команды add-file:

bin/elasticsearch-keystore add-file \
  the.setting.name.to.set /path/example-file.json \
  the.other.setting.name.to.set /path/other-example-file.json

Если хранилище ключей Elasticsearch защищено паролем, вам будет предложено ввести пароль.

Отображение настроек в хранилище ключей

Чтобы отобразить значение настройки в хранилище ключей, используйте команду show:

bin/elasticsearch-keystore show the.name.of.the.setting.to.show

Если настройка содержит двоичные данные, вы должны записать ее в файл с помощью параметра -o (или --output):

bin/elasticsearch-keystore show -o my_file binary.setting.name

Если хранилище ключей Elasticsearch защищено паролем, вам будет предложено ввести пароль.

Удаление настроек из хранилища ключей

Чтобы удалить настройку из хранилища ключей, используйте команду remove:

bin/elasticsearch-keystore remove the.setting.name.to.remove

Вы также можете удалить несколько настроек с помощью команды remove:

bin/elasticsearch-keystore remove \
  the.setting.name.to.remove \
  the.other.setting.name.to.remove

Если хранилище ключей Elasticsearch защищено паролем, вам будет предложено ввести пароль.

Обновление хранилища ключей

Иногда внутренний формат хранилища ключей меняется. При установке Elasticsearch из менеджера пакетов обновление хранилища ключей на диске до нового формата выполняется во время обновления пакета. В других случаях Elasticsearch выполняет обновление во время запуска узла. Это требует, чтобы Elasticsearch имел права записи в каталог, содержащий хранилище ключей. В качестве альтернативы вы можете вручную выполнить такое обновление, используя команду upgrade:

bin/elasticsearch-keystore upgrade

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/elasticsearch-keystore.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API