aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralexv-smirnov <alex@ydb.tech>2022-10-20 13:35:51 +0300
committeralexv-smirnov <alex@ydb.tech>2022-10-20 13:35:51 +0300
commitf2cf13594bce31096267fb1cb2918394c668ca75 (patch)
tree6e9f7901d872313e5a1a3a5b39b04d482646c30c
parentda5ee816c1598acf602c1c42845b544878400d34 (diff)
downloadydb-f2cf13594bce31096267fb1cb2918394c668ca75.tar.gz
cli profile update/replace, cloud auth, short option for profile
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/_includes/auth/options_cloud.md2
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/profile/_includes/create.md56
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/profile/_includes/use.md14
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/profile/toc_i.yaml2
-rw-r--r--ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/env.md2
-rw-r--r--ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/options.md4
-rw-r--r--ydb/docs/ru/overlay/reference/ydb-cli/_includes/install_overlay.md3
7 files changed, 55 insertions, 28 deletions
diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/auth/options_cloud.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/auth/options_cloud.md
index 672d610c4d..ba454040cb 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/_includes/auth/options_cloud.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/auth/options_cloud.md
@@ -1,4 +1,4 @@
-- `--iam-token-file <filepath>` : используется режим аутентификации **Access Token**, в качестве которого используется содержимое файла, указанное в значении данной опции
+- `--token-file <filepath>` : используется режим аутентификации **Access Token**, в качестве которого используется содержимое файла, указанное в значении данной опции
- `--yc-token-file <filepath>` : используется режим аутентификации **Refresh Token**, в качестве которого используется содержимое файла, указанное в значении данной опции
- `--use-metadata-credentials` : используется режим аутентификации **Metadata**
- `--sa-key-file <filepath>` : используется режим аутентификации **Service Account Key**, а ключ и другие параметры загружаются из JSON-файла, указанного в значении данной опции \ No newline at end of file
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 379008bc86..c5956abcab 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,12 +1,16 @@
# Создание и изменение профиля
-Значения параметров соединения для создаваемого или изменяемого профиля могут быть:
-- Заданы [в командной строке](#cmdline)
-- Запрошены [в интерактивном режиме](#interactive) из консоли
+Значения параметров соединения для создаваемого или изменяемого профиля могут быть заданы [в командной строке](#cmdline), или запрошены [в интерактивном режиме](#interactive) из консоли.
## Командная строка {#cmdline}
-Для создания или изменения профиля из командной строки применяется следующая команда:
+Для создания или изменения профиля из командной строки применяются команды `profile create`, `profile update` и `profile replace`.
+
+Используются только те значения, которые непосредственно указаны в командной строке, без обращений к переменным окружения или активированному профилю.
+
+### Profile create {#create}
+
+Команда `profile create` создает новый профиль с заданными значениями параметров:
``` bash
{{ ydb-cli }} config profile create <profile_name> <connection_options>
@@ -16,11 +20,43 @@
- `<profile_name>` -- обязательное имя профиля
- `<connection options>` -- [параметры соединения](../../connect.md#command-line-pars) для записи в профиле. Необходимо указание как минимум одного параметра соединения, иначе команда будет выполняться в [интерактивном режиме](#interactive).
-Если профиль с указанным именем существует, то в нем будут обновлены те параметры, значения которых переданы в командной строке. Значения не перечисленных в командной строке параметров останутся без изменений.
+Если профиль с указанным именем существует, то выполнение команды завершится с ошибкой.
-Используются только те значения, которые непосредственно указаны в командной строке, без обращений к переменным окружения или активированному профилю.
+### Profile replace {#replace}
+
+Команда `profile replace` создает или заменяет профиль с заданными значениями параметров:
+
+``` bash
+{{ ydb-cli }} config profile replace <profile_name> [connection_options]
+```
+
+В данной команде:
+- `<profile_name>` -- обязательное имя профиля
+- `<connection options>` -- необязательные [параметры соединения](../../connect.md#command-line-pars) для записи в профиле
+
+Если профиль с указанным именем существует, то он будет заменен на новый, содержащий переданные параметры. Если не указан ни один параметр соединения, после исполнения команды профиль будет пустым.
+
+### Profile update {#update}
+
+Команда `profile update` изменяет параметры существующего профиля:
+
+``` bash
+{{ ydb-cli }} config profile update <profile_name> [connection_options] [reset-options]
+```
+
+В данной команде:
+- `<profile_name>` -- обязательное имя профиля
+- `<connection options>` -- необязательные [параметры соединения](../../connect.md#command-line-pars) для записи в профиле
+- `<reset options>` -- необязательные опции удаления параметров из существующего профиля. Возможные значения:
+
+ `--no-endpoint` -- удалить эндпоинт из профиля
+ `--no-database` -- удалить путь базы данных из профиля
+ `--no-auth` -- удалить аутентификационную информацию из профиля
+ `--no-iam-endpoint` -- удалить URL сервера IAM
+
+В профиле будут обновлены те параметры, которые упомянуты в командной строке. Значения не перечисленных в командной строке параметров останутся без изменений.
-### Примеры {#cmdline-examples}
+### Примеры {#create-cmdline-examples}
#### Создание профиля по ранее использованным параметрам соединения {#cmdline-example-from-explicit}
@@ -50,16 +86,16 @@
#### Профиль для соединения с локальной базой данных {#cmdline-example-local}
-Создание профиля `local` для соединения с локальной БД YDB, развернутой сценариями быстрого развертывания из [бинарного файла](../../../../getting_started/self_hosted/ydb_local.md) или [в Docker](../../../../getting_started/self_hosted/ydb_docker.md):
+Создание/замена профиля `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
+{{ydb-cli}} config profile replace local --endpoint grpc://localhost:2136 --database /Root/test
```
Определение способа аутентификации по логину и паролю в профиле `local`:
```bash
-{{ydb-cli}} config profile create local --user user1 --password-file ~/pwd.txt
+{{ydb-cli}} config profile update local --user user1 --password-file ~/pwd.txt
```
## Интерактивный режим {#interactive}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/use.md b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/use.md
index 2854433693..4efb3bb90f 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/use.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/profile/_includes/use.md
@@ -2,36 +2,36 @@
## Соединение по выбранному профилю {#explicit}
-Профиль может быть применен при запуске команды {{ ydb-short-name }} CLI указанием опции `--profile <profile_name>`:
+Профиль может быть применен при запуске команды {{ ydb-short-name }} CLI указанием опции `--profile` или `-p`:
``` bash
-{{ ydb-cli }} --profile <profile_name> <команда и опции команды>
+{{ ydb-cli }} -p <profile_name> <команда и опции команды>
```
Например:
``` bash
-{{ ydb-cli }} --profile mydb1 scheme ls -l
+{{ ydb-cli }} -p mydb1 scheme ls -l
```
В таком случае все параметры соединения с БД будут взяты из профиля. При этом, если в профиле не указано параметров аутентификации, то {{ ydb-short-name }} CLI попробует их определить по переменным окружения, как описано в статье [Соединение с БД и аутентификация - Переменные окружения](../../connect.md#env).
## Соединение по выбранному профилю и параметрам командной строки {#explicit-and-pars}
-Опция `--profile` может быть не единственной среди параметров соединения в командной строке, например:
+Опция `--profile` (`-p`) может быть не единственной среди параметров соединения в командной строке, например:
``` bash
-{{ ydb-cli }} --profile mydb1 -d /local2 scheme ls -l
+{{ ydb-cli }} -p mydb1 -d /local2 scheme ls -l
```
``` bash
-{{ ydb-cli }} --profile mydb1 --user alex scheme ls -l
+{{ ydb-cli }} -p mydb1 --user alex scheme ls -l
```
В таком случае указанные в командной строке параметры соединения имеют приоритет перед сохраненными в профиле. Такой формат позволяет переиспользовать профили для соединения с разными БД или под разными учетными записями. Также, указание в командной строке параметра аутентификации (как `--user alex` в примере выше) отключает проверку переменных окружения независимо от их наличия в профиле.
## Соединение по активированному профилю {#implicit}
-Если в командной строке не указана опция `--profile`, то {{ ydb-short-name }} CLI попробует взять из текущего активированного профиля все параметры соединения, которые он не смог определить другими способами (из опций командной строки или переменных окружения, как описано в статье [Соединение с БД и аутентификация](../../connect.md)).
+Если в командной строке не указана опция `--profile` (`-p`), то {{ ydb-short-name }} CLI попробует взять из текущего активированного профиля все параметры соединения, которые он не смог определить другими способами (из опций командной строки или переменных окружения, как описано в статье [Соединение с БД и аутентификация](../../connect.md)).
Неявное применение активированного профиля может приводить к ошибкам, поэтому перед использованием данного режима рекомендуется изучить статью [Активированный профиль](../activate.md). \ No newline at end of file
diff --git a/ydb/docs/ru/core/reference/ydb-cli/profile/toc_i.yaml b/ydb/docs/ru/core/reference/ydb-cli/profile/toc_i.yaml
index 49fbd7511c..27b03360e7 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/profile/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/profile/toc_i.yaml
@@ -1,5 +1,5 @@
items:
-- name: Создание профиля
+- name: Создание и изменение профиля
href: create.md
- name: Использование профиля в запросах
href: use.md
diff --git a/ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/env.md b/ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/env.md
deleted file mode 100644
index 79894c68a7..0000000000
--- a/ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/env.md
+++ /dev/null
@@ -1,2 +0,0 @@
-
-{% include [env_static.md](env_static.md) %} \ No newline at end of file
diff --git a/ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/options.md b/ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/options.md
deleted file mode 100644
index b752dcbf10..0000000000
--- a/ydb/docs/ru/overlay/reference/ydb-cli/_includes/auth/options.md
+++ /dev/null
@@ -1,4 +0,0 @@
-OpenSource сборка {{ ydb-short-name }} CLI поддерживает только один режим аутентификации -- по логину и паролю:
-
-{% include [options_static.md](options_static.md) %}
-
diff --git a/ydb/docs/ru/overlay/reference/ydb-cli/_includes/install_overlay.md b/ydb/docs/ru/overlay/reference/ydb-cli/_includes/install_overlay.md
deleted file mode 100644
index 0cace74469..0000000000
--- a/ydb/docs/ru/overlay/reference/ydb-cli/_includes/install_overlay.md
+++ /dev/null
@@ -1,3 +0,0 @@
-OpenSource версия {{ ydb-short-name }} CLI может быть собрана из исходного кода. В настоящее время она поддерживает только аутентификацию по логину и паролю.
-
-Также для работы с любыми базами данных {{ ydb-short-name }} (включая OpenSource сборки) можно использовать Yandex Cloud версию {{ ydb-short-name }} CLI, которая поддерживает все виды аутентификации, включая логин и пароль. Порядок установки этой версии описан ниже.