diff --git a/docs/reference/cli.md b/docs/reference/cli.md index ecbab0c7248943761d996ce0e50ce31f24e08cad..85b4d4c215aa862228a69d64f50612ff3c405c72 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -24,6 +24,7 @@ SUBCOMMANDS: connect Connect to the Distributed SQL console expel Expel node from cluster help Print this message or the help of the given subcommand(s) + plugin Subcommand related to plugin management run Run the picodata instance test Run picodata integration tests ``` @@ -627,3 +628,56 @@ picodata expel [OPTIONS] <INSTANCE_UUID> иÑключение инÑтанÑа `i3`. Когда процеÑÑ `picodata` на i3 завершитÑÑ â€” Ñервер можно выключать. --> + +<!-- ********************************************************************** --> +## picodata plugin configure {: #plugin_configure } +<!-- ********************************************************************** --> + +ОбновлÑет конфигурацию [ÑервиÑа][s] указанного [плагина][p] на вÑех +инÑтанÑах клаÑтера. + +ВызываетÑÑ Ð¾Ð´Ð¸Ð½ раз на любом инÑтанÑе. + +``` +picodata plugin configure <ADDRESS> <PLUGIN_NAME> <PLUGIN_VERSION> <PLUGIN_CONFIG> +``` + +- `ADDRESS`: ÐÐ´Ñ€ÐµÑ Ð¸Ð½ÑтанÑа в формате `[host][:port]` Ð´Ð»Ñ Ð¿Ð¾Ð´ÐºÐ»ÑŽÑ‡ÐµÐ½Ð¸Ñ + ÑиÑтемного Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ `pico_service` +- `PLUGIN_NAME`: Ð˜Ð¼Ñ Ð¿Ð»Ð°Ð³Ð¸Ð½Ð°, Ñодержащего обновлÑемый ÑÐµÑ€Ð²Ð¸Ñ +- `PLUGIN_VERSION`: ВерÑÐ¸Ñ Ð¿Ð»Ð°Ð³Ð¸Ð½Ð°, Ñодержащего обновлÑемый ÑÐµÑ€Ð²Ð¸Ñ +- `PLUGIN_CONFIG`: Путь к файлу Ñ Ð½Ð¾Ð²Ð¾Ð¹ конфигурацией обновлÑемого ÑервиÑа + в формате YAML. ÐšÐ¾Ð½Ñ„Ð¸Ð³ÑƒÑ€Ð°Ñ†Ð¸Ñ ÑоответÑтвует [манифеÑту][m] плагина, за + иÑключением полей `name` и `description`. Ð’ файле конфигурации доÑтаточно + указать лишь изменÑемые параметры + +[s]: ../overview/glossary.md#service +[p]: ../overview/glossary.md#plugin +[m]: ../architecture/plugins.md#manifest + +### --service-names {: #plugin_configure_service_names } + +`--service-names <SERVICE_NAMES>` + +СпиÑок имен ÑервиÑов, разделенных запÑтыми, конфигурацию которых нужно +обновить. ЕÑли в новой конфигурации отÑутÑтвует Ñ…Ð¾Ñ‚Ñ Ð±Ñ‹ одно Ð¸Ð¼Ñ Ð¸Ð· данного +ÑпиÑка, будет выведена ошибка. + +**Пример** + +``` +picodata plugin configure --service-names service_1,service_2 +``` + +### --service-password-file {: #plugin_configure_service_password_file } + +`--service-password-file <SERVICE_PASSWORD_FILE>` + +Путь к файлу Ñ Ð¿Ð°Ñ€Ð¾Ð»ÐµÐ¼ Ð´Ð»Ñ ÑиÑтемного Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ `pico_service`. Ðтот +пароль иÑпользуетÑÑ Ð´Ð»Ñ Ð²Ð·Ð°Ð¸Ð¼Ð¾Ð´ÐµÐ¹ÑÑ‚Ð²Ð¸Ñ Ñ Ð´Ñ€ÑƒÐ³Ð¸Ð¼Ð¸ инÑтанÑами клаÑтера и +ÑвлÑетÑÑ Ð¾Ð´Ð¸Ð½Ð°ÐºÐ¾Ð²Ñ‹Ð¼ Ð´Ð»Ñ Ð²Ñех инÑтанÑов. При неÑовпадении Ð¿Ð°Ñ€Ð¾Ð»Ñ Ð±ÑƒÐ´ÐµÑ‚ +выведена ошибка. При отÑутÑтвии параметра пароль будет запрошен в +интерактивном режиме, Ñм. [БезопаÑный запуÑк](../tutorial/run.md#secure_run). + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_SERVICE_PASSWORD_FILE`<br> +Ðналогичный параметр файла конфигурации: [`instance.service_password_file`]