diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 96f6b74a303dbf648db6e68ed05ffbe2ba5ead24..807c182690f0ac952ab3b7dadddf31886d443d84 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -8,7 +8,7 @@ Picodata ÑвлÑетÑÑ ÐºÐ¾Ð½Ñольным приложением, кото ÐŸÐ¾Ð»Ð½Ð°Ñ Ñправка доÑтупна Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ команды `picodata help`: -```txt +```text USAGE: picodata <SUBCOMMAND> @@ -24,6 +24,7 @@ SUBCOMMANDS: help Print this message or the help of the given subcommand(s) plugin Subcommand related to plugin management run Run the picodata instance + status Display the status of all instances in the cluster test Run picodata integration tests ``` @@ -678,3 +679,90 @@ picodata plugin configure --service-names service_1,service_2 ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_SERVICE_PASSWORD_FILE`<br> Ðналогичный параметр файла конфигурации: [`instance.service_password_file`] + +## picodata status {: #status } + +Выводит ÑÑ‚Ð°Ñ‚ÑƒÑ Ð²Ñех инÑтанÑов в клаÑтере. + +``` +picodata status [OPTIONS] +``` + +Ð¡Ñ‚Ð°Ñ‚ÑƒÑ Ð¸Ð½ÑтанÑа Ñодержит Ñледующие параметры: + +* `instance_name` — Ð¸Ð¼Ñ Ð¸Ð½ÑтанÑа +* `current_state` — текущее ÑоÑтоÑние инÑтанÑа +* `target_state` — целевое ÑоÑтоÑние инÑтанÑа +* `instance_uuid` — [UUID] инÑтанÑа +* `replicaset_uuid` — [UUID] репликаÑета, которому принадлежит инÑÑ‚Ð°Ð½Ñ +* `tier` — Ð¸Ð¼Ñ Ñ‚Ð¸Ñ€Ð°, которому принадлежит инÑÑ‚Ð°Ð½Ñ +* `uri` — публичный Ñетевой Ð°Ð´Ñ€ÐµÑ Ð¸Ð½ÑтанÑа + +[UUID]: sql_types.md#uuid + +**Пример** + +```text +$ picodata status +Enter password for pico_service: + + +CLUSTER NAME: demo + + ++-----------+-----------+-----------+----------+----------+---------+----------+ +| instance_ | current_s | target_st | instance | replicas | tier | uri | +| name | tate | ate | _uuid | et_uuid | | | ++==============================================================================+ +| default_1 | ["Online" | ["Online" | 38307bf4 | 50c2ed56 | default | 127.0.0. | +| _1 | , 1] | , 1] | -33ec-47 | -ccd1-49 | | 1:3301 | +| | | | 44-b830- | 73-b9f2- | | | +| | | | 8262a58d | 8aec11d8 | | | +| | | | cc9a | dff5 | | | ++-----------+-----------+-----------+----------+----------+---------+----------+ +(1 rows) +``` + +!!! note "Примечание" + По умолчанию паролем ÑиÑтемного Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ `pico_service` ÑвлÑетÑÑ + пуÑÑ‚Ð°Ñ Ñтрока. + +### --peer {: #status_peer } + +`--peer <[HOST][:PORT]>` + +ÐÐ´Ñ€ÐµÑ Ð»ÑŽÐ±Ð¾Ð³Ð¾ инÑтанÑа из ÑоÑтава клаÑтера. + +Значение по умолчанию: `127.0.0.1:3301` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_PEER`<br> +Ðналогичный параметр файла конфигурации: [`instance.peer`] + +### --service-password-file {: #status_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`] + +### --timeout {: #status_timeout } + +`-t, --timeout <TIMEOUT>` + +МакÑимальное Ð²Ñ€ÐµÐ¼Ñ Ð¾Ð±Ñ€Ð°Ð±Ð¾Ñ‚ÐºÐ¸ запроÑа в Ñекундах. + +Значение по умолчанию: `5` + +ÐÐ½Ð°Ð»Ð¾Ð³Ð¸Ñ‡Ð½Ð°Ñ Ð¿ÐµÑ€ÐµÐ¼ÐµÐ½Ð½Ð°Ñ Ð¾ÐºÑ€ÑƒÐ¶ÐµÐ½Ð¸Ñ: `PICODATA_CONNECT_TIMEOUT` + +**Пример** + +``` +picodata status -t 10 +```