-
Notifications
You must be signed in to change notification settings - Fork 203
Add Dockerfile and docs for building Cloudberry Docker Images #1607
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.
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
Draft
tuhaihe
wants to merge
2
commits into
apache:main
Choose a base branch
from
tuhaihe:devops-docker-image
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+540
−0
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| # -------------------------------------------------------------------- | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # -------------------------------------------------------------------- | ||
| # Dockerfile for Apache Cloudberry (Incubating) - Production Build | ||
| # -------------------------------------------------------------------- | ||
| # Multi-stage build optimized for production deployment | ||
| # Builds Cloudberry from source using official development environment | ||
| # -------------------------------------------------------------------- | ||
|
|
||
| # -------------------------------------------------------------------- | ||
| # Build stage: Use official Cloudberry development image | ||
| # -------------------------------------------------------------------- | ||
| ARG BUILDER_IMAGE=apache/incubator-cloudberry:cbdb-build-rocky9-latest | ||
| FROM ${BUILDER_IMAGE} AS builder | ||
|
|
||
| # Copy source code | ||
| COPY --chown=gpadmin:gpadmin . /home/gpadmin/cloudberry | ||
|
|
||
| # Build Cloudberry using official build scripts | ||
| USER gpadmin | ||
| WORKDIR /home/gpadmin/cloudberry | ||
|
|
||
| RUN sudo dnf install -y --enablerepo=crb liburing-devel && \ | ||
| export SRC_DIR=/home/gpadmin/cloudberry && \ | ||
| export BUILD_DESTINATION=/usr/local/cloudberry-db && \ | ||
| mkdir -p ${SRC_DIR}/build-logs && \ | ||
| ./devops/build/automation/cloudberry/scripts/configure-cloudberry.sh && \ | ||
| ./devops/build/automation/cloudberry/scripts/build-cloudberry.sh | ||
|
|
||
| # -------------------------------------------------------------------- | ||
| # Runtime stage: Minimal production image | ||
| # -------------------------------------------------------------------- | ||
| FROM rockylinux/rockylinux:9.6 | ||
|
|
||
| # Set locale environment and timezone | ||
| ENV TZ=UTC | ||
| ENV LANG=en_US.UTF-8 | ||
| ENV LC_ALL=en_US.UTF-8 | ||
|
|
||
| # Cloudberry environment variables | ||
| ENV GPHOME=/usr/local/cloudberry-db | ||
| ENV PATH=$GPHOME/bin:$PATH | ||
| ENV LD_LIBRARY_PATH=$GPHOME/lib | ||
| ENV COORDINATOR_DATA_DIRECTORY=/data0/database/coordinator/gpseg-1 | ||
|
|
||
| # Runtime dependencies (keep aligned with devops/sandbox/Dockerfile.*.rockylinux9 where possible) | ||
| # Note: do NOT install libcurl here to avoid rocky9 libcurl-minimal conflicts. | ||
| RUN dnf -y install --setopt=install_weak_deps=False \ | ||
| apr \ | ||
| bash \ | ||
| bzip2-libs \ | ||
| ca-certificates \ | ||
| glibc-langpack-en \ | ||
| iproute \ | ||
| keyutils \ | ||
| krb5-libs \ | ||
| libevent \ | ||
| libicu \ | ||
| libstdc++ \ | ||
| liburing \ | ||
| libuv \ | ||
| libuuid \ | ||
| libxml2 \ | ||
| libyaml \ | ||
| libzstd \ | ||
| lz4 \ | ||
| ncurses \ | ||
| net-tools \ | ||
| openldap \ | ||
| openssh-clients \ | ||
| openssh-server \ | ||
| openssl \ | ||
| pam \ | ||
| pcre2 \ | ||
| perl \ | ||
| procps-ng \ | ||
| protobuf \ | ||
| python3 \ | ||
| readline \ | ||
| rsync \ | ||
| shadow-utils \ | ||
| sudo \ | ||
| which \ | ||
| zlib && \ | ||
| dnf clean all && rm -rf /var/cache/dnf | ||
|
|
||
| # Set locale, create gpadmin user, and setup directories & SSH config | ||
| RUN echo "LANG=en_US.UTF-8" > /etc/locale.conf && \ | ||
| /usr/sbin/groupadd -r gpadmin && \ | ||
| /usr/sbin/useradd -m -r -g gpadmin gpadmin && \ | ||
| printf "Defaults:gpadmin !requiretty\ngpadmin ALL=(ALL) NOPASSWD: ALL\n" > /etc/sudoers.d/90-gpadmin && \ | ||
| chmod 440 /etc/sudoers.d/90-gpadmin && \ | ||
| echo -e '\n# Add Cloudberry entries\nif [ -f /usr/local/cloudberry-db/cloudberry-env.sh ]; then\n source /usr/local/cloudberry-db/cloudberry-env.sh\nfi' >> /home/gpadmin/.bashrc && \ | ||
| mkdir -p /data0/database/coordinator /data0/database/primary /data0/database/mirror && \ | ||
| mkdir -p /home/gpadmin/.ssh && \ | ||
| mkdir -p /run/sshd && \ | ||
| chown -R gpadmin:gpadmin /data0 /home/gpadmin/.ssh && \ | ||
| chmod 700 /home/gpadmin/.ssh && \ | ||
| echo -e "Host *\n StrictHostKeyChecking no\n UserKnownHostsFile ~/.ssh/known_hosts\n ServerAliveInterval 60" > /home/gpadmin/.ssh/config && \ | ||
| chown gpadmin:gpadmin /home/gpadmin/.ssh/config && \ | ||
| chmod 600 /home/gpadmin/.ssh/config | ||
|
|
||
| # Copy configuration files from sandbox (reusable components) | ||
| COPY --chown=gpadmin:gpadmin devops/sandbox/configs/gpinitsystem_singlenode /tmp/gpinitsystem_singlenode | ||
|
|
||
| # Reuse sandbox tuning configs (note: sysctls require privileged/sysctl support at runtime) | ||
| COPY devops/sandbox/configs/90-cbdb-limits.conf /etc/security/limits.d/90-cbdb-limits.conf | ||
| COPY devops/sandbox/configs/90-cbdb-sysctl.conf /etc/sysctl.d/90-cbdb-sysctl.conf | ||
|
|
||
| # Copy custom scripts | ||
| COPY --chown=gpadmin:gpadmin devops/build/packaging/docker/cloudberry-entrypoint.sh /usr/local/bin/cloudberry-entrypoint.sh | ||
|
|
||
| # Set executable permissions | ||
| RUN chmod 755 /usr/local/bin/cloudberry-entrypoint.sh /tmp/gpinitsystem_singlenode | ||
|
|
||
| # Copy built Cloudberry from builder stage | ||
| COPY --from=builder --chown=gpadmin:gpadmin /usr/local/cloudberry-db /usr/local/cloudberry-db | ||
| COPY --from=builder --chown=gpadmin:gpadmin /usr/local/xerces-c/lib/libxerces-c.so /usr/local/cloudberry-db/lib/ | ||
| COPY --from=builder --chown=gpadmin:gpadmin /usr/local/xerces-c/lib/libxerces-c-3.*.so /usr/local/cloudberry-db/lib/ | ||
|
|
||
| # Expose coordinator port | ||
| EXPOSE 5432 | ||
|
|
||
| # Healthcheck: coordinator readiness (initialization can take a while) | ||
| HEALTHCHECK --interval=10s --timeout=5s --start-period=5m --retries=6 \ | ||
| CMD /usr/local/cloudberry-db/bin/pg_isready -h localhost -p 5432 || exit 1 | ||
|
|
||
| # Volume for persistent data | ||
| VOLUME ["/data0"] | ||
|
|
||
| # Set default user | ||
| USER gpadmin | ||
|
|
||
| # Entrypoint and default command | ||
| ENTRYPOINT ["/usr/local/bin/cloudberry-entrypoint.sh"] | ||
| CMD ["cloudberry"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| # Apache Cloudberry (Incubating) Docker image (Rocky Linux 9) | ||
|
|
||
| This directory contains Docker build definitions for a single-node Apache Cloudberry container image. | ||
|
|
||
| ## Build | ||
|
|
||
| Build from the current source tree (multi-stage build using a pre-built builder image): | ||
|
|
||
| ```bash | ||
| docker build \ | ||
| -f devops/build/packaging/docker/Dockerfile.rocky9 \ | ||
| -t apache/cloudberry:dev . | ||
| ``` | ||
|
|
||
| Override the builder image (for example, pin to a digest/tag or use a locally-built builder): | ||
|
|
||
| ```bash | ||
| docker build \ | ||
| -f devops/build/packaging/docker/Dockerfile.rocky9 \ | ||
| --build-arg BUILDER_IMAGE=apache/incubator-cloudberry:cbdb-build-rocky9-latest \ | ||
| -t apache/cloudberry:dev . | ||
| ``` | ||
|
|
||
| ## Run | ||
|
|
||
| On first startup the container initializes a single-node cluster under `/data0` and starts it. By default, host connections use `trust` authentication to facilitate seamless development and testing workflows. | ||
|
|
||
| ```bash | ||
| docker volume create cloudberry_data | ||
|
|
||
| docker run --rm -it \ | ||
| --name cloudberry-db \ | ||
| -p 5432:5432 \ | ||
| -v cloudberry_data:/data0 \ | ||
| apache/cloudberry:dev | ||
| ``` | ||
|
|
||
| When run interactively (with `-it` and without `-d`), the container initializes the cluster and immediately drops you into a `psql` prompt. | ||
|
|
||
| If you prefer to run it in the background (detached), use the `-d` flag. **Important**: Do not combine `-d` with `-t` or `-it`, otherwise the container will attempt to start the interactive SQL prompt and exit immediately. | ||
|
|
||
| ```bash | ||
| docker run --rm -d \ | ||
| --name cloudberry-db \ | ||
| -p 5432:5432 \ | ||
| -v cloudberry_data:/data0 \ | ||
| apache/cloudberry:dev | ||
| ``` | ||
|
|
||
| If you require production-level security (e.g., password enforcement), simply run the container with `-e POSTGRES_HOST_AUTH_METHOD=md5` and provide a `POSTGRES_PASSWORD`: | ||
|
|
||
| ```bash | ||
| docker run --rm -it \ | ||
| -d \ | ||
| --name cloudberry-db \ | ||
| -e POSTGRES_HOST_AUTH_METHOD=md5 \ | ||
| -e POSTGRES_PASSWORD=your_secure_password \ | ||
| -p 5432:5432 \ | ||
| -v cloudberry_data:/data0 \ | ||
| apache/cloudberry:dev | ||
| ``` | ||
|
|
||
| ## Connect / Inspect | ||
|
|
||
| From the host (assuming `trust` default or matching passwords): | ||
|
|
||
| ```bash | ||
| psql -h localhost -p 5432 -U gpadmin -d gpadmin | ||
| ``` | ||
|
|
||
| From inside the container (environment variables are already globally injected): | ||
|
|
||
| ```bash | ||
| docker exec -it cloudberry-db psql -d postgres | ||
| ``` | ||
|
|
||
| Cluster status and logs: | ||
|
|
||
| ```bash | ||
| docker exec cloudberry-db gpstate -s | ||
| docker logs cloudberry-db | ||
| ``` | ||
|
|
||
| ## Notes | ||
|
|
||
| - **Timezone:** The container defaults to `UTC` (`TZ=UTC`). To use a different timezone, pass the `TZ` environment variable during run (e.g., `-e TZ=Asia/Shanghai`). | ||
| - **Graceful Shutdown:** The entrypoint natively traps `SIGTERM`, `SIGINT`, and `SIGQUIT` to perform a safe `gpstop -a -M fast`. Standard `docker stop <container>` is perfectly safe and ensures data consistency. | ||
| - **Internal SSH:** `sshd` is started exclusively for internal cluster communication. Port 22 is not exposed by default. | ||
| - **System Limits:** For maximum performance, consider explicitly raising container limits at runtime: | ||
| `--ulimit nofile=524288:524288 --ulimit nproc=131072:131072`. | ||
| - **Tuning Configs:** Environment system configurations are powerfully reused from `devops/sandbox/configs/`: | ||
| `/etc/security/limits.d/90-cbdb-limits.conf` and `/etc/sysctl.d/90-cbdb-sysctl.conf`. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cd root directory of cloned main repo, my first launch was from
devops/build/packaging/docker/directory and it of course does not work