.\" Man page generated from reStructuredText.
.
.TH "CEPH-DISK" "8" "Aug 29, 2019" "dev" "Ceph"
.SH NAME
ceph-disk \- Ceph disk utility for OSD
.
.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\-disk\fP [\-h] [\-v] [\-\-log\-stdout] [\-\-prepend\-to\-path PATH]
.in +2
[\-\-statedir PATH] [\-\-sysconfdir PATH]
[\-\-setuser USER] [\-\-setgroup GROUP]
\&...
.in -2
.fi
.sp
.SS optional arguments
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.B \-v\fP,\fB  \-\-verbose
be more verbose
.TP
.B \-\-log\-stdout
log to stdout
.TP
.BI \-\-prepend\-to\-path \ PATH
prepend PATH to $PATH for backward compatibility (default /usr/bin)
.TP
.BI \-\-statedir \ PATH
directory in which ceph state is preserved (default /var/lib/ceph)
.TP
.BI \-\-sysconfdir \ PATH
directory in which ceph configuration files are found (default /etc/ceph)
.TP
.BI \-\-setuser \ USER
use the given user for subprocesses, rather than ceph or root
.TP
.BI \-\-setgroup \ GROUP
use the given group for subprocesses, rather than ceph or root
.UNINDENT
.SS subcommands
.INDENT 0.0
.TP
.B prepare
Prepare a directory or disk for a Ceph OSD
.TP
.B activate
Activate a Ceph OSD
.TP
.B activate\-lockbox
Activate a Ceph lockbox
.TP
.B activate\-block
Activate an OSD via its block device
.TP
.B activate\-journal
Activate an OSD via its journal device
.TP
.B activate\-all
Activate all tagged OSD partitions
.TP
.B list
List disks, partitions, and Ceph OSDs
.TP
.B suppress\-activate
Suppress activate on a device (prefix)
.TP
.B unsuppress\-activate
Stop suppressing activate on a device (prefix)
.TP
.B deactivate
Deactivate a Ceph OSD
.TP
.B destroy
Destroy a Ceph OSD
.TP
.B zap
Zap/erase/destroy a device\(aqs partition table (and contents)
.TP
.B trigger
Trigger an event (caled by udev)
.TP
.B fix
Fix SELinux labels and/or file permissions
.UNINDENT
.SH DESCRIPTION
.sp
\fBceph\-disk\fP is a utility that can prepare and activate a disk, partition or
directory as a Ceph OSD. It is run directly or triggered by \fBceph\-deploy\fP
or \fBudev\fP\&. It can also be triggered by other deployment utilities like \fBChef\fP,
\fBJuju\fP, \fBPuppet\fP etc.
.sp
It actually automates the multiple steps involved in manual creation and start
of an OSD into two steps of preparing and activating the OSD by using the
subcommands \fBprepare\fP and \fBactivate\fP\&.
.sp
\fBceph\-disk\fP also automates the multiple steps involved to manually stop
and destroy an OSD into two steps of deactivating and destroying the OSD by using
the subcommands \fBdeactivate\fP and \fBdestroy\fP\&.
.sp
The documentation for each subcommand (prepare, activate, etc.) can be displayed
with its \fB\-\-help\fP option. For instance \fBceph\-disk prepare \-\-help\fP\&.
.SH BUGS
.sp
See also the \fBBugs\fP section in ceph\-detect\-init(8).
.SH AVAILABILITY
.sp
\fBceph\-disk\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
ceph\-detect\-init(8)
ceph\-osd(8),
ceph\-deploy(8)
.SH COPYRIGHT
2010-2019, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
.\" Generated by docutils manpage writer.
.