mirror of
https://github.com/ceph/ceph
synced 2024-12-28 06:23:08 +00:00
420a2f15a5
As explained in admin/manpage-howto.txt Signed-off-by: Loic Dachary <loic@dachary.org>
170 lines
4.4 KiB
Groff
170 lines
4.4 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "CEPH-OSD" "8" "December 09, 2013" "dev" "Ceph"
|
|
.SH NAME
|
|
ceph-osd \- ceph object storage daemon
|
|
.
|
|
.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
|
|
\fBceph\-osd\fP \-i \fIosdnum\fP [ \-\-osd\-data \fIdatapath\fP ] [ \-\-osd\-journal
|
|
\fIjournal\fP ] [ \-\-mkfs ] [ \-\-mkjournal ] [ \-\-mkkey ]
|
|
.fi
|
|
.sp
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBceph\-osd\fP is the object storage daemon for the Ceph distributed file
|
|
system. It is responsible for storing objects on a local file system
|
|
and providing access to them over the network.
|
|
.sp
|
|
The datapath argument should be a directory on a btrfs file system
|
|
where the object data resides. The journal is optional, and is only
|
|
useful performance\-wise when it resides on a different disk than
|
|
datapath with low latency (ideally, an NVRAM device).
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-f, \-\-foreground
|
|
Foreground: do not daemonize after startup (run in foreground). Do
|
|
not generate a pid file. Useful when run via \fBceph\-run\fP(8).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-d
|
|
Debug mode: like \fB\-f\fP, but also send all log output to stderr.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-osd\-data osddata
|
|
Use object store at \fIosddata\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-osd\-journal journal
|
|
Journal updates to \fIjournal\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-mkfs
|
|
Create an empty object repository. This also initializes the journal
|
|
(if one is defined).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-mkkey
|
|
Generate a new secret key. This is normally used in combination
|
|
with \fB\-\-mkfs\fP as it is more convenient than generating a key by
|
|
hand with \fBceph\-authtool\fP(8).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-mkjournal
|
|
Create a new journal file to match an existing object repository.
|
|
This is useful if the journal device or file is wiped out due to a
|
|
disk or file system failure.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-flush\-journal
|
|
Flush the journal to permanent store. This runs in the foreground
|
|
so you know when it\(aqs completed. This can be useful if you want to
|
|
resize the journal or need to otherwise destroy it: this guarantees
|
|
you won\(aqt lose data.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-get\-cluster\-fsid
|
|
Print the cluster fsid (uuid) and exit.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-get\-osd\-fsid
|
|
Print the OSD\(aqs fsid and exit. The OSD\(aqs uuid is generated at
|
|
\-\-mkfs time and is thus unique to a particular instantiation of
|
|
this OSD.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-get\-journal\-fsid
|
|
Print the journal\(aqs uuid. The journal fsid is set to match the OSD
|
|
fsid at \-\-mkfs time.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-c ceph.conf, \-\-conf=ceph.conf
|
|
Use \fIceph.conf\fP configuration file instead of the default
|
|
\fB/etc/ceph/ceph.conf\fP for runtime configuration options.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-m monaddress[:port]
|
|
Connect to specified monitor (instead of looking through
|
|
\fBceph.conf\fP).
|
|
.UNINDENT
|
|
.SH AVAILABILITY
|
|
.sp
|
|
\fBceph\-osd\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),
|
|
\fBceph\-mds\fP(8),
|
|
\fBceph\-mon\fP(8),
|
|
\fBceph\-authtool\fP(8)
|
|
.SH COPYRIGHT
|
|
2010-2013, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
|
|
.\" Generated by docutils manpage writer.
|
|
.
|