Update docker quick start section in docs #11485
Conversation
|
Hi! Thank you for contributing! |
asmyasnikov
added
the
ok-to-test
github-actions
bot
removed
the
ok-to-test
❌ Documentation buildRevision build failed Build logsErrors (6)❌ /en/quickstart.md: 102: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 6] ❌ /en/quickstart.md: 106: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 6] ❌ /en/quickstart.md: 108: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8] ❌ /ru/quickstart.md: 101: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 6] ❌ /ru/quickstart.md: 105: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 6] ❌ /ru/quickstart.md: 107: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8] |
|
⚪ |
|
⚪ |
✅ Documentation buildRevision built successfully |
github-actions
bot
added
documentation
asmyasnikov
added
the
ok-to-test
github-actions
bot
removed
the
ok-to-test
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
ydb/docs/en/core/quickstart.md
Outdated
| @@ -97,6 +97,11 @@ Normally, {{ ydb-short-name }} stores data on multiple SSD/NVMe or HDD raw disk | |||
| The `YDB_USE_IN_MEMORY_PDISKS` setting makes all data volatile, stored only in RAM. Currently, data persistence by turning it off is supported only on x86_64 processors. | |||
| To disable the `YDB_USE_IN_MEMORY_PDISKS` option when running a Docker container on a Mac with an Apple Silicon processor, it must emulate the x86_64 instruction set: | |||
| - With [colima](https://github.com/abiosoft/colima), use the `colima start --arch aarch64 --vm-type=vz --vz-rosetta` options. | |||
There was a problem hiding this comment.
Working Colima template
# Architecture of the virtual machine (x86_64, aarch64, host).
#
# NOTE: value cannot be changed after virtual machine is created.
# Default: host
arch: host
# Virtual Machine type (qemu, vz)
# NOTE: this is macOS 13 only. For Linux and macOS <13.0, qemu is always used.
#
# vz is macOS virtualization framework and requires macOS 13
#
# NOTE: value cannot be changed after virtual machine is created.
# Default: qemu
vmType: vz
# Utilise rosetta for amd64 emulation (requires m1 mac and vmType `vz`)
# Default: false
rosetta: true
# Volume mount driver for the virtual machine (virtiofs, 9p, sshfs).
#
# virtiofs is limited to macOS and vmType `vz`. It is the fastest of the options.
#
# 9p is the recommended and the most stable option for vmType `qemu`.
#
# sshfs is faster than 9p but the least reliable of the options (when there are lots
# of concurrent reads or writes).
#
# NOTE: value cannot be changed after virtual machine is created.
# Default: virtiofs (for vz), sshfs (for qemu)
mountType: virtiofs
# Propagate inotify file events to the VM.
# NOTE: this is experimental.
mountInotify: false
ydb/docs/en/core/quickstart.md
Outdated
| @@ -97,6 +97,11 @@ Normally, {{ ydb-short-name }} stores data on multiple SSD/NVMe or HDD raw disk | |||
| The `YDB_USE_IN_MEMORY_PDISKS` setting makes all data volatile, stored only in RAM. Currently, data persistence by turning it off is supported only on x86_64 processors. | |||
| To disable the `YDB_USE_IN_MEMORY_PDISKS` option when running a Docker container on a Mac with an Apple Silicon processor, it must emulate the x86_64 instruction set: | |||
There was a problem hiding this comment.
А мне нравится это предложение.
YDB_USE_IN_MEMORY_PDISKS по умолчанию НЕ включена. Поэтому вообще весь этот абзац существует
❌ Documentation buildRevision build failed Build logsErrors (5)❌ /en/quickstart.md: 100: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 101: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 102: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 106: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 5] ❌ /en/quickstart.md: 99: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] |
❌ Documentation buildRevision build failed Build logsErrors (7)❌ /en/quickstart.md: 100: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 101: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 102: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 106: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 5] ❌ /en/quickstart.md: 99: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /ru/quickstart.md: 98: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ Note must be closed in /ru/quickstart.md |
❌ Documentation buildRevision build failed Build logsErrors (5)❌ /en/quickstart.md: 100: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 101: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 102: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] ❌ /en/quickstart.md: 106: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 5] ❌ /en/quickstart.md: 99: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] |
✅ Documentation buildRevision built successfully |
ydb/docs/ru/core/quickstart.md
Outdated
|
|
||
| ```bash | ||
| docker run -d --rm --name ydb-local -h localhost \ | ||
| --platform linux/amd64 \ | ||
| -p 2135:2135 -p 2136:2136 -p 8765:8765 \ | ||
| -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \ | ||
| -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 }} | ||
| ``` | ||
|
|
||
| Если контейнер успешно запустился, вы увидите его идентификатор. Контейнеру может потребоваться несколько минут для инициализации. База данных будет недоступна до окончания инициализации. |
There was a problem hiding this comment.
| Если контейнер успешно запустился, вы увидите его идентификатор. Контейнеру может потребоваться несколько минут для инициализации. База данных будет недоступна до окончания инициализации. | |
| Если контейнер успешно запустился, вы увидите его идентификатор. Контейнеру может потребоваться несколько секунд для инициализации. База данных будет недоступна до окончания инициализации. |
ydb/docs/ru/core/quickstart.md
Outdated
| Настройка `YDB_USE_IN_MEMORY_PDISKS` делает все данные волатильными, хранящимися только в оперативной памяти. В настоящее время сохранение данных путем её отключения поддерживается только на x86_64 процессорах. | ||
| {% note warning %} | ||
|
|
||
| В настоящее время сохранение данных на диск поддерживается только на x86_64 процессорах. Чтобы отключить сохранение данных на диск и сделать все данные волатильными, хранящимися только в оперативной памяти, добавьте в команду запуска Docker-контейнера параметр `YDB_USE_IN_MEMORY_PDISKS=true`. |
There was a problem hiding this comment.
| В настоящее время сохранение данных на диск поддерживается только на x86_64 процессорах. Чтобы отключить сохранение данных на диск и сделать все данные волатильными, хранящимися только в оперативной памяти, добавьте в команду запуска Docker-контейнера параметр `YDB_USE_IN_MEMORY_PDISKS=true`. | |
| В настоящее время сохранение данных на диск поддерживается только на x86_64 процессорах. Чтобы отключить сохранение данных на диск и сделать все данные волатильными, хранящимися только в оперативной памяти, добавьте в команду запуска Docker-контейнера параметр `-e YDB_USE_IN_MEMORY_PDISKS=true`. |
ydb/docs/ru/core/quickstart.md
Outdated
|
|
||
| В настоящее время сохранение данных на диск поддерживается только на x86_64 процессорах. Чтобы отключить сохранение данных на диск и сделать все данные волатильными, хранящимися только в оперативной памяти, добавьте в команду запуска Docker-контейнера параметр `YDB_USE_IN_MEMORY_PDISKS=true`. | ||
|
|
||
| Если вы не хотите отключать сохранение данных на диск при запуске контейнера Docker на Mac с процессором Apple Silicon, необходимо эмулировать набор инструкций x86_64 с помощью одной из следующих программ: |
There was a problem hiding this comment.
| Если вы не хотите отключать сохранение данных на диск при запуске контейнера Docker на Mac с процессором Apple Silicon, необходимо эмулировать набор инструкций x86_64 с помощью одной из следующих программ: | |
| Если вы не хотите отключать сохранение данных на диск при запуске контейнера Docker на Mac с процессором Apple Silicon, необходимо эмулировать набор инструкций x86_64, используя технологию виртуализации rozetta: |
There was a problem hiding this comment.
Можно ссылкой сделать розетту
✅ Documentation buildRevision built successfully |
✅ Documentation buildRevision built successfully |
Changelog category
Additional information
Update docker quick start section in documentation for Macs with ARM