diff options
author | Ivan Blinkov <ivan@ydb.tech> | 2023-10-27 17:10:42 +0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-10-27 17:10:42 +0700 |
commit | b0e67520811f97a82b3d8a517ce910e4f1091c7e (patch) | |
tree | 4ec48fb55e847330e8777edbd8ebc80d8adb330e | |
parent | 8a7668c071a46b2799b1463e9db347ebad976413 (diff) | |
download | ydb-b0e67520811f97a82b3d8a517ce910e4f1091c7e.tar.gz |
Update ydb_docker.md
-rw-r--r-- | ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker.md index 9f3f512e59..1fe332ba12 100644 --- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker.md +++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker.md @@ -10,15 +10,15 @@ - gRPC - - [Эндпоинт](../../../../concepts/connect.md#endpoint): `grpc://localhost:2136` - - [Путь базы данных](../../../../concepts/connect.md#database): `/local` - - [Аутентификация](../../../../concepts/auth.md): Анонимная (без аутентификации) + - [Эндпоинт](../../../concepts/connect.md#endpoint): `grpc://localhost:2136` + - [Путь базы данных](../../../concepts/connect.md#database): `/local` + - [Аутентификация](../../../concepts/auth.md): Анонимная (без аутентификации) - gRPCs/TLS - - [Эндпоинт](../../../../concepts/connect.md#endpoint): `grpcs://localhost:2135` - - [Путь базы данных](../../../../concepts/connect.md#database): `/local` - - [Аутентификация](../../../../concepts/auth.md): Анонимная (без аутентификации) + - [Эндпоинт](../../../concepts/connect.md#endpoint): `grpcs://localhost:2135` + - [Путь базы данных](../../../concepts/connect.md#database): `/local` + - [Аутентификация](../../../concepts/auth.md): Анонимная (без аутентификации) {% endlist %} @@ -83,6 +83,7 @@ docker run -d --rm --name ydb-local -h localhost \ {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} ``` {% endlist %} + При успешном запуске будет выведен идентификатор созданного контейнера. ### Параметры запуска {#start-pars} `-d`: Запустить Docker-контейнер в фоновом режиме. @@ -96,14 +97,14 @@ docker run -d --rm --name ydb-local -h localhost \ - `YDB_DEFAULT_LOG_LEVEL`: Уровень логирования. Допустимые значения: `CRIT`, `ERROR`, `WARN`, `NOTICE`, `INFO`. По умолчанию `NOTICE`. - `GRPC_PORT`: Порт для нешифрованных соединений. По умолчанию 2136. - `GRPC_TLS_PORT`: Порт для соединений с использованием TLS. По умолчанию 2135. -- `MON_PORT`: Порт для встроенного web-ui со средствами [мониторинга и интроспекции](../../../../maintenance/embedded_monitoring/ydb_monitoring.md). По умолчанию 8765. +- `MON_PORT`: Порт для встроенного web-ui со средствами [мониторинга и интроспекции](../../../maintenance/embedded_monitoring/ydb_monitoring.md). По умолчанию 8765. - `YDB_PDISK_SIZE`: Размер диска для хранения данных в формате `<NUM>GB` (например, `YDB_PDISK_SIZE=128GB`). Допустимые значения: от `80GB` и выше. По умолчанию 80GB. - `YDB_USE_IN_MEMORY_PDISKS`: Использование дисков в памяти. Допустимые значения `true`, `false`, по умолчанию `false`. Во включенном состоянии не использует файловую систему контейнера для работы с данными, все данные хранятся только в памяти процесса, и теряются при его остановке. В настоящее время запуск контейнера на процессоре Apple Silicon (M1 или M2) возможен только в этом режиме. - `YDB_FEATURE_FLAGS`: Флаги, позволяющие включить функции, отключенные по-умолчанию. Используется для функций, находящихся в разработке (по-умолчанию они выключены). Перечисляются через запятую. - `POSTGRES_USER` - создать пользователя с указанным логином, используется для подключения через postgres-протокол. - `POSTGRES_PASSWORD` - задать пароль пользователя для подключения через postgres-протокол. - `YDB_TABLE_ENABLE_PREPARED_DDL` - временная опция, нужна для запуска Postgres-слоя совместимости, в будущем будет удалена. -{% include [_includes/storage-device-requirements.md](../../../../_includes/storage-device-requirements.md) %} +{% include [_includes/storage-device-requirements.md](../../../_includes/storage-device-requirements.md) %} `-p`: Опубликовать порты контейнера на хост-системе. Все применяемые порты должны быть явно перечислены, даже если используются значения по умолчанию. {% note info %} Инициализация Docker-контейнера, в зависимости от выделенных ресурсов, может занять несколько минут. До окончания инициализации база данных будет недоступна. @@ -111,7 +112,7 @@ docker run -d --rm --name ydb-local -h localhost \ ## Выполнение запросов {#request} -[Установите](../../../../reference/ydb-cli/install.md) YDB CLI и выполните запрос, например: +[Установите](../../../reference/ydb-cli/install.md) YDB CLI и выполните запрос, например: ```bash ydb -e grpc://localhost:2136 -d /local scheme ls @@ -123,7 +124,7 @@ ydb -e grpc://localhost:2136 -d /local scheme ls ydb -e grpcs://localhost:2135 --ca-file ydb_certs/ca.pem -d /local scheme ls ``` -Предсобранная версия [YDB CLI](../../../../reference/ydb-cli/index.md) также доступа внутри образа: +Предсобранная версия [YDB CLI](../../../reference/ydb-cli/index.md) также доступа внутри образа: ```bash docker exec <container_id> /ydb -e grpc://localhost:2136 -d /local scheme ls @@ -134,7 +135,6 @@ docker exec <container_id> /ydb -e grpc://localhost:2136 -d /local scheme ls `<container_id>`: идентификатор контейнера, выведенный при его [запуске](#start). - ## Остановка {#stop} По окончании работы остановите Docker-контейнер: |