Compiling Lustre - Revision history

DetlevCM: Add a section on building patchless lustre on Rocky 9.4/9.6 and installing it, based on [LUDOC-553]

2025-12-08T16:57:21Z

Add a section on building patchless lustre on Rocky 9.4/9.6 and installing it, based on [LUDOC-553]

Adilger: /* Obtain the Lustre Source Code */ update URL to reference github

2025-12-05T19:12:37Z

Obtain the Lustre Source Code: update URL to reference github

← Older revision		Revision as of 11:12, 5 December 2025
Line 265:		Line 265:
	# Mock users: run "mock --shell" first		# Mock users: run "mock --shell" first
	cd $HOME		cd $HOME
	git clone git~~://git.whamcloud~~.com~~/fs~~/lustre-release.git		git clone git@github.com:lustre/lustre-release.git
	</pre>		</pre>

Adilger: /* Building Lustre - TLDR Guide */ update download URL to use github

2025-12-05T19:11:56Z

Building Lustre - TLDR Guide: update download URL to use github

← Older revision		Revision as of 11:11, 5 December 2025
Line 13:		Line 13:
	To build 'only' Lustre RPMs against the currently-installed kernel, the process is relatively simple. You need to have the ''EXACTLY IDENTICAL'' '''kernel-devel''' package installed for your currently-installed kernel, and basic building tools like '''rpmbuild''', '''gcc''', '''autoconf''', and rpmbuild will complain about anything else that is missing.		To build 'only' Lustre RPMs against the currently-installed kernel, the process is relatively simple. You need to have the ''EXACTLY IDENTICAL'' '''kernel-devel''' package installed for your currently-installed kernel, and basic building tools like '''rpmbuild''', '''gcc''', '''autoconf''', and rpmbuild will complain about anything else that is missing.
	<pre>		<pre>
	$ git clone git~~://git.whamcloud~~.com~~/fs~~/lustre-release.git		$ git clone git@github.com:lustre/lustre-release.git
	$ cd lustre-release		$ cd lustre-release
	$ git checkout b2_15 # optional		$ git checkout b2_15 # optional

Adilger: /* Development Software Installation for Normal Build Process */ update package list

2024-05-10T00:39:41Z

Development Software Installation for Normal Build Process: update package list

← Older revision		Revision as of 16:39, 9 May 2024
Line 185:		Line 185:

	<pre style="white-space: pre-wrap;">		<pre style="white-space: pre-wrap;">
	sudo yum install ~~asciidoc audit-libs-devel~~ automake bc binutils-devel \		# sudo yum install automake bc binutils-devel \
	bison ~~device-mapper-devel~~ elfutils-devel elfutils-libelf-devel expect \		bison elfutils-devel elfutils-libelf-devel expect \
	flex gcc gcc-c++ git glib2 glib2-devel ~~hmaccalc~~ keyutils-libs-devel \		flex gcc gcc-c++ git glib2 glib2-devel keyutils-libs-devel \
	krb5-devel ~~ksh~~ libattr-devel libblkid-devel libselinux-devel libtool \		krb5-devel libattr-devel libblkid-devel libmount-devel libnl3-devel \
	libuuid-devel libyaml-devel ~~lsscsi~~ make ncurses-devel ~~net-snmp-devel \~~		libselinux-devel libtool libuuid-devel libyaml-devel kernel-devel \
	net-tools ~~newt-devel numactl-devel parted patchutils pciutils-devel \~~		make ncurses-devel net-tools python3-devel redhat-rpm-config rpm-build \
	~~perl-ExtUtils-Embed pesign python~~-devel redhat-rpm-config rpm-build \		systemd-devel wget yum-utils zlib-devel
	systemd~~-devel tcl tcl-devel tk tk~~-devel wget ~~xmlto~~ yum-utils zlib-devel
	</pre>		</pre>

Adilger: /* Save the Kernel RPMs */ add e2fsprogs

2024-05-09T23:33:39Z

