mirror of
https://github.com/ceph/ceph
synced 2024-12-26 21:43:10 +00:00
92fa2ff8fc
Keeping the generated files in version control lets us support builds from scratch without requiring the full documentation toolchain to be installed. The files were just copied over from build-doc/output/man, after a ./admin/build-doc call. When redoing this, also take care to remove any roff output if a file was removed from doc/man, and update Makefile.am. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
186 lines
4.0 KiB
Groff
186 lines
4.0 KiB
Groff
.TH "RADOS" "8" "September 09, 2011" "dev" "Ceph"
|
|
.SH NAME
|
|
rados \- rados object storage utility
|
|
.
|
|
.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
|
|
..
|
|
.\" Man page generated from reStructeredText.
|
|
.
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fBrados\fP [ \-m \fImonaddr\fP ] [ mkpool | rmpool \fIfoo\fP ] [ \-p | \-\-pool
|
|
\fIpool\fP ] [ \-s | \-\-snap \fIsnap\fP ] [ \-i \fIinfile\fP ] [ \-o \fIoutfile\fP ]
|
|
\fIcommand\fP ...
|
|
.fi
|
|
.sp
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBrados\fP is a utility for interacting with a Ceph object storage
|
|
cluster (RADOS), part of the Ceph distributed file system.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-p pool, \-\-pool pool
|
|
Interact with the given pool. Required by most commands.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-s snap, \-\-snap snap
|
|
Read from the given pool snapshot. Valid for all pool\-specific read operations.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-i infile
|
|
will specify an input file to be passed along as a payload with the
|
|
command to the monitor cluster. This is only used for specific
|
|
monitor commands.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-o outfile
|
|
will write any payload returned by the monitor cluster with its
|
|
reply to outfile. Only specific monitor commands (e.g. osd getmap)
|
|
return a payload.
|
|
.UNINDENT
|
|
.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 \-m monaddress[:port]
|
|
Connect to specified monitor (instead of looking through ceph.conf).
|
|
.UNINDENT
|
|
.SH GLOBAL COMMANDS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \fBlspools\fP
|
|
List object pools
|
|
.TP
|
|
.B \fBdf\fP
|
|
Show utilization statistics, including disk usage (bytes) and object
|
|
counts, over the entire system and broken down by pool.
|
|
.TP
|
|
.B \fBmkpool\fP \fIfoo\fP
|
|
Create a pool with name foo.
|
|
.TP
|
|
.B \fBrmpool\fP \fIfoo\fP
|
|
Delete the pool foo (and all its data)
|
|
.UNINDENT
|
|
.SH POOL SPECIFIC COMMANDS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \fBget\fP \fIname\fP \fIoutfile\fP
|
|
Read object name from the cluster and write it to outfile.
|
|
.TP
|
|
.B \fBput\fP \fIname\fP \fIinfile\fP
|
|
Write object name to the cluster with contents from infile.
|
|
.TP
|
|
.B \fBrm\fP \fIname\fP
|
|
Remove object name.
|
|
.TP
|
|
.B \fBls\fP \fIoutfile\fP
|
|
List objects in given pool and write to outfile.
|
|
.TP
|
|
.B \fBlssnap\fP
|
|
List snapshots for given pool.
|
|
.TP
|
|
.B \fBmksnap\fP \fIfoo\fP
|
|
Create pool snapshot named \fIfoo\fP.
|
|
.TP
|
|
.B \fBrmsnap\fP \fIfoo\fP
|
|
Remove pool snapshot names \fIfoo\fP.
|
|
.TP
|
|
.B \fBbench\fP \fIseconds\fP \fImode\fP [ \-b \fIobjsize\fP ] [ \-t \fIthreads\fP ]
|
|
Benchmark for seconds. The mode can be write or read. The default
|
|
object size is 4 KB, and the default number of simulated threads
|
|
(parallel writes) is 16.
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.sp
|
|
To view cluster utilization:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
rados df
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
To get a list object in pool foo sent to stdout:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
rados \-p foo ls \-
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
To write an object:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
rados \-p foo put myobject blah.txt
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
To create a snapshot:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
rados \-p foo mksnap mysnap
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
To delete the object:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
rados \-p foo rm myobject
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
To read a previously snapshotted version of an object:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
rados \-p foo \-s mysnap get myobject blah.txt.old
|
|
.ft P
|
|
.fi
|
|
.SH AVAILABILITY
|
|
.sp
|
|
\fBrados\fP is part of the Ceph distributed file system. Please refer to
|
|
the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fBceph\fP(8)
|
|
.SH COPYRIGHT
|
|
2011, New Dream Network
|
|
.\" Generated by docutils manpage writer.
|
|
.\"
|
|
.
|