3 ===================================================================
4 ceph-disk -- Ceph disk utility for OSD
5 ===================================================================
12 | **ceph-disk** [-h] [-v] [--log-stdout] [--prepend-to-path PATH]
13 | [--statedir PATH] [--sysconfdir PATH]
14 | [--setuser USER] [--setgroup GROUP]
20 -h, --help show this help message and exit
21 -v, --verbose be more verbose
22 --log-stdout log to stdout
23 --prepend-to-path PATH
24 prepend PATH to $PATH for backward compatibility (default /usr/bin)
25 --statedir PATH directory in which ceph state is preserved (default /var/lib/ceph)
26 --sysconfdir PATH directory in which ceph configuration files are found (default /etc/ceph)
27 --setuser USER use the given user for subprocesses, rather than ceph or root
28 --setgroup GROUP use the given group for subprocesses, rather than ceph or root
34 Prepare a directory or disk for a Ceph OSD
38 Activate a Ceph lockbox
40 Activate an OSD via its block device
42 Activate an OSD via its journal device
44 Activate all tagged OSD partitions
46 List disks, partitions, and Ceph OSDs
48 Suppress activate on a device (prefix)
50 Stop suppressing activate on a device (prefix)
56 Zap/erase/destroy a device's partition table (and contents)
58 Trigger an event (caled by udev)
60 Fix SELinux labels and/or file permissions
65 :program:`ceph-disk` is a utility that can prepare and activate a disk, partition or
66 directory as a Ceph OSD. It is run directly or triggered by :program:`ceph-deploy`
67 or ``udev``. It can also be triggered by other deployment utilities like ``Chef``,
68 ``Juju``, ``Puppet`` etc.
70 It actually automates the multiple steps involved in manual creation and start
71 of an OSD into two steps of preparing and activating the OSD by using the
72 subcommands ``prepare`` and ``activate``.
74 :program:`ceph-disk` also automates the multiple steps involved to manually stop
75 and destroy an OSD into two steps of deactivating and destroying the OSD by using
76 the subcommands ``deactivate`` and ``destroy``.
78 The documentation for each subcommand (prepare, activate, etc.) can be displayed
79 with its ``--help`` option. For instance ``ceph-disk prepare --help``.
84 See also the ``Bugs`` section in :doc:`ceph-detect-init <ceph-detect-init>`\(8).
89 :program:`ceph-disk` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
90 the Ceph documentation at http://ceph.com/docs for more information.
95 :doc:`ceph-detect-init <ceph-detect-init>`\(8)
96 :doc:`ceph-osd <ceph-osd>`\(8),
97 :doc:`ceph-deploy <ceph-deploy>`\(8)