From e00d9bbf53f189ca8d2faff3c673ce61cfeaaa72 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Mon, 6 Aug 2018 08:52:31 -0400 Subject: [PATCH] doc/man/ceph-volume add batch information Signed-off-by: Alfredo Deza --- doc/man/8/ceph-volume.rst | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst index d8c510fc397..767f36a5040 100644 --- a/doc/man/8/ceph-volume.rst +++ b/doc/man/8/ceph-volume.rst @@ -13,7 +13,7 @@ Synopsis | [--log-path LOG_PATH] | **ceph-volume** **lvm** [ *trigger* | *create* | *activate* | *prepare* -| *zap* | *list*] +| *zap* | *list* | *batch*] | **ceph-volume** **simple** [ *trigger* | *scan* | *activate* ] @@ -43,6 +43,36 @@ activated. Subcommands: +**batch** +Creates OSDs from a list of devices using a ``filestore`` +or ``bluestore`` (default) setup. It will create all necessary volume groups +and logical volumes required to have a working OSD. + +Example usage with three devices:: + + ceph-volume lvm batch --bluestore /dev/sda /dev/sdb /dev/sdc + +Optional arguments: + +* [-h, --help] show the help message and exit +* [--bluestore] Use the bluestore objectstore (default) +* [--filestore] Use the filestore objectstore +* [--yes] Skip the report and prompt to continue provisioning + +.. * [--dmcrypt] Enable encryption for the underlying OSD devices +.. * [--crush-device-class] Define a CRUSH device class to assign the OSD to +.. * [--no-systemd] Do not enable or create any systemd units +.. * [--report] Report what the potential outcome would be for the +.. current input (requires devices to be passed in) +.. * [--format] Output format when reporting (used along with +.. --report), can be one of 'pretty' (default) or 'json' + +Required positional arguments: + +* Full path to a raw device, like ``/dev/sda``. Multiple + ```` paths can be passed in. + + **activate** Enables a systemd unit that persists the OSD ID and its UUID (also called ``fsid`` in Ceph CLI tools), so that at boot time it can understand what OSD is