Skip to content

Commit

Permalink
Document the WAL/DB parameters for the 'disk add' action.
Browse files Browse the repository at this point in the history
Signed-off-by: Luciano Lo Giudice <[email protected]>
  • Loading branch information
lmlg committed Oct 9, 2023
1 parent 7b5672b commit 14bdfa6
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/reference/commands/disk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,40 @@ Global options:
-v, --verbose Show all information messages
--version Print version number
``add``
-------

Adds a disk to the cluster, alongside optional devices for
write-ahead logging and database management.

Syntax:

.. code-block:: none
microceph disk add <data-device> [options]
Options:

.. code-block:: none
--wipe Wipe the data device.
--encrypt Encrypt the data device.
--wal-device Path to the block device used for write-ahead logging (WAL).
--wal-wipe Wipe the WAL block device.
--wal-encrypt Encrypt the WAL block device.
--db-device Path to the block device to be used for database management.
--db-wipe Wipe the DB block device.
--db-encrypt Encrypt the DB block device.
.. note::

Only the data device is mandatory. THe WAL and DB devices can improve
performance by delegating the management of some subsystems to additional
block devices. The WAL block device stores the internal journal whereas
the DB one stores metadata. Using either of those should be advantageous
as long as they are faster than the data device. WAL should take priority
over DB if there isn't enough storage for both.

``remove``
----------

Expand Down

0 comments on commit 14bdfa6

Please sign in to comment.