doc: Updates the man page for ceph-disk utility with some changes.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>

diff --git a/doc/man/8/ceph-disk.rst b/doc/man/8/ceph-disk.rst
index 40623acc8d0d0f575c8fa164151c9424a2c52d58..41e360994cf9e2c10b3f998db83d5610c83d8f6a 100644 (file)
--- a/doc/man/8/ceph-disk.rst
+++ b/doc/man/8/ceph-disk.rst
@@ -12,6 +12,10 @@ Synopsis
 
 | **ceph-disk** **activate** [*data-path*] [--activate-key *path*]
 
+| **ceph-disk** **activate-all**
+
+| **ceph-disk** **list**
+
 Description
 ===========
 
@@ -35,19 +39,27 @@ new partition to the journal disk. It is run directly or triggered by
 Usage: ceph-disk prepare --cluster [cluster-name] --cluster-uuid [uuid] --fs-type
 [ext4|xfs|btrfs] [data-path] [journal-path]
 
-**activate**: Activate the ceph OSD. It mounts the volume in a temporary location,
-allocates an OSD id (if needed), remounts in the correct location /var/lib/ceph/
-osd/$cluster-$id and starts ceph-osd. It is triggered by udev when it sees the OSD
-GPT partition type or on ceph service start with 'ceph disk activate-all'. It is
-also run directly or triggered by **ceph-deploy**.
+Other options like --osd-uuid, --journal-uuid, --zap-disk, --data-dir, --data-dev,
+--journal-file, --journal-dev, --dmcrypt and --dmcrypt-key-dir can also be used
+with the subcommand.
 
-Usage: ceph-disk activate [data-path]
+**activate**: Activate the ceph OSD. It mounts the volume in a temporary
+location, allocates an OSD id (if needed), remounts in the correct location
+/var/lib/ceph/osd/$cluster-$id and starts ceph-osd. It is triggered by udev
+when it sees the OSD GPT partition type or on ceph service start with
+'ceph disk activate-all'. It is also run directly or triggered by **ceph-deploy**.
+
+Usage: ceph-disk activate [PATH]
+
+Here, [PATH] is path to block device or directory.
 
 An additional option [--activate-key PATH] has to be used with this subcommand
 when a copy of /var/lib/ceph/bootstrap-osd/{cluster}.keyring isn't present in the
 OSD node.
 
-Usage: ceph-disk activate [data-path] [--activate-key PATH]
+Usage: ceph-disk activate [PATH] [--activate-key PATH]
+
+Another option --mark-init can also be used with this subcommand.
 
 **activate-journal**: Activate an OSD via it's journal device. udev triggers
 'ceph-disk activate-journal <dev>' based on the partition type.
@@ -64,17 +76,27 @@ Usage: ceph-disk activate-journal [--activate-key PATH] [--mark-init INITSYSTEM]
 
 **activate-all**: Activate all tagged OSD partitions. activate-all relies on
 /dev/disk/by-parttype-uuid/$typeuuid.$uuid to find all partitions. Special udev
-rules is installed to create these links. It is triggered on ceph service start
-up or run directly.
+rules are installed to create these links. It is triggered on ceph service start
+or run directly.
 
 Usage: ceph-disk activate-all
 
+Others options can also be used with this subcommand like --activate-key and
+--mark-init.
+
+Usage: ceph-disk activate-all [--activate-key PATH] [--mark-init INITSYSTEM]
+
 **list**: List disk partitions and ceph OSDs. It is run directly or triggered
 by **ceph-deploy**.
 
 Usage: ceph-disk list
 
 **suppress-activate**: Suppress activate on a device (prefix).
+Mark devices that you want to suppress activate with a file like
+/var/lib/ceph/tmp/suppress-activate.sdb where the last bit is
+the sanitized device name (/dev/X without the /dev/ prefix). A
+function is_suppressed() checks for and  matches a prefix (/dev/).
+It means suppressing sdb will stop activate on sdb1, sdb2, etc.
 
 Usage: ceph-disk suppress-activate [PATH]
 
@@ -86,8 +108,13 @@ Usage: ceph-disk unsuppress-activate [PATH]
 
 Here, [PATH] is path to block device or directory.
 
-**zap**: Zap/erase/destroy a device's partition table and contents. It is
-also run directly or triggered by **ceph-deploy**.
+**zap**: Zap/erase/destroy a device's partition table and contents.
+It actually uses 'sgdisk' and it's option '--zap-all' to destroy both
+GPT and MBR data structures so that the disk becomes suitable for
+repartitioning. 'sgdisk' then uses '--mbrtogpt' to convert the MBR or
+BSD disklabel disk to a GPT disk. The **prepare** subcommand can now be
+executed which will create a new GPT partition. It is also run directly
+or triggered by **ceph-deploy**.
 
 Usage: ceph-disk zap [DEV]
 
@@ -98,15 +125,15 @@ Options
 
 .. option:: --prepend-to-path PATH
 
-   Prepend PATH to $PATH for backward compatibility (default /usr/bin)
+   Prepend PATH to $PATH for backward compatibility (default /usr/bin).
 
 .. option:: --statedir PATH
 
-   Directory in which ceph configuration is preserved (default /usr/lib/ceph)
+   Directory in which ceph configuration is preserved (default /usr/lib/ceph).
 
 .. option:: --sysconfdir PATH
 
-   Directory in which ceph configuration files are found (default /etc/ceph)
+   Directory in which ceph configuration files are found (default /etc/ceph).
 
 .. option:: --cluster
 
@@ -120,6 +147,42 @@ Options
 
    Provide the filesytem type for the OSD. e.g. 'xfs/ext4/btrfs'.
 
+.. option:: --osd-uuid
+
+       Unique OSD uuid to assign to the disk.
+
+.. option:: --journal-uuid
+
+       Unique uuid to assign to the journal.
+
+.. option:: --zap-disk
+
+       Destroy the partition table and content of a disk.
+
+.. option:: --data-dir
+
+       Verify that [data-path] is of a directory.
+
+.. option:: --data-dev
+
+       Verify that [data-path] is of a block device.
+
+.. option:: --journal-file
+
+       Verify that journal is a file.
+
+.. option:: --journal-dev
+
+       Verify that journal is a block device.
+
+.. option:: --dmcrypt
+
+       Encrypt [data-path] and/or journal devices with dm-crypt.
+
+.. option:: --dmcrypt-key-dir
+
+       Directory where dm-crypt keys are stored.
+
 .. option:: --activate-key
 
    Use when a copy of /var/lib/ceph/bootstrap-osd/{cluster}.keyring isn't