diff options
3 files changed, 98 insertions, 25 deletions
diff --git a/ydb/docs/ru/core/getting_started/_includes/cli.md b/ydb/docs/ru/core/getting_started/_includes/cli.md index 52233551f83..973d30987e1 100644 --- a/ydb/docs/ru/core/getting_started/_includes/cli.md +++ b/ydb/docs/ru/core/getting_started/_includes/cli.md @@ -55,10 +55,14 @@ ydb [Создайте профиль](../../reference/ydb-cli/profile/create.md) `db1` следующей командой: ```bash -{{ ydb-cli }} config profile create db1 +{{ ydb-cli }} config profile create db1 -e <endpoint> -d <database> ``` -В интерактивном режиме будут запрошены параметры соединения, которые нужно связать с данным профилем. Используйте для них проверенные на [предыдущем шаге](#ping) значения. +В качестве параметров используйте проверенные на [предыдущем шаге](#ping) значения. Например, для создания профиля соединения с локальной базой данных YDB, созданной по сценарию самостоятельного развертывания [в Docker](../self_hosted/ydb_docker.md), выполните следующую команду: + +```bash +{{ ydb-cli }} config profile create db1 -e grpc://localhost:2136 -d /local +``` Проверьте работоспособность профиля командой `scheme ls`: diff --git a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/create.md b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/create.md index cafaa17530e..379008bc865 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/create.md +++ b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/create.md @@ -1,6 +1,70 @@ # Создание и изменение профиля -В настоящее время профили создаются и изменяются только в интерактивном режиме следующими командами: +Значения параметров соединения для создаваемого или изменяемого профиля могут быть: +- Заданы [в командной строке](#cmdline) +- Запрошены [в интерактивном режиме](#interactive) из консоли + +## Командная строка {#cmdline} + +Для создания или изменения профиля из командной строки применяется следующая команда: + +``` bash +{{ ydb-cli }} config profile create <profile_name> <connection_options> +``` + +В данной команде: +- `<profile_name>` -- обязательное имя профиля +- `<connection options>` -- [параметры соединения](../../connect.md#command-line-pars) для записи в профиле. Необходимо указание как минимум одного параметра соединения, иначе команда будет выполняться в [интерактивном режиме](#interactive). + +Если профиль с указанным именем существует, то в нем будут обновлены те параметры, значения которых переданы в командной строке. Значения не перечисленных в командной строке параметров останутся без изменений. + +Используются только те значения, которые непосредственно указаны в командной строке, без обращений к переменным окружения или активированному профилю. + +### Примеры {#cmdline-examples} + +#### Создание профиля по ранее использованным параметрам соединения {#cmdline-example-from-explicit} + +Любая команда выполнения операции в базе данных YDB с явно заданными параметрами соединения может быть преобразована в команду создания профиля перемещением параметров соединения из глобальных опций в опции команды `config profile create`. + +Например, если вы успешно выполнили команду `scheme ls` со следующими реквизитами: + +```bash +{{ydb-cli}} \ + -e grpcs://example.com:2135 -d /Root/somedatabase --sa-key-file ~/sa_key.json \ + scheme ls +``` + +То создать профиль для соединения с использованной базой данных можно следующей командой: + +```bash +{{ydb-cli}} \ + config profile create db1 \ + -e grpcs://example.com:2135 -d /Root/somedatabase --sa-key-file ~/sa_key.json +``` + +Теперь можно записать исходную команду гораздо короче: + +```bash +{{ydb-cli}} -p db1 scheme ls +``` + +#### Профиль для соединения с локальной базой данных {#cmdline-example-local} + +Создание профиля `local` для соединения с локальной БД YDB, развернутой сценариями быстрого развертывания из [бинарного файла](../../../../getting_started/self_hosted/ydb_local.md) или [в Docker](../../../../getting_started/self_hosted/ydb_docker.md): + +```bash +{{ydb-cli}} config profile create local --endpoint grpc://localhost:2136 --database /Root/test +``` + +Определение способа аутентификации по логину и паролю в профиле `local`: + +```bash +{{ydb-cli}} config profile create local --user user1 --password-file ~/pwd.txt +``` + +## Интерактивный режим {#interactive} + +Профили создаются и изменяются в интерактивном режиме следующими командами: ``` bash {{ ydb-cli }} init @@ -9,34 +73,37 @@ или ``` bash -{{ ydb-cli }} config profile create [profile_name] +{{ ydb-cli }} config profile create [profile_name] [connection_options] ``` -, где `[profile_name]` -- необязательное имя создаваемого или изменяемого профиля. +В данной команде: +- `[profile_name]` -- необязательное имя создаваемого или изменяемого профиля +- `[connection_options]` -- необязательные [параметры соединения](../../connect.md#command-line-pars) для записи в профиле +Команда `init` всегда работает в интерактивном режиме, а `config profile create` запускается в интерактивном режиме в случае, если не указано имя профиля, или не указан ни один из параметров соединения в командной строке. -Первый шаг интерактивного сценария отличается в командах `init` и `profile create`: +Начало интерактивного сценария отличается в командах `init` и `profile create`: {% list tabs %} - Init - Выводится перечень существующих профилей (если они есть), и предлагается выбор - создать новый (Create a new) или изменить конфигурацию одного из существующих: + 1. Выводится перечень существующих профилей (если они есть), и предлагается выбор - создать новый (Create a new) или изменить конфигурацию одного из существующих: - ```text - Please choose profile to configure: - [1] Create a new profile - [2] test - [3] local - ``` + ```text + Please choose profile to configure: + [1] Create a new profile + [2] test + [3] local + ``` - Если существующих профилей нет, или выбран вариант `1` на предыдущем шаге, то запрашивается имя профиля для создания: + 2. Если существующих профилей нет, или выбран вариант `1` на предыдущем шаге, то запрашивается имя профиля для создания: - ``` text - Please enter name for a new profile: - ``` + ``` text + Please enter name for a new profile: + ``` - Если ввести в этот момент имя существующего профиля, то {{ ydb-short-name }} CLI переходит к шагам изменения его параметров, как если бы сразу была выбрана опция с именем этого профиля. + 3. Если ввести в этот момент имя существующего профиля, то {{ ydb-short-name }} CLI переходит к шагам изменения его параметров, как если бы сразу была выбрана опция с именем этого профиля. - Profile Create @@ -53,7 +120,7 @@ - Задать или выбрать значение - Set a new value или Use <вариант> - Оставить предыдущее значение - Use current value (опция доступна при изменении существующего профиля) -## Пример +### Пример {#interactive-example} Создание нового профиля `mydb1`: @@ -85,11 +152,13 @@ ```text Pick desired action to configure authentication method: - [1] Use IAM token (iam-token) cloud.yandex.com/docs/iam/concepts/authorization/iam-token - [2] Use OAuth token of a Yandex Passport user (yc-token) cloud.yandex.com/docs/iam/concepts/authorization/oauth-token - [3] Use metadata service on a virtual machine (use-metadata-credentials) cloud.yandex.com/docs/compute/operations/vm-connect/auth-inside-vm - [4] Use security account key file (sa-key-file) cloud.yandex.com/docs/iam/operations/iam-token/create-for-sa - [5] Don't save authentication data for profile "mydb1" + [1] Use static credentials (user & password) + [2] Use IAM token (iam-token) cloud.yandex.ru/docs/iam/concepts/authorization/iam-token + [3] Use OAuth token of a Yandex Passport user (yc-token). Doesn't work with federative accounts. cloud.yandex.ru/docs/iam/concepts/authorization/oauth-token + [4] Use metadata service on a virtual machine (use-metadata-credentials) cloud.yandex.ru/docs/compute/operations/vm-connect/auth-inside-vm + [5] Use service account key file (sa-key-file) cloud.yandex.ru/docs/iam/operations/iam-token/create-for-sa + [6] Set new OAuth token (ydb-token) + [7] Don't save authentication data for profile "mydb1" Please enter your numeric choice: ``` diff --git a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/index.md b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/index.md index f552ad82575..c5d559cb1ff 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/index.md +++ b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/index.md @@ -13,7 +13,7 @@ - Вызов той же команды `scheme ls` с использованием профиля: ``` bash - {{ ydb-cli }} --profile db1 scheme ls + {{ ydb-cli }} -p db1 scheme ls ``` ## Команды управления профилями {#commands} |