2013-12-07 21:07:38 +00:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
.
|
2014-01-12 16:48:00 +00:00
|
|
|
.TH "CEPH-SYN" "8" "January 12, 2014" "dev" "Ceph"
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH NAME
|
2011-09-22 23:18:19 +00:00
|
|
|
ceph-syn \- ceph synthetic workload generator
|
2011-09-09 23:25:14 +00:00
|
|
|
.
|
|
|
|
.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
|
|
|
|
..
|
|
|
|
.
|
2013-12-07 21:07:38 +00:00
|
|
|
.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
|
|
|
|
..
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH SYNOPSIS
|
2011-09-09 23:25:14 +00:00
|
|
|
.nf
|
2013-12-07 21:07:38 +00:00
|
|
|
\fBceph\-syn\fP [ \-m \fImonaddr\fP:\fIport\fP ] \-\-syn \fIcommand\fP \fI\&...\fP
|
2011-09-09 23:25:14 +00:00
|
|
|
.fi
|
|
|
|
.sp
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH DESCRIPTION
|
2011-09-09 23:25:14 +00:00
|
|
|
.sp
|
2011-09-22 23:18:19 +00:00
|
|
|
\fBceph\-syn\fP is a simple synthetic workload generator for the Ceph
|
2011-09-09 23:25:14 +00:00
|
|
|
distributed file system. It uses the userspace client library to
|
|
|
|
generate simple workloads against a currently running file system. The
|
2011-09-22 23:18:19 +00:00
|
|
|
file system need not be mounted via ceph\-fuse(8) or the kernel client.
|
2011-09-09 23:25:14 +00:00
|
|
|
.sp
|
|
|
|
One or more \fB\-\-syn\fP command arguments specify the particular
|
|
|
|
workload, as documented below.
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH OPTIONS
|
2011-09-09 23:25:14 +00:00
|
|
|
.INDENT 0.0
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \-d
|
2009-03-10 23:49:23 +00:00
|
|
|
Detach from console and daemonize after startup.
|
2011-09-09 23:25:14 +00:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \-c ceph.conf, \-\-conf=ceph.conf
|
|
|
|
Use \fIceph.conf\fP configuration file instead of the default
|
|
|
|
\fB/etc/ceph/ceph.conf\fP to determine monitor addresses during
|
|
|
|
startup.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \-m monaddress[:port]
|
|
|
|
Connect to specified monitor (instead of looking through
|
|
|
|
\fBceph.conf\fP).
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \-\-num_client num
|
|
|
|
Run num different clients, each in a separate thread.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \-\-syn workloadspec
|
|
|
|
Run the given workload. May be specified as many times as
|
|
|
|
needed. Workloads will normally run sequentially.
|
|
|
|
.UNINDENT
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH WORKLOADS
|
2011-09-09 23:25:14 +00:00
|
|
|
.sp
|
|
|
|
Each workload should be preceded by \fB\-\-syn\fP on the command
|
|
|
|
line. This is not a complete list.
|
|
|
|
.INDENT 0.0
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBmknap\fP \fIpath\fP \fIsnapname\fP
|
2013-12-07 21:07:38 +00:00
|
|
|
Create a snapshot called \fIsnapname\fP on \fIpath\fP\&.
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBrmsnap\fP \fIpath\fP \fIsnapname\fP
|
2013-12-07 21:07:38 +00:00
|
|
|
Delete snapshot called \fIsnapname\fP on \fIpath\fP\&.
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBrmfile\fP \fIpath\fP
|
2013-12-07 21:07:38 +00:00
|
|
|
Delete/unlink \fIpath\fP\&.
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBwritefile\fP \fIsizeinmb\fP \fIblocksize\fP
|
|
|
|
Create a file, named after our client id, that is \fIsizeinmb\fP MB by
|
|
|
|
writing \fIblocksize\fP chunks.
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBreadfile\fP \fIsizeinmb\fP \fIblocksize\fP
|
|
|
|
Read file, named after our client id, that is \fIsizeinmb\fP MB by
|
|
|
|
writing \fIblocksize\fP chunks.
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBrw\fP \fIsizeinmb\fP \fIblocksize\fP
|
2009-03-10 23:49:23 +00:00
|
|
|
Write file, then read it back, as above.
|
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBmakedirs\fP \fInumsubdirs\fP \fInumfiles\fP \fIdepth\fP
|
|
|
|
Create a hierarchy of directories that is \fIdepth\fP levels deep. Give
|
|
|
|
each directory \fInumsubdirs\fP subdirectories and \fInumfiles\fP files.
|
2009-03-10 23:49:23 +00:00
|
|
|
.TP
|
2011-09-09 23:25:14 +00:00
|
|
|
.B \fBwalk\fP
|
|
|
|
Recursively walk the file system (like find).
|
|
|
|
.UNINDENT
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH AVAILABILITY
|
2011-09-09 23:25:14 +00:00
|
|
|
.sp
|
2015-01-22 14:53:46 +00:00
|
|
|
\fBceph\-syn\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
|
2012-09-27 21:23:42 +00:00
|
|
|
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
|
2009-03-10 23:49:23 +00:00
|
|
|
.SH SEE ALSO
|
2011-09-09 23:25:14 +00:00
|
|
|
.sp
|
|
|
|
\fBceph\fP(8),
|
2011-09-22 23:18:19 +00:00
|
|
|
\fBceph\-fuse\fP(8)
|
2011-09-09 23:25:14 +00:00
|
|
|
.SH COPYRIGHT
|
2014-01-12 16:48:00 +00:00
|
|
|
2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
|
2011-09-09 23:25:14 +00:00
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
.
|