BeeGFS (formerly FhGFS) is the leading parallel cluster file system, developed with a strong focus on performance and designed for very easy installation and management. If I/O intensive workloads are your problem, BeeGFS is the solution.
Homepage: https://www.beegfs.io
Documentation: https://doc.beegfs.io/
If you don't need/want to build BeeGFS from sources, prebuilt packages for both x86 and ARM are available for many popular Linux distributions.
Prior to BeeGFS 8, all development happened in a private Git repository, with the source code for each release squashed into a single commit in the public Git repository. As part of BeeGFS 8, the opportunity came up to rewrite some components and make the full history of the new components public. For this to happen the source code is split across these repositories:
beegfs- The main public repository containing all original C/C++ components, notably the Metadata and Storage services along with the Client kernel module and file system checker.beegfs-rust- New BeeGFS components written in Rust, notably the Management service.beegfs-go- New BeeGFS components written in Go, notably the BeeGFS command-line tool (CTL).protobuf- Common protocol buffer and gRPC service definitions along with generated library code to interact with new BeeGFS services from multiple languages including C++, Go, Rust, etc.- For Go, comprehensive libraries for fully managing BeeGFS can be found in
beegfs-go.
- For Go, comprehensive libraries for fully managing BeeGFS can be found in
It is only necessary to clone the repo(s) containing the component(s) you wish to modify or build from sources. If you wanted to build everything you would need to clone all three repositories:
git clone [email protected]:ThinkParQ/beegfs.gitgit clone [email protected]:ThinkParQ/beegfs-rust.gitgit clone [email protected]:ThinkParQ/beegfs-go.git
Then refer to each repositories' README for directions on how to get started including installing any prerequisites and building packaged or unpackaged binaries for the components provided by that repo.
Note: It is not necessary to clone the protobuf repo to build BeeGFS from sources. This is only
needed to modify the protocol buffers or develop an application that integrates with BeeGFS.
Before building BeeGFS, install the following dependency packages:
$ yum install libuuid-devel libibverbs-devel librdmacm-devel libattr-devel redhat-rpm-config \
rpm-build xfsprogs-devel zlib-devel gcc-c++ gcc \
redhat-lsb-core unzip libcurl-devel elfutils-libelf-devel kernel-devel \
libblkid-devel libnl3-devel
The elfutils-libelf-devel and kernel-devel packages can be omitted if you don't intend to
build the client module.
On RHEL releases older than 8, the additional devtoolset-7 package is also required,
which provides a newer compiler version. The installation steps are outlined here.
Please consult the documentation of your distribution for details.
- Install a package with repository for your system:
- On CentOS, install package centos-release-scl available in CentOS repository:
$ sudo yum install centos-release-scl - On RHEL, enable RHSCL repository for you system:
$ sudo yum-config-manager --enable rhel-server-rhscl-7-rpms
-
Install the collection:
$ sudo yum install devtoolset-7 -
Start using software collections:
$ scl enable devtoolset-7 bash -
Follow the instructions below to build BeeGFS.
Install required utilities:
$ apt install --no-install-recommends devscripts equivs
Automatically install build dependencies:
$ mk-build-deps --install debian/control
Run this command to install the required packages:
$ sudo apt install build-essential autoconf automake pkg-config devscripts debhelper \
libtool libattr1-dev xfslibs-dev lsb-release kmod librdmacm-dev libibverbs-dev \
default-jdk zlib1g-dev libssl-dev libcurl4-openssl-dev libblkid-dev uuid-dev \
libnl-3-200 libnl-3-dev libnl-genl-3-200 libnl-route-3-200 libnl-route-3-dev dh-dkms
Note: If you have an older Debian system you might have to install the module-init-tools
package instead of kmod. You also have the choice between the openssl, nss, or gnutls version
of libcurl-dev. Choose the one you prefer. On Debian versions older than 12, replace dh-dkms
by dkms.
BeeGFS comes with a Makefile capable of building packages for the system on which it is executed. These include all services, the client module and utilities.
To build RPM packages, run
$ make package-rpm PACKAGE_DIR=packages
You may also enable parallel execution with
$ make package-rpm PACKAGE_DIR=packages RPMBUILD_OPTS="-D 'MAKE_CONCURRENCY <n>'"
where <n> is the number of concurrent processes.
For DEB packages use this command:
$ make package-deb PACKAGE_DIR=packages
Or start with <n> jobs running in parallel:
$ make package-deb PACKAGE_DIR=packages DEBUILD_OPTS="-j<n>"
This will generate individual packages for each service (management, meta-data, storage) as well as the client kernel module and administration tools.
The above examples use packages as the output folder for packages, which must not exist
and will be created during the build process.
You may specify any other non-existent directory instead.
Note, however, that having PACKAGE_DIR on a NFS or similar network share may slow down
the build process significantly.
By default the packaging system generates version numbers suitable only for development
packages. Packages intended for installation on production systems must be built differently.
All instructions to build development packages (as given above) apply, but additionally the
package version must be explicitly set. This is done by passing BEEGFS_VERSION=<version>
in the make command line, e.g.
$ make package-deb PACKAGE_DIR=packages DEBUILD_OPTS="-j<n>" BEEGFS_VERSION=7.1.4-local1
Setting the version explicitly is required to generate packages that can be easily upgraded with the system package manager.
To build the complete project without generating any packages, simply run
$ make
The sub-projects have individual make targets, for example storage-all,
meta-all, etc.
To speed things you can use the -j option of make.
Additionally, the build system supports distcc:
$ make DISTCC=distcc
Detailed guides on how to configure BeeGFS can be found at doc.beegfs.io
Of course, we are curious about what you are doing with the BeeGFS sources, so don't forget to drop us a note...