diff options
author | alexv-smirnov <alexv-smirnov@yandex-team.ru> | 2022-02-16 17:50:21 +0300 |
---|---|---|
committer | alexv-smirnov <alexv-smirnov@yandex-team.ru> | 2022-02-16 17:50:21 +0300 |
commit | 94e0d1dcb0474eb63e528acc76a3be90dc43163b (patch) | |
tree | 1597cd93e2d63ce1356aab3857747c3afb514912 | |
parent | d85fd50f5013890b5b552e67c7aa9cda249bc01c (diff) | |
download | ydb-94e0d1dcb0474eb63e528acc76a3be90dc43163b.tar.gz |
ydb cli docs - discovery
ref:07811507f5a2319e509288e32d3f1ccf32a288fd
9 files changed, 68 insertions, 20 deletions
diff --git a/ydb/docs/ru/core/concepts/_includes/connect.md b/ydb/docs/ru/core/concepts/_includes/connect.md index 5c6ce24e24..d7e18572b4 100644 --- a/ydb/docs/ru/core/concepts/_includes/connect.md +++ b/ydb/docs/ru/core/concepts/_includes/connect.md @@ -57,10 +57,6 @@ {% include [overlay/auth_choose.md](connect_overlay/auth_choose.md) %} -Режимы с периодическим получением следующего токена (ротацией) применяются в комплексе с ограничением времени жизни такого токена, что позволяет не передавать по сети информацию, утечка которой может привести к накоплению риска инцидентов информационной безопасности. В частности, в Yandex.Cloud применяется IAM Token, и его время жизни ограничено 12 часами. - -Для пользовательских и системных учетных записей также обычно применяются разные политики ограничения жизни токенов, и их отзыва. Например, в Yandex.Cloud время жизни пользовательского OAuth токена ограничено 1 годом, а токены для системных учетных записей не ограничены сроком действия. Также, для корпоративных контекстов характерен отзыв всех персональных токенов при увольнении сотрудника, в то время как токен системной учетной записи отзывается только при компрометации. - При использовании режимов, предусматривающих обращение клиента YDB к IAM, дополнительно может быть задан URL IAM, предоставляющий API выдачи токенов. По-умолчанию в существующих SDK и CLI производится попытка обращения к API IAM Yandex.Cloud, размещенному на `iam.api.cloud.yandex.net:443`. ## Размещение базы данных {#database} @@ -85,7 +81,7 @@ {% include [overlay/database_example.md](connect_overlay/database_example.md) %} -## Конфигурация параметров соединения на клиенте +## Конфигурация параметров соединения на клиенте {#client-config} В специализированных статьях описано как определять параметры соединения на клиенте: diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md index f9e73ec135..a7920bfb70 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md +++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/connect.md @@ -62,4 +62,8 @@ YDB CLI определяет с какой БД необходимо соеди - `--ca-file <filepath>` : Файл корневого PEM-сертификата для TLS-соединения -В настоящее время корневой сертификат не сохраняется в профиле, и может быть определен только опцией командной строки.
\ No newline at end of file +В настоящее время корневой сертификат не сохраняется в профиле, и может быть определен только опцией командной строки. + +## Проверка аутентификации {#whoami} + +Сервисная команда YDB CLI [`discovery whoami`](../commands/discovery-whoami.md) позволяет проверить, под какой учетной записью вы фактически аутентифицировались на сервере.
\ No newline at end of file diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md new file mode 100644 index 0000000000..4350b0cf81 --- /dev/null +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md @@ -0,0 +1,25 @@ +# Список эндпоинтов + +Информационная команда `discovery list` позволяет получить список [эндпоинтов](../../../../concepts/connect.md#endpoint) кластера YDB, с которыми можно открывать соединения для работы с заданной базой данных: + +``` bash +{{ ydb-cli }} [connection options] discovery list +``` + +, где [connection options] - опции [соединения с БД](../../connect.md#command-line-pars) + +В выводимых в ответ строках содержится следующая информация: +1. Эндпоинт, включая протокол и порт +2. В квадратных скобках зона доступности +3. С символом `#` перечень сервисов YDB, доступных на данном эндпоинте + +Запрос к кластеру YDB на endpoint discovery выполняется в YDB SDK при инициализации драйвера, и команду CLI `discovery list` можно использовать для локализации возможных проблем соединения. + +## Пример + +``` bash +$ ydb --profile db1 discovery list +grpcs://vm-etn01q5-ysor.etn01q5k.ydb.mdb.yandexcloud.net:2135 [sas] #table_service #scripting #discovery #rate_limiter #locking #kesus +grpcs://vm-etn01q5-arum.etn01ftr.ydb.mdb.yandexcloud.net:2135 [vla] #table_service #scripting #discovery #rate_limiter #locking #kesus +grpcs://vm-etn01q5beftr.ydb.mdb.yandexcloud.net:2135 [myt] #table_service #scripting #discovery #rate_limiter #locking #kesus +``` diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list/intro.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list/intro.md deleted file mode 100644 index 496e468990..0000000000 --- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list/intro.md +++ /dev/null @@ -1,7 +0,0 @@ -# Получение списка эндпоинтов для базы данных - -Получите список эндпойнтов для базы данных: - -```bash -{{ ydb-cli }} discovery list -``` diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md new file mode 100644 index 0000000000..f75938b188 --- /dev/null +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md @@ -0,0 +1,25 @@ +# Проверка аутентификации + +Информационная команда `discovery whoami` позволяет проверить, от имени какой учетной записи воспринимает запросы сервер: + +``` bash +{{ ydb-cli }} [connection options] discovery whoami [-g] +``` + +, где [connection options] - опции [соединения с БД](../../connect.md#command-line-pars) + +В ответ выводится имя учетной записи (User SID) и, если указана опция `-g`, то информация о принадлежности учетной записи группам. + +Если на сервере YDB не включена аутентификация (что может применяться, например, при самостоятельном локальном развертывании), то выполнение команды завершится с ошибкой. + +Поддержка опции `-g` зависит от конфигурации сервера. Если она не включена, то вы будете получать в ответ `User has no groups` вне зависимости от фактического включения вашей учетной записи в какие-либо группы. + +## Пример + +``` bash +$ ydb --profile db1 discovery whoami -g +User SID: aje5kkjdgs0puc18976co@as + +User has no groups +``` + diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls/intro.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls/intro.md index e06dc1eb37..332e7df0c8 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls/intro.md +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls/intro.md @@ -1,6 +1,6 @@ -# Листинг объектов +# Список объектов -Чтобы получить листинг объектов, используйте подкоманду `scheme ls <Путь>`. Если путь не указан, то будет выведен листинг корня базы данных: +Чтобы получить список объектов, используйте подкоманду `scheme ls <Путь>`. Если путь не указан, то будет выведен листинг корня базы данных: ```bash {{ ydb-cli }} scheme ls diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-list.md b/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-list.md index d73a84974b..37ab1db809 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-list.md +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-list.md @@ -1 +1 @@ -{% include [intro.md](_includes/discovery-list/intro.md) %} +{% include [discovery-list.md](_includes/discovery-list.md) %} diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-whoami.md b/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-whoami.md new file mode 100644 index 0000000000..0060ce70d9 --- /dev/null +++ b/ydb/docs/ru/core/reference/ydb-cli/commands/discovery-whoami.md @@ -0,0 +1 @@ +{% include [discovery-whoami.md](_includes/discovery-whoami.md) %}
\ No newline at end of file diff --git a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml index 43d886e54a..567232f983 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml +++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml @@ -11,9 +11,9 @@ items: href: commands/global-options.md - name: Работа со схемой БД items: - - name: Листинг объектов + - name: Список объектов href: commands/scheme-ls.md - - name: Получение информации об объекте схемы + - name: Информация об объекте href: commands/scheme-describe.md - name: Переименование таблиц href: commands/tools/rename.md @@ -39,8 +39,12 @@ items: # href: commands/tools/restore.md - name: Управление профилями include: { mode: link, path: profile/toc_p.yaml } - - name: Получение списка эндпоинтов для базы данных - href: commands/discovery-list.md + - name: Информационные сервисы + items: + - name: Список эндпоинтов + href: commands/discovery-list.md + - name: Проверка аутентификации + href: commands/discovery-whoami.md - name: Нагрузочное тестирование items: - name: Обзор |