@@ -42,48 +42,76 @@ Orangefs versions prior to 2.9.3 would not be compatible with the
upstream version of the kernel client.
-BUILDING THE USERSPACE FILESYSTEM ON A SINGLE SERVER
-====================================================
+RUNNING ORANGEFS ON A SINGLE SERVER
+===================================
-You can omit --prefix if you don't care that things are sprinkled around in
-/usr/local. As of version 2.9.6, Orangefs uses Berkeley DB by default, we
-will probably be changing the default to lmdb soon.
+OrangeFS is usually run in large installations with multiple servers and
+clients, but a complete filesystem can be run on a single machine for
+development and testing.
-./configure --prefix=/opt/ofs --with-db-backend=lmdb
+On Fedora, install orangefs and orangefs-server.
-make
+dnf -y install orangefs orangefs-server
-make install
+There is an example server configuration file in
+/etc/orangefs/orangefs.conf. Change localhost to your hostname.
-Create an orangefs config file:
-/opt/ofs/bin/pvfs2-genconfig /etc/pvfs2.conf
+To generate a filesystem to run xfstests against, see below.
- for "Enter hostnames", use the hostname, don't let it default to
- localhost.
+There is an example client configuration file in /etc/pvfs2tab. It is a
+single line. Uncomment it and change the hostname if necessary. This
+controls clients which use libpvfs2. This does not control the
+pvfs2-client-core.
-create a pvfs2tab file in /etc:
-cat /etc/pvfs2tab
-tcp://myhostname:3334/orangefs /mymountpoint pvfs2 defaults,noauto 0 0
+Create the filesystem.
-create the mount point you specified in the tab file if needed:
-mkdir /mymountpoint
+pvfs2-server -f /etc/orangefs/orangefs.conf
-bootstrap the server:
-/opt/ofs/sbin/pvfs2-server /etc/pvfs2.conf -f
+Start the server.
-start the server:
-/opt/osf/sbin/pvfs2-server /etc/pvfs2.conf
+systemctl start orangefs-server
-Now the server is running. At this point you might like to
-prove things are working with:
+Test the server.
-/opt/osf/bin/pvfs2-ls /mymountpoint
+pvfs2-ping -m /pvfsmnt
-If stuff seems to be working, turn on the client core:
-/opt/osf/sbin/pvfs2-client -p /opt/osf/sbin/pvfs2-client-core
+Start the client. The module must be compiled in or loaded before this
+point.
-Mount your filesystem.
-mount -t pvfs2 tcp://myhostname:3334/orangefs /mymountpoint
+systemctl start orangefs-client
+
+Mount the filesystem.
+
+mount -t pvfs2 tcp://localhost:3334/orangefs /pvfsmnt
+
+
+RUNNING XFSTESTS
+================
+
+It is useful to use a scratch filesystem with xfstests. This can be
+done with only one server.
+
+Make a second copy of the FileSystem section in the server configuration
+file, which is /etc/orangefs/orangefs.conf. Change the Name to scratch.
+Change the ID to something other than the ID of the first FileSystem
+section (2 is usually a good choice).
+
+Then there are two FileSystem sections: orangefs and scratch.
+
+This change should be made before creating the filesystem.
+
+pvfs2-server -f /etc/orangefs/orangefs.conf
+
+To run xfstests, create /etc/xfsqa.config.
+
+TEST_DIR=/orangefs
+TEST_DEV=tcp://localhost:3334/orangefs
+SCRATCH_MNT=/scratch
+SCRATCH_DEV=tcp://localhost:3334/scratch
+
+Then xfstests can be run
+
+./check -pvfs2
OPTIONS
Unless one is working on the userspace code, there's no need to compile OrangeFS. The package works just fine. Also document the process to run xfstests against OrangeFS. Signed-off-by: Martin Brandenburg <martin@omnibond.com> --- Documentation/filesystems/orangefs.txt | 84 ++++++++++++++++++++++------------ 1 file changed, 56 insertions(+), 28 deletions(-)