Running YugabyteDB in a docker container

[LexLuthr]

Install Docker

Before installing YugabyteDB, ensure that you have the Docker runtime installed on your localhost. To download and install Docker, select one of the following environments:

Docker for Mac

Docker for CentOS

Docker for Ubuntu

Docker for Debian

Docker for Windows

Pull the YugabyteDB Docker Image

Open a terminal and pull the YugabyteDB Docker image:

docker pull yugabytedb/yugabyte:2024.1.0.0-b129

Create a Directory for Yugabyte Home

Create a local directory to be used as the Yugabyte home directory inside the container:

mkdir -p /path/to/yugabyte-home

Replace /path/to/yugabyte-home with your desired path. This path will be used to store all YugabyteDB related data.

Run the YugabyteDB Container

Run the following command to start the YugabyteDB container with the specified ports bound and the local directory mounted as a volume:

docker run -d --name yugabytedb \
    -p7000:7000 \
    -p7100:7100 \
    -p9000:9000 \
    -p9100:9100 \
    -p5433:5433 \
    -p15433:15433\
    -v /path/to/yugabyte-home:/home/yugabyte/yb_data \
    yugabytedb/yugabyte:2024.1.0.0-b129 bin/yugabyted start --base_dir=/home/yugabyte/yb_data --background=false

Explanation of the Command:

Command Part	Explanation
docker run -d	Run the container in detached mode otherwise container lifetime will tied to your terminal session
--name yugabytedb	Name the container yugabytedb
-p <host_port>:<container_port>	Map the container ports to the host ports
7000	Master Admin UI
7100	Master RPC
9000	TServer Admin UI
9100	TServer RPC
9042	YCQL port
5433	YSQL port
15433	YugabyteDB UI
-v /path/to/yugabyte-home:/home/yugabyte/yb_data	Mount the local directory to /home/yugabyte/yb_data inside the container
yugabytedb/yugabyte:2.5.0.0-b2 bin/yugabyted start --base_dir=/home/yugabyte	Start the YugabyteDB server with the base directory set to the mounted volume

Verify the Deployment

Check the running container with:

docker ps

Access YugabyteDB

Access the YugabyteDB web interfaces using the http://localhost:15433
Connect to the database using YCQL or YSQL clients on ports 9042 and 5433, respectively.

You've successfully deployed a YugabyteDB container on Docker with the specified ports bound and a local filesystem mounted as the Yugabyte home directory.