Save the Kernel RPMs: add e2fsprogs

@@ Line 571: / Line 571: @@
 mkdir -p $HOME/releases/lustre-kernel
 mv $_TOPDIR/RPMS/*/{kernel-*,python-perf-*,perf-*} $HOME/releases/lustre-kernel
 </pre>

Adilger: /* Create the Client RPMs */ fix formatting

2024-05-07T15:04:26Z

Create the Client RPMs: fix formatting

← Older revision		Revision as of 07:04, 7 May 2024
Line 1,536:		Line 1,536:
	make distclean		make distclean

	Run the configure script. To create client packages, incorporate the <code>--disable-server</code< and <code>--enable-client</code> flags:		Run the configure script. To create client packages, incorporate the <code>--disable-server</code> and <code>--enable-client</code> flags:

	<pre style="overflow-x:auto;">		<pre style="overflow-x:auto;">

Adilger: /* Preparation */

2024-05-07T15:03:07Z

Preparation

← Older revision		Revision as of 07:03, 7 May 2024
Line 1,186:		Line 1,186:
	When compiling the Lustre packages from source, the build environment requires access to the kernel development package for the target Linux kernel, and in the case of patchless LDISKFS servers, the kernel source code is also needed. The requirements are as follows:		When compiling the Lustre packages from source, the build environment requires access to the kernel development package for the target Linux kernel, and in the case of patchless LDISKFS servers, the kernel source code is also needed. The requirements are as follows:

			* '''''Patchless''''' LDISKFS Lustre servers require the standard kernel development package and the matching kernel source code package.
	* Patched LDISKFS Lustre servers require the kernel development package that has been created with the Lustre patches applied (the "lustre-patched kernel")		* Patched LDISKFS Lustre servers require the kernel development package that has been created with the Lustre patches applied (the "lustre-patched kernel")
	* [Experimental] '''''Patchless''''' LDISKFS Lustre servers require the standard kernel development package and the matching kernel source code package.
	* ZFS-based Lustre servers and all Lustre clients require the standard kernel development package		* ZFS-based Lustre servers and all Lustre clients require the standard kernel development package

Adilger: /* Compiling the Network Fabric Kernel Drivers */ fix formatting

2024-05-07T15:02:21Z

Compiling the Network Fabric Kernel Drivers: fix formatting

← Older revision		Revision as of 07:02, 7 May 2024
Line 1,119:		Line 1,119:
	'''Note:''' In the command line arguments, the definition of the variable <code>configure_options</code> must appear on a single line.		'''Note:''' In the command line arguments, the definition of the variable <code>configure_options</code> must appear on a single line.

	Pay special attention to the <code>KVERSION</code<, <code>K_SRC</code>, <code>K_SRC_OBJ</code> and <code>_release</code> variables. These must match the target kernel version. In addition, the <code>_release</code> variable must not contain any hyphen (-) characters. Instead, replace hyphens with underscore (_). The <code>_release</code> variable is optional, but recommended as it will help to associate the package build with the kernel version.		Pay special attention to the <code>KVERSION</code>, <code>K_SRC</code>, <code>K_SRC_OBJ</code> and <code>_release</code> variables. These must match the target kernel version. In addition, the <code>_release</code> variable must not contain any hyphen (-) characters. Instead, replace hyphens with underscore (_). The <code>_release</code> variable is optional, but recommended as it will help to associate the package build with the kernel version.

	The following is a complete example, using kernel version <code>3.10.0-514.16.1.el7_lustre.x86_64</code> (a Lustre-patched kernel for RHEL / CentOS 7.3 built using the process described earlier in this document). At the beginning of the example are variables pointing to the kernel driver packages for each of the major distributions:		The following is a complete example, using kernel version <code>3.10.0-514.16.1.el7_lustre.x86_64</code> (a Lustre-patched kernel for RHEL / CentOS 7.3 built using the process described earlier in this document). At the beginning of the example are variables pointing to the kernel driver packages for each of the major distributions:

