Install required packages

This step installs essential development tools, libraries, and dependencies required for building Apache Cloudberry.

Install basic system packages

The following command installs the full set of primary packages required for Cloudberry development:

For Rocky Linux 8+

sudo dnf install -y apr-devel \
  bison \
  bzip2-devel \
  cmake3 \
  diffutils \
  flex \
  gcc \
  gcc-c++ \
  glibc-langpack-en \
  glibc-locale-source \
  iproute \
  krb5-devel \
  libcurl-devel \
  libevent-devel \
  libxml2-devel \
  libuuid-devel \
  libzstd-devel \
  lz4-devel \
  net-tools \
  openldap-devel \
  openssl-devel \
  openssh-server \
  pam-devel \
  perl \
  perl-ExtUtils-Embed \
  perl-Test-Simple \
  perl-Env \
  python3-devel \
  readline-devel \
  rsync \
  wget \
  which \
  zlib-devel

Enable additional development tools and libraries

For Rocky Linux, we also need to install CodeReady Builder (CRB) or devel repos- they can provide additional development tools and libraries.

On Rocky Linux, they are disabled by default and must be explicitly enabled.

For Rocky Linux 8

sudo dnf install -y --enablerepo=devel libuv-devel libyaml-devel perl-IPC-Run protobuf-devel

For Rocky Linux 9

sudo dnf install -y --enablerepo=crb libuv-devel libyaml-devel perl-IPC-Run protobuf-devel

note

In Red Hat Enterprise Linux (RHEL), this repository is called "PowerTools."

Install gcc/gcc-c++ 11+ for Rocky Linux 8 (Optional)

For Rocky Linux 8, we need to install the higher version of gcc and gcc-c++ to build Apache Cloudberry with PAX support:

sudo yum install -y gcc-toolset-11-gcc gcc-toolset-11-gcc-c++
scl enable gcc-toolset-11 bash # for temprory use
sudo echo "source /opt/rh/gcc-toolset-11/enable" >> /etc/profile.d/gcc.sh
sudo source /etc/profile.d/gcc.sh #  for permanent use

You can verify the gcc and gcc-c++ 11+ version by running:

gcc --version
g++ --version

Install Apache Xerces-C for ORCA

Apache Xerces-C is a required dependency for enabling the Orca query optimizer in Cloudberry. The following steps download the source code, verify its integrity, build the library, and install it.

1. Set variables (helper)

   To streamline the commands and make them reusable, define the following helper variables:

   XERCES_LATEST_RELEASE=3.3.0
   XERCES_INSTALL_PREFIX="/usr/local/xerces-c"

note

These variables are used throughout the build process to specify the version of Apache Xerces-C being installed (XERCES_LATEST_RELEASE) and its installation directory (XERCES_INSTALL_PREFIX). This ensures consistency and simplifies the commands.

2. Download and verify the source package

   wget -nv "https://dlcdn.apache.org//xerces/c/3/sources/xerces-c-${XERCES_LATEST_RELEASE}.tar.gz"
   echo "$(curl -sL https://dlcdn.apache.org//xerces/c/3/sources/xerces-c-${XERCES_LATEST_RELEASE}.tar.gz.sha256)" | sha256sum -c -

note

Ensure the SHA-256 checksum validation passes (output: xerces-c-3.3.0.tar.gz: OK). If it fails, do not proceed and verify the source package's integrity.

3. Extract, configure, build, test, and install

   tar xf "xerces-c-${XERCES_LATEST_RELEASE}.tar.gz"
   rm "xerces-c-${XERCES_LATEST_RELEASE}.tar.gz"
   cd xerces-c-${XERCES_LATEST_RELEASE}
   
   ./configure --prefix="${XERCES_INSTALL_PREFIX}-${XERCES_LATEST_RELEASE}" | tee configure-$(date "+%Y.%m.%d-%H.%M.%S").log
   make -j$(nproc) | tee make-$(date "+%Y.%m.%d-%H.%M.%S").log
   make check | tee make-check-$(date "+%Y.%m.%d-%H.%M.%S").log
   sudo make install | tee make-install-$(date "+%Y.%m.%d-%H.%M.%S").log
   sudo ln -s ${XERCES_INSTALL_PREFIX}-${XERCES_LATEST_RELEASE} ${XERCES_INSTALL_PREFIX}

note

• The make command is run in parallel (-j$(nproc)) to leverage all available CPU cores for faster builds. The nproc command dynamically retrieves the number of cores.
• During make check, failures listed as XFAIL (expected failures) are acceptable and do not indicate a problem with the build.
• The output of the commands are saved to timestamped log files for future reference or troubleshooting.

For Ubuntu 22.04+

For Ubuntu users:

• The gcc and g++ versions in Ubuntu 22.04+ are sufficient for building Apache Cloudberry.
• We will use the default version of libxerces-c available in the Ubuntu repositories, which is compatible with Apache Cloudberry.

sudo apt install -y gcc g++ libxml2-dev pkg-config bzip2 libzstd-dev bison python3 flex python3-dev libreadline-dev  libuv1-dev libkrb5-dev libapr1-dev libevent-dev libyaml-dev libssl-dev libpam0g-dev libcurl4-gnutls-dev libbz2-dev libldap2-dev libxerces-c-dev libperl-dev libipc-run-perl make cmake libprotobuf-dev python3-setuptools iproute2 iputils-ping rsync liblz4-dev protobuf-compiler language-pack-en locales