aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVitalii Gridnev <gridnevvvit@gmail.com>2022-02-21 23:09:39 +0300
committerVitalii Gridnev <gridnevvvit@gmail.com>2022-02-21 23:09:39 +0300
commit733e8ce19209d6d6c748d9ea454d4ad0c154b22e (patch)
treef5a81603d89d0fc134e6d4695879d83f54c30b81
parenta5f2f1cbd679aaa6434f0da7dce2d1028ea03451 (diff)
downloadydb-733e8ce19209d6d6c748d9ea454d4ad0c154b22e.tar.gz
Fix comments to Docker doc KIKIMR-14317
ref:e7e32ada28e8a1b24ff30157b3bd1e36a19e79ed
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md2
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md20
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md9
-rw-r--r--ydb/docs/ru/core/getting_started/_includes/ydb_docker/06_license.md4
4 files changed, 29 insertions, 6 deletions
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md
index 0e7fdb7978..dfab590a06 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/02_install.md
@@ -1,6 +1,6 @@
## Выгрузите Docker-образ {{ ydb-short-name }} {#install}
-Выгрузите актуальную публичную версию Docker-образа:
+Загрузите актуальную публичную версию Docker-образа:
```bash
docker pull {{ ydb_local_docker_image }}:{{ ydb_local_docker_image_tag }}
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md
index 972eeda38a..125f631281 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/03_start.md
@@ -18,6 +18,18 @@ docker run -d \
{{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }}
```
+{% note info %}
+
+Монтирование директории `ydb_data` нужно для того, чтобы контейнер смог пережить рестарт контейнера. Если данная возможность не требуется директорию можно не монтировать.
+
+{% endnote %}
+
+{% note info %}
+
+Монтирование директории `ydb_certs` требуется только в случае установления безопасного соединения и не является обязательным.
+
+{% endnote %}
+
Где:
* `-d` — запустить Docker-контейнер в фоновом режиме.
@@ -30,6 +42,12 @@ docker run -d \
{% note info %}
+На Apple M1 процессорах контейнер работает только в режиме в памяти. При запуске контейнера укажите переменную окружения `YDB_USE_IN_MEMORY_PDISKS=true`
+
+{% endnote %}
+
+{% note info %}
+
Инициализация Docker-контейнера, в зависимости от мощности хост-системы, может занять несколько минут. До окончания инициализации база данных будет недоступна.
{% endnote %}
@@ -38,7 +56,7 @@ Docker-контейнер {{ ydb-short-name }} поддерживает допо
* `YDB_USE_IN_MEMORY_PDISKS=true` — включает возможность хранения данных целиком в памяти. В случае если данная опция включена, рестарт контейнера с локальной {{ ydb-short-name }} приведет к полной потере данных.
* `YDB_DEFAULT_LOG_LEVEL=<уровень>` — задает уровень логирования. Доступные значения уровней: `CRIT`, `ERROR`, `WARN`, `NOTICE`, `INFO`.
-* `YDB_PDISK_SIZE=<NUM>GB` - задает размер диска для хранения данных базы данных.
+* `YDB_PDISK_SIZE=<NUM>GB` - задает размер диска для хранения данных базы данных. Например, `YDB_PDISK_SIZE=128GB`. Минимальное значение 64GB.
* `GRPC_PORT` - порт для взаимоидествия с {{ ydb-short-name }} API про gRPC без TLS.
* `GRPC_TLS_PORT` - порт для взаимоидествия с {{ ydb-short-name }} API про gRPC c поддержкой TLS.
* `MON_PORT` - порт сo встроенными средствами мониторинга и интроспекции.
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md
index e37bf2ef6f..36b294f6bc 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/04_request.md
@@ -1,6 +1,6 @@
## Выполните запрос к базе данных {#request}
-Выполните запрос к базе данных {{ ydb-short-name }} в Docker-контейнере:
+Скачайте [YDB CLI](../../../getting_started/cli.md) и выполните запрос к базе данных {{ ydb-short-name }} в Docker-контейнере:
```bash
ydb \
@@ -37,7 +37,12 @@ ydb \
Предсобранная версия [YDB CLI](../../../reference/ydb-cli/index.md) также доступа внутри образа:
```bash
-sudo docker exec <CONTAINER-ID> /ydb -e localhost:2135 -d /local table query execute -q 'select 1;'
+docker exec <CONTAINER-ID> /ydb -e localhost:2136 -d /local table query execute -q 'select 1;'
+```
+
+Результат выполнения:
+
+```text
┌─────────┐
| column0 |
├─────────┤
diff --git a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/06_license.md b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/06_license.md
index f8e86c4953..7313fca870 100644
--- a/ydb/docs/ru/core/getting_started/_includes/ydb_docker/06_license.md
+++ b/ydb/docs/ru/core/getting_started/_includes/ydb_docker/06_license.md
@@ -5,11 +5,11 @@
Просмотрите текст лицензионного соглашения:
```bash
-sudo docker run --rm -it --entrypoint cat {{ ydb_local_docker_image }} LICENSE
+docker run --rm -it --entrypoint cat {{ ydb_local_docker_image }} LICENSE
```
Просмотрите все использованные при создании компоненты и их лицензии:
```bash
-sudo docker run --rm -it --entrypoint cat {{ ydb_local_docker_image }} THIRD_PARTY_LICENSES
+docker run --rm -it --entrypoint cat {{ ydb_local_docker_image }} THIRD_PARTY_LICENSES
```