Adilger: /* Introduction */ remove discussion of project quotas as a requirement for patched kernels

2024-05-07T15:00:37Z

Introduction: remove discussion of project quotas as a requirement for patched kernels

← Older revision		Revision as of 07:00, 7 May 2024
Line 363:		Line 363:

	=== Introduction ===		=== Introduction ===
	If the Lustre servers will be using the LDISKFS object storage device (OSD) target, which is itself derived from EXT4, there are two options available to users when compiling Lustre and the LDISKFS kernel module. ~~Simply put, one can either patch the Linux kernel or, with Lustre 2.10 and newer, there~~ is ~~the option of using~~ the Linux kernel unmodified (also referred to as a "patchless" kernel)~~. Patchless~~ kernel ~~support~~ for ~~the LDISKFS OSD~~ is ~~a new development in 2017 and is still considered to be experimental~~. ~~Nevertheless, it~~ is ~~worth considering as an option~~, ~~as it simplifies maintenance and support considerably~~. Choosing to run a patchless server means being able to take advantage of the KABI compatibility feature in RHEL and CentOS, and the weak-updates kernel module support.		If the Lustre servers will be using the LDISKFS object storage device (OSD) target, which is itself derived from EXT4, there are two options available to users when compiling Lustre and the LDISKFS kernel module. The simplest option is to use the Linux kernel unmodified (also referred to as a "patchless" kernel), or optionally patch the Linux kernel to apply some changes for T10-PI integration if this feature is required. If you don't know what T10-PI is, then you don't need to patch the kernel. Choosing to run a patchless server means being able to take advantage of the KABI compatibility feature in RHEL and CentOS, and the weak-updates kernel module support.

	Historically, the Linux kernel used by Lustre servers has always required the application of additional patches that are not carried by the upstream kernel or the OS distribution vendor. The Lustre developer community has always worked to reduce the dependency on these patches and today the delta is small enough, at least for RHEL and CentOS servers, that users can evaluate running LDISKFS Lustre servers without any baseline kernel patches.

	~~There are some caveats:~~

	* Project quota support, new in Lustre 2.10, requires a set of patches that have not yet been accepted by into mainstream Linux distributions. If project quota is a requirement, then the kernel must be patched.
	* Running without patches may have a negative impact on performance, although this is thought to be a small risk.
	* Test coverage for Lustre servers running without kernel patches for LDISKFS servers is lower.

	The choice is not, therefore, entirely clear-cut: patched kernels deviate from the package provided by the operating system, and have maintenance overheads that must be taken into account, but they have the broadest test coverage and a long legacy. In addition, some functionality is currently only available to patched kernels. The patchless kernel option is new, and therefore carries some risk as an unknown quanitity, relatively speaking, but offers a simpler path for maintenance.

	'''Note:''' Running "patchless" does not mean that Lustre OSDs are EXT4 devices. The OSDs will still be LDISKFS, which is a modified derivative of EXT4. Irrespective of whether or not the Kernel packages are patched, Lustre still needs access to the kernel source code in order to create the LDISKFS kernel module.		'''Note:''' Running "patchless" does not mean that Lustre OSDs are EXT4 devices. The OSDs will still be LDISKFS, which is a modified derivative of EXT4. Irrespective of whether or not the Kernel packages are patched, Lustre still needs access to the kernel source code in order to create the LDISKFS kernel module.

Adilger: /* Obtain the ZFS Source Code */

2024-05-07T14:53:47Z

Obtain the ZFS Source Code

← Older revision		Revision as of 06:53, 7 May 2024
Line 633:		Line 633:
	# Mock users run "mock --shell" first		# Mock users run "mock --shell" first
	cd $HOME		cd $HOME
	~~git clone https://github.com/zfsonlinux/spl.git~~
	git clone https://github.com/zfsonlinux/zfs.git		git clone https://github.com/zfsonlinux/zfs.git
	</pre>		</pre>