From 278cbee9cab742f66ff7d0af5eb972680dfdd644 Mon Sep 17 00:00:00 2001 From: Jan Fajerski Date: Wed, 14 Nov 2018 14:09:37 +0100 Subject: [PATCH] doc: add ceph-volume inventory sections Signed-off-by: Jan Fajerski (cherry picked from commit dfc0e1d9a69f6f9ffb1d3e0b0ec33a75827c36e0) --- doc/ceph-volume/index.rst | 7 +++++++ doc/ceph-volume/inventory.rst | 17 +++++++++++++++++ doc/man/8/ceph-volume.rst | 29 ++++++++++++++++++++++++++--- 3 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 doc/ceph-volume/inventory.rst diff --git a/doc/ceph-volume/index.rst b/doc/ceph-volume/index.rst index 34094b73393a4..1e8efe5d41609 100644 --- a/doc/ceph-volume/index.rst +++ b/doc/ceph-volume/index.rst @@ -11,12 +11,18 @@ follow a predictable, and robust way of preparing, activating, and starting OSDs **Command Line Subcommands** + There is currently support for ``lvm``, and plain disks (with GPT partitions) that may have been deployed with ``ceph-disk``. * :ref:`ceph-volume-lvm` * :ref:`ceph-volume-simple` +**Node inventory** + +The :ref:`ceph-volume-inventory` subcommand provides information and metadata +about a nodes physical disk inventory. + Migrating --------- @@ -51,6 +57,7 @@ and ``ceph-disk`` is fully disabled. Encryption is fully supported. intro systemd + inventory lvm/index lvm/activate lvm/batch diff --git a/doc/ceph-volume/inventory.rst b/doc/ceph-volume/inventory.rst new file mode 100644 index 0000000000000..edb1fd20501f7 --- /dev/null +++ b/doc/ceph-volume/inventory.rst @@ -0,0 +1,17 @@ +.. _ceph-volume-inventory: + +``inventory`` +============= +The ``inventory`` subcommand queries a host's disc inventory and provides +hardware information and metadata on every physical device. + +By default the command returns a short, human-readable report of all physical disks. + +For programmatic consumption of this report pass ``--format json`` to generate a +JSON formatted report. This report includes extensive information on the +physical drives such as disk metadata (like model and size), logical volumes +and whether they are used by ceph, and if the disk is usable by ceph and +reasons why not. + +A device path can be specified to report extensive information on a device in +both plain and json format. diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst index a7c17d800b530..af5775997fcb1 100644 --- a/doc/man/8/ceph-volume.rst +++ b/doc/man/8/ceph-volume.rst @@ -1,8 +1,8 @@ :orphan: -======================================== - ceph-volume -- Ceph OSD deployment tool -======================================== +======================================================= + ceph-volume -- Ceph OSD deployment and inspection tool +======================================================= .. program:: ceph-volume @@ -12,6 +12,8 @@ Synopsis | **ceph-volume** [-h] [--cluster CLUSTER] [--log-level LOG_LEVEL] | [--log-path LOG_PATH] +| **ceph-volume** **inventory** + | **ceph-volume** **lvm** [ *trigger* | *create* | *activate* | *prepare* | *zap* | *list* | *batch*] @@ -34,6 +36,27 @@ them. Commands ======== +inventory +--------- + +This subcommand provides information about a host's physical disc inventory and +reports metadata about these discs. Among this metadata one can find disc +specific data items (like model, size, rotational or solid state) as well as +data items specific to ceph using a device, such as if it is available for +use with ceph or if logical volumes are present. + +Examples:: + + ceph-volume inventory + ceph-volume inventory /dev/sda + ceph-volume inventory --format json-pretty + +Optional arguments: + +* [-h, --help] show the help message and exit +* [--format] report format, valid values are ``plain`` (default), + ``json`` and ``json-pretty`` + lvm --- -- 2.39.5