Skip to content

[Backport stable-25-2] Fix docker recipe example #28457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2025
Merged

[Backport stable-25-2] Fix docker recipe example #28457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions ydb/docs/en/core/reference/docker/start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,26 @@ mkdir ydb_certs
Example of the {{ ydb-short-name }} startup command in Docker with detailed comments:

```bash
docker run \
-d \ # run container in background and print container ID
--rm \ # automatically remove the container
--name ydb-local \ # assign a name to the container
-h localhost \ # hostname
-p 2135:2135 \ # publish a container grpcs port to the host
-p 2136:2136 \ # publish a container grpc port to the host
-p 8765:8765 \ # publish a container http port to the host
-p 5432:5432 \ # publish a container port to the host that provides PostgreSQL compatibility
-p 9092:9092 \ # publish a container port to the host that provides Kafka compatibility
-v $(pwd)/ydb_certs:/ydb_certs \ # mount directory with TLS certificates
-v $(pwd)/ydb_data:/ydb_data \ # mount working directory
-e GRPC_TLS_PORT=2135 \ # grpcs port, needs to match what's published above
-e GRPC_PORT=2136 \ # grpc port, needs to match what's published above
-e MON_PORT=8765 \ # http port, needs to match what's published above
-e YDB_KAFKA_PROXY_PORT=9092 \ # port, needs to match what's published above
{{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} # docker image name and tag
docker_args=(
-d # run container in background and print container ID
--rm # automatically remove the container
--name ydb-local # assign a name to the container
-h localhost # hostname
-p 2135:2135 # publish a container grpcs port to the host
-p 2136:2136 # publish a container grpc port to the host
-p 8765:8765 # publish a container http port to the host
-p 5432:5432 # publish a container port to the host that provides PostgreSQL compatibility
-p 9092:9092 # publish a container port to the host that provides Kafka compatibility
-v $(pwd)/ydb_certs:/ydb_certs # mount directory with TLS certificates
-v $(pwd)/ydb_data:/ydb_data # mount working directory
-e GRPC_TLS_PORT=2135 # grpcs port, needs to match what's published above
-e GRPC_PORT=2136 # grpc port, needs to match what's published above
-e MON_PORT=8765 # http port, needs to match what's published above
-e YDB_KAFKA_PROXY_PORT=9092 # port, needs to match what's published above
{{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }}
)

docker run "${docker_args[@]}"
```

{% include [index.md](_includes/rosetta.md) %}
Expand Down
37 changes: 20 additions & 17 deletions ydb/docs/ru/core/reference/docker/start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,26 @@ mkdir ydb_certs
Пример команды запуска {{ ydb-short-name }} в Docker с подробными комментариями:

```bash
docker run \
-d \ # запуск в фоне
--rm \ # автоматическое удаление после установки
--name ydb-local \ # имя контейнера
-h localhost \ # хостейм
-p 2135:2135 \ # открытие внешнего доступа к grpcs порту
-p 2136:2136 \ # открытие внешнего доступа к grpc порту
-p 8765:8765 \ # открытие внешнего доступа к http порту
-p 5432:5432 \ # открытие внешнего доступа к порту, обеспечивающему PostgreSQL-совместимость
-p 9092:9092 \ # открытие внешнего доступа к порту, обеспечивающему Kafka-совместимость
-v $(pwd)/ydb_certs:/ydb_certs \ # директория для TLS сертификатов
-v $(pwd)/ydb_data:/ydb_data \ # рабочая директория
-e GRPC_TLS_PORT=2135 \ # grpcs порт должен соответствовать тому, что опубликовано выше
-e GRPC_PORT=2136 \ # grpc порт должен соответствовать тому, что опубликовано выше
-e MON_PORT=8765 \ # http порт должен соответствовать тому, что опубликовано выше
-e YDB_KAFKA_PROXY_PORT=9092 \ # порт Kafka должен соответствовать тому, что опубликовано выше
{{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }} # имя и тег образа
docker_args=(
-d # запуск в фоне
--rm # автоматическое удаление после установки
--name ydb-local # имя контейнера
-h localhost # хостейм
-p 2135:2135 # открытие внешнего доступа к grpcs порту
-p 2136:2136 # открытие внешнего доступа к grpc порту
-p 8765:8765 # открытие внешнего доступа к http порту
-p 5432:5432 # открытие внешнего доступа к порту, обеспечивающему PostgreSQL-совместимость
-p 9092:9092 # открытие внешнего доступа к порту, обеспечивающему Kafka-совместимость
-v $(pwd)/ydb_certs:/ydb_certs # директория для TLS сертификатов
-v $(pwd)/ydb_data:/ydb_data # рабочая директория
-e GRPC_TLS_PORT=2135 # grpcs порт должен соответствовать тому, что опубликовано выше
-e GRPC_PORT=2136 # grpc порт должен соответствовать тому, что опубликовано выше
-e MON_PORT=8765 # http порт должен соответствовать тому, что опубликовано выше
-e YDB_KAFKA_PROXY_PORT=9092 # порт Kafka должен соответствовать тому, что опубликовано выше
{{ ydb_local_docker_image}}:{{ ydb_local_docker_image_tag }}
)

docker run "${docker_args[@]}"
```

{% include [index.md](_includes/rosetta.md) %}
Expand Down