X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fceph%2Fsrc%2Ftest%2Ffio%2FREADME.md;fp=src%2Fceph%2Fsrc%2Ftest%2Ffio%2FREADME.md;h=05c54442cc1a0a04c0c1d5a7677ba713c14b4373;hb=812ff6ca9fcd3e629e49d4328905f33eee8ca3f5;hp=0000000000000000000000000000000000000000;hpb=15280273faafb77777eab341909a3f495cf248d9;p=stor4nfv.git

diff --git a/src/ceph/src/test/fio/README.md b/src/ceph/src/test/fio/README.md
new file mode 100644
index 0000000..05c5444
--- /dev/null
+++ b/src/ceph/src/test/fio/README.md
@@ -0,0 +1,73 @@
+FIO
+===
+
+Ceph uses the fio workload generator and benchmarking utility.
+
+To fetch the fio sources:
+
+    git clone git://git.kernel.dk/fio.git
+
+To build fio:
+
+    ./configure
+    make
+
+RBD
+---
+
+The fio engine for rbd is located in the fio tree itself, so you'll need to
+build it from source.
+
+If you install the ceph libraries to a location that isn't in your
+LD_LIBRARY_PATH, be sure to add it:
+
+    export LD_LIBRARY_PATH=/path/to/install/lib
+
+To build fio with rbd:
+
+    ./configure --extra-cflags="-I/path/to/install/include -L/path/to/install/lib"
+    make
+
+If configure fails with "Rados Block Device engine   no", see config.log for
+details and adjust the cflags as necessary.
+
+To view the fio options specific to the rbd engine:
+
+    ./fio --enghelp=rbd
+
+See examples/rbd.fio for an example job file. To run:
+
+    ./fio examples/rbd.fio
+
+ObjectStore
+-----------
+
+This fio engine allows you to mount and use a ceph object store directly,
+without having to build a ceph cluster or start any daemons.
+
+Because the ObjectStore is not a public-facing interface, we build it inside
+of the ceph tree and load libfio_ceph_objectstore.so into fio as an external
+engine.
+
+To build fio_ceph_objectstore:
+```
+  mkdir build && cd build
+  cmake -DWITH_FIO=ON -DFIO_INCLUDE_DIR=/path/to/fio -DCMAKE_BUILD_TYPE=Release /path/to/ceph
+  make -C src/test/fio install
+```
+If you install the ceph libraries to a location that isn't in your
+LD_LIBRARY_PATH, be sure to add it:
+
+    export LD_LIBRARY_PATH=/path/to/install/lib
+
+To view the fio options specific to the objectstore engine:
+
+    ./fio --enghelp=libfio_ceph_objectstore.so
+
+The conf= option requires a ceph configuration file (ceph.conf). Example job
+and conf files for each object store are provided in the same directory as
+this README.
+
+To run:
+
+    ./fio /path/to/job.fio