Try a preview of AI-powered search below!

• AlmaLinux
• macOS
• CentOS
• Ubuntu

The following instructions are for Ubuntu 20.04, 22.04, and 23.04.

Install necessary packages

Update and install basic development packages as follows:

sudo apt update
sudo apt upgrade -y
packages=(
  autoconf
  build-essential
  curl
  gettext
  git
  locales
  pkg-config
  rsync
)
sudo apt install -y "${packages[@]}"
sudo locale-gen en_US.UTF-8

/opt/yb-build

By default, when running build, third-party libraries are not built, and pre-built libraries are downloaded. We also use Linuxbrew to provide some of the third-party dependencies. The build scripts automatically install these in directories under /opt/yb-build. In order for the build script to write under those directories, it needs proper permissions. One way to do that is as follows:

sudo mkdir /opt/yb-build
sudo chown "$USER" /opt/yb-build

Alternatively, specify the build options --no-download-thirdparty and/or --no-linuxbrew. Note that those options may require additional, undocumented steps.

Python 3

Python 3.7 or higher is required.

sudo apt install -y libffi-dev python3 python3-dev python3-venv

CMake 3

CMake 3.17.3 or higher is required.

The CMake version in the package manager is too old (3.16), so manually download a release as follows:

mkdir ~/tools
curl -L "https://github.com/Kitware/CMake/releases/download/v3.25.2/cmake-3.25.2-linux-x86_64.tar.gz" | tar xzC ~/tools
# Also add the following line to your .bashrc or equivalent.
export PATH="$HOME/tools/cmake-3.25.2-linux-x86_64/bin:$PATH"

Java

YugabyteDB core is written in C and C++, but the repository contains Java code needed to run some tests and sample applications. To build the Java part, you need:

• Java Development Kit (JDK) 8 or 11.
• Apache Maven 3.3 or later.

Install the following package to satisfy the preceding requirements:

sudo apt install -y maven

yugabyted-ui

yugabyted-ui is a UI for yugabyted. By default, it is not built unless the corresponding build option is specified or a release package is being built. To build it, npm and Go 1.18 or higher are required.

sudo apt install -y npm golang-1.18
# Also add the following line to your .bashrc or equivalent.
export PATH="/usr/lib/go-1.18/bin:$PATH"

For Ubuntu 23.04, install golang-1.20 instead since 1.18 is not available.

Ninja (optional)

Install Ninja for faster builds as follows:

sudo apt install -y ninja-build

Ccache (optional)

Install and configure Ccache for faster builds as follows:

sudo apt install -y ccache
# Also add the following line to your .bashrc or equivalent.
export YB_CCACHE_DIR="$HOME/.cache/yb_ccache"

GCC (optional)

To compile with GCC, install the following packages, and adjust the version numbers to match the GCC version you plan to use.

sudo apt install -y gcc-13 g++-13

Build the code

Assuming this repository is checked out in ~/code/yugabyte-db, do the following:

cd ~/code/yugabyte-db
./yb_build.sh release

The command above will build the release configuration, add the binaries into the build/release-<compiler>-dynamic-ninja directory, and create a build/latest symlink to that directory.

For more details about building and testing, refer to Build and test.

Build release package (optional)

Perform the following steps to build a release package:

1. Satisfy requirements for building yugabyted-ui.

2. Install additional packages using the following command:

   sudo apt install -y file patchelf
   

3. Run the yb_release script using the following command:

   ./yb_release
   

   ......
   2023-02-17 01:26:37,156 [yb_release.py:299 INFO] Generated a package at '/home/user/code/yugabyte-db/build/yugabyte-2.17.2.0-ede2a2619ea8470064a5a2c0d7fa510dbee3ce81-release-clang15-ubuntu20-x86_64.tar.gz'
   

echo "* - nofile 1048576" | sudo tee -a /etc/security/limits.conf