open3fs/3fs-build repository overview

⁠3FS Build Environment

This Docker image provides a comprehensive build environment for the deepseek-ai/3fs distributed file system. It includes all the necessary dependencies and tools to compile and build 3fs from source.

Key Features:

• Base Image: Ubuntu Jammy (20250126)
• Compilers: clang-14, clang-format-14, clang-tidy-14, g++-12, gcc-12
• Build Tools: cmake, meson, ninja
• Libraries: libaio-dev, libboost-all-dev, libdouble-conversion-dev, libdwarf-dev, libgflags-dev, libgmock-dev, libgoogle-glog-dev, libgoogle-perftools-dev, libgtest-dev, liblz4-dev, liblzma-dev, libprocps-dev, libssl-dev, libunwind-dev, libuv1-dev, libjemalloc-dev
• Other Tools: git, wget, lld-14, curl, google-perftools
• Rust Support: rustup with the latest stable Rust toolchain
• FoundationDB: Pre-installed FoundationDB clients and server (version 7.3.63)
• Default Compilers: gcc-12 and g++-12 are set as the default compilers

Usage:

1. Pull the image: docker pull open3fs/3fs-build

2. Create a container and mount your 3fs source code directory:

   docker run -it -v /path/to/your/3fs/source:/3fs open3fs/3fs-build
   

   Copy

3. Maybe you need to set git safe.directory firstly:

   git config --global --add safe.directory /3fs
   

   Copy

4. Pull submodules

   git submodule update --init --cursive
   

   Copy

5. Apply patch

   ./patches/apply.sh
   

   Copy

6. Build 3fs within the container using the provided tools and dependencies.

   cmake -S . -B build -DCMAKE_CXX_COMPILER=clang++-14 -DCMAKE_C_COMPILER=clang-14 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
   cmake --build build -j $(nproc)
   

   Copy

Notes:

• The image includes pre-installed FoundationDB clients and server, which are required for 3fs.
• The working directory inside the container is set to /3fs.
• You can customize the build process further by modifying the Dockerfile or providing additional build arguments.

This image simplifies the process of setting up a build environment for 3fs, making it easier to compile and experiment with the file system.