From: Nilamdyuti Goswami Date: Mon, 24 Nov 2014 16:35:11 +0000 (+0530) Subject: doc: Adds man page for ceph-disk utility. X-Git-Tag: v0.80.10~48^2~5 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1a6490e38d7f5fd3ff640a810c3b911699cd4884;p=ceph.git doc: Adds man page for ceph-disk utility. Signed-off-by: Nilamdyuti Goswami (cherry picked from commit a450cab2b8148cb8a9b043d629feccf89e5aabac) --- diff --git a/doc/man/8/ceph-disk.rst b/doc/man/8/ceph-disk.rst new file mode 100644 index 000000000000..0b71c65a6273 --- /dev/null +++ b/doc/man/8/ceph-disk.rst @@ -0,0 +1,147 @@ +=================================================================== + ceph-disk -- Ceph disk preparation and activation utility for OSD +=================================================================== + +.. program:: ceph-disk + +Synopsis +======== + +| **ceph-disk** **prepare** [--cluster *clustername*] [--cluster-uuid *uuid*] + [--fs-type *xfs|ext4|btrfs*] [*data-path*] [*journal-path*] + +| **ceph-disk** **activate** [*data-path*] [--activate-key *path*] + +Description +=========== + +**ceph-disk** is a utility that can prepare and activate a disk, partition or +directory as a ceph OSD. It is run directly or triggered by **ceph-deploy**. + +It actually automates the multiple steps involved in manual creation and start +of an OSD into 2 steps of preparing and activating the OSD by using the +subcommands **prepare** and **activate**. + +Subcommands +============ + +**prepare**: Prepare a directory, disk or drive for a ceph OSD. It creates a GPT +partition, marks the partition with ceph type uuid, creates a file system, marks +the file system as ready for ceph consumption, uses entire partition and adds a +new partition to the journal disk. It is run directly or triggered by +**ceph-deploy**. + +Usage: ceph-disk prepare --cluster [cluster-name] --cluster-uuid [uuid] --fs-type +[ext4|xfs|btrfs] [data-path] [journal-path] + +ceph-deploy osd prepare [node-name]:[directory-path] + +ceph-deploy osd prepare [node-name]:[data-disk]:[journal-disk] + +**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 [data-path] + +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] + +ceph-deploy osd activate [node-name]:[directory-path] + +ceph-deploy osd activate [node-name]:[data-disk-partition]:[journal-disk-partition] + +**activate-journal**: Activate an OSD via it's journal device. udev triggers +'ceph-disk activate-journal ' based on the partition type. + +Usage: ceph-disk activate-journal [DEV] + +Here, [DEV] is the path to journal block device. + +Others options can also be used with this subcommand like --activate-key and +--mark-init. + +Usage: ceph-disk activate-journal [--activate-key PATH] [--mark-init INITSYSTEM] +[DEV] + +**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. + +Usage: ceph-disk activate-all + +**list**: List disk partitions and ceph OSDs. It is run directly or triggered +by **ceph-deploy**. + +Usage: ceph-disk list + +ceph-deploy disk list [node-name] + +**suppress-activate**: Suppress activate on a device (prefix). + +Usage: ceph-disk suppress-activate [PATH] + +Here, [PATH] is path to block device or directory. + +**unsuppress-activate**: Stop suppressing activate on a device (prefix). + +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**. + +Usage: ceph-disk zap [DEV] + +Here, [DEV] is path to block device. + +ceph-deploy disk zap [NODE-NAME]:[DISK-NAME] + +Options +======= + +.. option:: --prepend-to-path PATH + + Prepend PATH to $PATH for backward compatibility (default /usr/bin) + +.. option:: --statedir PATH + + 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) + +.. option:: --cluster + + Provide name of the ceph cluster in which the OSD is being prepared. + +.. option:: --cluster-uuid + + Provide uuid of the ceph cluster in which the OSD is being prepared. + +.. option:: --fs-type + + Provide the filesytem type for the OSD. e.g. 'xfs/ext4/btrfs'. + +.. option:: --activate-key + + Use when a copy of /var/lib/ceph/bootstrap-osd/{cluster}.keyring isn't + present in the OSD node. Suffix the option by the path to the keyring. + +.. option:: --mark-init + + Provide init system to manage the OSD directory. + +Availability +============ + +**ceph-disk** is a part of the Ceph distributed storage system. Please refer to +the Ceph documentation at http://ceph.com/docs for more information.