This document guides you on how to quickly set up and connect to Apache Cloudberry in a Docker environment. You can try out Apache Cloudberry by performing some basic operations and running SQL commands.
[!WARNING] This guide is intended for testing or development. DO NOT use it for production.
[!WARNING] Security Notice: Embedded SSH Keys
For ease of use, this sandbox environment includes pre-generated SSH keys embedded in the Docker image. All containers built from the same image share the same SSH keypair, allowing passwordless SSH communication between nodes.
This is ONLY acceptable for local testing and development environments. These embedded keys are NOT secure and must NEVER be used in production or any environment where security is a concern. Anyone with access to the Docker image can extract these keys.
Make sure that your environment meets the following requirements:
When building and deploying Apache Cloudberry in Docker, you will have 2 different deployment options as well as different build options.
Deployment Options
run.sh script provided.run.sh script which will be highlighted below.
Build Options
-c local. This is the fastest way to get started as it reuses your existing checkout, avoiding the need to download the code again inside the container. It is also ideal for developers testing local changes.Build and deploy steps:
Start Docker Desktop and make sure it is running properly on your host platform.
Clone the Apache Cloudberry repository to the target machine.
git clone https://github.com/apache/cloudberry.git
Enter the repository and run the run.sh script to start the Docker container. This will start the automatic installation process. Depending on your environment, you may need to run this with ‘sudo’ command.
Recommended: Build from your current local source code (single container)
This is the most efficient option for both new users and developers. It uses your local checkout directly, saving time by skipping the code download step inside the container. It also allows you to immediately test any local code modifications.
cd cloudberry/devops/sandbox ./run.sh -c local
Recommended: Build from your current local source code (multi-container)
Same as above, but deploys a multi-container cluster. Ideal for testing distributed features or high availability with your local code.
cd cloudberry/devops/sandbox ./run.sh -c local -m
cd cloudberry/devops/sandbox ./run.sh -c 2.0.0
cd cloudberry/devops/sandbox ./run.sh -c 2.0.0 -m
cd cloudberry/devops/sandbox ./run.sh -c main
cd cloudberry/devops/sandbox ./run.sh -c main -m
Once the script finishes without error, the sandbox is built and running successfully. The docker run and docker compose commands use the --detach option allowing you to ssh or access the running Apache Cloudberry instance remotely.
Please review run.sh script for additional options (e.g. setting Timezone in running container, only building container). You can also execute ./run.sh -h to see the usage.
[!NOTE] When deploying the multi-container Apache Cloudberry environment it may take extra time for the database to initialize, so you may need to wait a few minutes before you can execute the psql prompt successfully. You can run
docker logs cbdb-cdw -fto see the current state of the database initialization process, you'll know the process is finished when you see the “Deployment Successful” output.
You can now connect to the database and try some basic operations.
Connect to the Docker container from the host machine:
docker exec -it cbdb-cdw /bin/bash
If it is successful, you will see the following prompt:
[gpadmin@cdw /]$
Log into Apache Cloudberry in Docker. See the following commands and example outputs:
[gpadmin@cdw ~]$ psql # Connects to the database with the default database name "gpadmin". # psql (14.4, server 14.4) # Type "help" for help. # Note: No password is required for the gpadmin user in this sandbox environment.
gpadmin=# SELECT VERSION(); -- Checks the database version. PostgreSQL 14.4 (Apache Cloudberry 1.0.0 build dev) on aarch64-unknown-linux-gnu, compiled by gcc (GCC) 10.2.1 20210130 (Red Hat 10.2.1-11), 64-bit compiled on Oct 24 2023 10:24:28 (1 row)
Alternatively, you can connect to the database directly from your host machine without entering the container:
The Apache Cloudberry coordinator port (default 5432) is mapped to port 15432 on your host machine. You can use the psql client on your host to connect directly:
# Connect from host machine psql -h localhost -p 15432 -d postgres -U gpadmin
[!NOTE]
- No password is required for the
gpadminuser in this sandbox environment.- Make sure you have PostgreSQL client (
psql) installed on your host machine.- The port mapping is: Container port
5432→ Host port15432
Now you have an Apache Cloudberry and can continue with Apache Cloudberry Tutorials! Enjoy!
When working with the Apache Cloudberry Docker environment there are a few commands that will be useful to you.
Stopping Your Single Container Deployment With Docker
To stop the single container deployment while keeping the data and state within the container, you can run the command below. This means that you can later start the container again and any changes you made to the containers will be persisted between runs.
docker stop cbdb-cdw
To stop the single container deployment and also remove the volume that belongs to the container, you can run the following command. Keep in mind this will remove the volume as well as the container associated which means any changes you've made inside of the container or any database state will be wiped and unrecoverable.
docker rm -f cbdb-cdw
Stopping Your Multi-Container Deployment With Docker
To stop the multi-container deployment while keeping the data and state within the container, you can run the command below. This means that you can later start the container again and any changes you made to the containers will be persisted between runs.
docker compose -f docker-compose-rockylinux9.yml stop
To stop the multi-container deployment and also remove the network and volumes that belong to the containers, you can run the command below. Running this command means it will delete the containers as well as remove the volumes that the containers are associated with. This means any changes you've made inside of the containers or any database state will be wiped and unrecoverable.
docker compose -f docker-compose-rockylinux9.yml down -v
Starting A Stopped Single Container Apache Cloudberry Docker Deployment
If you‘ve run any of the commands above that keep the Docker volumes persisted between shutting the containers down, you can use the following commands to bring that same deployment back up with it’s previous state.
To start a single container deployment after it was shut down, you can simply run the following
docker start cbdb-cdw
Starting A Stopped Multi-Container Apache Cloudberry Docker Deployment
To start a multi-container deployment after it was shut down, you can run the following command.
docker compose -f docker-compose-rockylinux9.yml start
[!NOTE] When starting a previously stopped Apache Cloudberry Docker environment, you'll need to manually start the database back up. To do this, just run the following commands once the container(s) are back up and running. The
gpstartcommand is used for starting the database, and -a is a flag saying to start the database without prompting (non-interactive).
docker exec -it cbdb-cdw /bin/bash [gpadmin@cdw /] gpstart -a