.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "CEPH-OSD" "8" "Oct 09, 2023" "dev" "Ceph"
.SH NAME
ceph-osd \- ceph object storage daemon
.SH SYNOPSIS
.nf
\fBceph\-osd\fP \-i \fIosdnum\fP [ \-\-osd\-data \fIdatapath\fP ] [ \-\-osd\-journal
\fIjournal\fP ] [ \-\-mkfs ] [ \-\-mkjournal ] [\-\-flush\-journal] [\-\-check\-allows\-journal] [\-\-check\-wants\-journal] [\-\-check\-needs\-journal] [ \-\-mkkey ] [ \-\-osdspec\-affinity ]
.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 xfs 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 \fI\%ceph\-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 \-\-setuser userorgid
Set uid after starting.  If a username is specified, the user
record is looked up to get a uid and a gid, and the gid is also set
as well, unless \-\-setgroup is also specified.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-setgroup grouporgid
Set gid after starting.  If a group name is specified the group
record is looked up to get a gid.
.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 \-\-check\-wants\-journal
Check whether a journal is desired.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-check\-allows\-journal
Check whether a journal is allowed.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-check\-needs\-journal
Check whether a journal is required.
.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 \fI\%ceph\-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
.INDENT 0.0
.TP
.B \-\-osdspec\-affinity
Set an affinity to a certain OSDSpec.
This option can only be used in conjunction with \-\-mkfs.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-osd\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fI\%ceph\fP(8),
\fI\%ceph\-mds\fP(8),
\fI\%ceph\-mon\fP(8),
\fI\%ceph\-authtool\fP(8)
.SH COPYRIGHT
2010-2023, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.