rbd-replay: Add man page, and add binaries to Debian packaging

Signed-off-by: Adam Crume <adamcrume@gmail.com>

diff --git a/ceph.spec.in b/ceph.spec.in
index c76492655d3f7d4db0d215bbdeec69de23036e57..f8d2d92041d3aa6252f2f95d45f5119d6617c22a 100644 (file)
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -720,6 +720,8 @@ ln -sf %{_libdir}/librbd.so.1 /usr/lib64/qemu/librbd.so.1
 %{_bindir}/ceph-monstore-tool
 %{_bindir}/ceph-osdomap-tool
 %{_bindir}/ceph-kvstore-tool
+%{_mandir}/man8/rbd-replay.8*
+%{_bindir}/rbd-replay
 
 %files -n libcephfs_jni1
 %defattr(-,root,root,-)

diff --git a/debian/ceph-test.install b/debian/ceph-test.install
index ac790553648a00d66026efa4bf59fe51c214e810..18e181711b0fe573d0ece2df3578640ba63096c5 100644 (file)
--- a/debian/ceph-test.install
+++ b/debian/ceph-test.install
@@ -26,3 +26,5 @@ usr/bin/ceph-monstore-tool
 usr/bin/ceph-osdomap-tool
 usr/bin/ceph-kvstore-tool
 usr/share/java/libcephfs-test.jar
+usr/bin/rbd-replay
+usr/share/man/man8/rbd-replay.8

diff --git a/doc/man/8/rbd-replay.rst b/doc/man/8/rbd-replay.rst
new file mode 100644 (file)
index 0000000..63d74c7
--- /dev/null
+++ b/doc/man/8/rbd-replay.rst
@@ -0,0 +1,68 @@
+=========================================================
+ rbd-replay -- replay rados block device (RBD) workloads
+=========================================================
+
+.. program:: rbd-replay
+
+Synopsis
+========
+
+| **rbd-replay** [ *options* ] *replay_file*
+
+
+Description
+===========
+
+**rbd-replay** is a utility for replaying rados block device (RBD) workloads.
+
+
+Options
+=======
+
+.. option:: -c ceph.conf, --conf ceph.conf
+
+   Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to
+   determine monitor addresses during startup.
+
+.. option:: -p pool, --pool pool
+
+   Interact with the given pool.  Defaults to 'rbd'.
+
+.. option:: --latency-multiplier
+
+   Multiplies inter-request latencies.  Default: 1.
+
+.. option:: --read-only
+
+   Only replay non-destructive requests.
+
+.. option:: --map-image rule
+
+   Add a rule to map image names in the trace to image names in the replay cluster.
+   A rule of image1@snap1=image2@snap2 would map snap1 of image1 to snap2 of image2.
+
+
+Examples
+========
+
+To replay workload1 as fast as possible::
+
+       rbd-replay --latency-multiplier=0 workload1
+
+To replay workload1 but use test_image instead of prod_image::
+
+       rbd-replay --map-image=prod_image=test_image workload1
+
+
+Availability
+============
+
+**rbd-replay** is part of the Ceph distributed storage system. Please refer to
+the Ceph documentation at http://ceph.com/docs for more information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8),
+:doc:`rbd <rbd>`\(8)

diff --git a/man/Makefile.am b/man/Makefile.am
index e29154ae7c2846ab9e57fd48b91bc90c47059f26..dda04b758654dc812c224e3b6eb4ab46d2dcf8ad 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -26,4 +26,5 @@ dist_man_MANS = \
        ceph-rest-api.8 \
        ceph-rbdnamer.8 \
        ceph-post-file.8 \
-       rbd-fuse.8
+       rbd-fuse.8 \
+       rbd-replay.8

diff --git a/man/rbd-replay.8 b/man/rbd-replay.8
new file mode 100644 (file)
index 0000000..87cde13
--- /dev/null
+++ b/man/rbd-replay.8
@@ -0,0 +1,132 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "RBD-REPLAY" "8" "August 07, 2014" "dev" "Ceph"
+.SH NAME
+rbd-replay \- replay rados block device (RBD) workloads
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.nf
+\fBrbd\-replay\fP [ \fIoptions\fP ] \fIreplay_file\fP
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+\fBrbd\-replay\fP is a utility for replaying rados block device (RBD) workloads.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-c ceph.conf, \-\-conf ceph.conf
+Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to
+determine monitor addresses during startup.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-p pool, \-\-pool pool
+Interact with the given pool.  Defaults to \(aqrbd\(aq.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-latency\-multiplier
+Multiplies inter\-request latencies.  Default: 1.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-read\-only
+Only replay non\-destructive requests.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-map\-image rule
+Add a rule to map image names in the trace to image names in the replay cluster.
+A rule of image1@snap1=image2@snap2 would map snap1 of image1 to snap2 of image2.
+.UNINDENT
+.SH EXAMPLES
+.sp
+To replay workload1 as fast as possible:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+rbd\-replay \-\-latency\-multiplier=0 workload1
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+To replay workload1 but use test_image instead of prod_image:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+rbd\-replay \-\-map\-image=prod_image=test_image workload1
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH AVAILABILITY
+.sp
+\fBrbd\-replay\fP is part of the Ceph distributed storage system. Please refer to
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
+.SH SEE ALSO
+.sp
+\fBceph\fP(8),
+\fBrbd\fP(8)
+.SH COPYRIGHT
+2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
+.\" Generated by docutils manpage writer.
+.