diff options
author | Ivan Blinkov <ivan@ydb.tech> | 2023-05-18 08:28:59 +0000 |
---|---|---|
committer | alexv-smirnov <alex@ydb.tech> | 2023-05-18 11:28:59 +0300 |
commit | 2c69e50ada916875a09f14a9f7548faa91d5306b (patch) | |
tree | 2af655b1014992fc353cbd51250a9f1c0dcb511b | |
parent | 5296eadaf571105095ce110942815e0194bd4bec (diff) | |
download | ydb-2c69e50ada916875a09f14a9f7548faa91d5306b.tar.gz |
"[docs] make warning about Apple Silicon more prominent"
"[docs] make warning about Apple Silicon more prominent"
Pull Request resolved: #176
-rw-r--r-- | ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md | 42 | ||||
-rw-r--r-- | ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md | 36 |
2 files changed, 68 insertions, 10 deletions
diff --git a/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md b/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md index 1a44acaa12e..d9ce373a142 100644 --- a/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md +++ b/ydb/docs/en/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md @@ -4,14 +4,38 @@ The YDB Docker container uses the host system resources (CPU, RAM) within the li The YDB Docker container stores data in its file system whose sections are reflected in the host system directory. The start container command given below will create files in the current directory, so first create a working directory and then start the container from it: -```bash -docker run -d --rm --name ydb-local -h localhost \ - -p 2135:2135 -p 8765:8765 -p 2136:2136 \ - -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \ - -e YDB_DEFAULT_LOG_LEVEL=NOTICE \ - -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \ - {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} -``` +{% list tabs %} + +- Disk storage + + ```bash + docker run -d --rm --name ydb-local -h localhost \ + -p 2135:2135 -p 8765:8765 -p 2136:2136 \ + -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \ + -e YDB_DEFAULT_LOG_LEVEL=NOTICE \ + -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \ + {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} + ``` + + {% note warning %} + + Currently, disk storage is not supported on Apple Silicon (M1 or M2). Use the command from "In-memory storage" tab if you want to try {{ ydb-short-name }} on this CPU. + + {% endnote %} + +- In-memory storage + + ```bash + docker run -d --rm --name ydb-local -h localhost \ + -p 2135:2135 -p 8765:8765 -p 2136:2136 \ + -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \ + -e YDB_DEFAULT_LOG_LEVEL=NOTICE \ + -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \ + -e YDB_USE_IN_MEMORY_PDISKS=true \ + {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} + ``` + +{% endlist %} If started successfully, you'll see the ID of the created container. @@ -35,7 +59,7 @@ If started successfully, you'll see the ID of the created container. - `GRPC_TLS_PORT`: The port for TLS connections. Defaults to 2135. - `MON_PORT`: The port for the built-in web UI with [monitoring and introspection](../../../../maintenance/embedded_monitoring/ydb_monitoring.md) tools. Defaults to 8765. - `YDB_PDISK_SIZE`: The size of the data storage disk in `<NUM>GB` format (for example, `YDB_PDISK_SIZE=128GB`). Acceptable values: `80GB` and higher. Defaults to 80GB. -- `YDB_USE_IN_MEMORY_PDISKS`: Using disks in memory. Acceptable values are `true` and `false`, defaults to `false`. If enabled, the container's file system is not used for working with data, all data is only stored in the memory of a process and is lost when it's stopped. Currently, you can start the container on Apple M1 in this mode only. +- `YDB_USE_IN_MEMORY_PDISKS`: Using disks in memory. Acceptable values are `true` and `false`, defaults to `false`. If enabled, the container's file system is not used for working with data, all data is only stored in the memory of a process and is lost when it's stopped. Currently, you can start the container on Apple Silicon (M1 or M2) in this mode only. {% include [_includes/storage-device-requirements.md](../../../../_includes/storage-device-requirements.md) %} diff --git a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md index e944fb7af9d..a987f8d96b7 100644 --- a/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md +++ b/ydb/docs/ru/core/getting_started/self_hosted/_includes/ydb_docker/03_start.md @@ -13,6 +13,40 @@ docker run -d --rm --name ydb-local -h localhost \ {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} ``` +{% list tabs %} + +- Хранение данных на диске + + ```bash + docker run -d --rm --name ydb-local -h localhost \ + -p 2135:2135 -p 8765:8765 -p 2136:2136 \ + -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \ + -e YDB_DEFAULT_LOG_LEVEL=NOTICE \ + -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \ + {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} + ``` + + {% note warning %} + + На данный момент хранение данных на диске не поддерживается на Apple Silicon (M1 or M2). Используйте команду с вкладки "Хранение данных в памяти", если хотите попробовать {{ ydb-short-name }} на данных процессорах. + + {% endnote %} + +- Хранение данных в памяти + + ```bash + docker run -d --rm --name ydb-local -h localhost \ + -p 2135:2135 -p 8765:8765 -p 2136:2136 \ + -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \ + -e YDB_DEFAULT_LOG_LEVEL=NOTICE \ + -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \ + -e YDB_USE_IN_MEMORY_PDISKS=true \ + {{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} + ``` + +{% endlist %} + + При успешном запуске будет выведен идентификатор созданного контейнера. ### Параметры запуска {#start-pars} @@ -35,7 +69,7 @@ docker run -d --rm --name ydb-local -h localhost \ - `GRPC_TLS_PORT`: Порт для соединений с использованием TLS. По умолчанию 2135. - `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 M1 возможен только в этом режиме. +- `YDB_USE_IN_MEMORY_PDISKS`: Использование дисков в памяти. Допустимые значения `true`, `false`, по умолчанию `false`. Во включенном состоянии не использует файловую систему контейнера для работы с данными, все данные хранятся только в памяти процесса, и теряются при его остановке. В настоящее время запуск контейнера на процессоре Apple Silicon (M1 или M2) возможен только в этом режиме. {% include [_includes/storage-device-requirements.md](../../../../_includes/storage-device-requirements.md) %} |