RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-03-06 00:10:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/man/ceph-volume add simple documentation

Browse Source 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
This commit is contained in:
Alfredo Deza 2018-02-02 08:26:58 -05:00
parent 09f35cb249
commit 9524021aa1
1 changed files with 81 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
doc/man/8/ceph-volume.rst
View File

@ -15,6 +15,9 @@ Synopsis
| **ceph-volume** **lvm** [ *trigger* | *create* | *activate* | *prepare*
| *zap* | *list*]
| **ceph-volume** **simple** [ *trigger* | *scan* | *activate* ]
Description
===========
@ -157,6 +160,84 @@ Positional arguments:
* <DEVICE> Either in the form of ``vg/lv`` for logical volumes or
``/path/to/sda1`` for regular devices.
simple
------
Scan legacy OSD directories or data devices that may have been created by
ceph-disk, or manually.
Subcommands:
**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
enabled and needs to be mounted, while reading information that was previously
created and persisted at ``/etc/ceph/osd/`` in JSON format.
Usage::
ceph-volume simple activate --bluestore <osd id> <osd fsid>
Optional Arguments:
* [-h, --help] show the help message and exit
* [--bluestore] bluestore objectstore (default)
* [--filestore] filestore objectstore
Note: It requires a matching JSON file with the following format::
/etc/ceph/osd/<osd id>-<osd fsid>.json
**scan**
Scan a running OSD or data device for an OSD for metadata that can later be
used to activate and manage the OSD with ceph-volume. The scan method will
create a JSON file with the required information plus anything found in the OSD
directory as well.
Optionally, the JSON blob can be sent to stdout for further inspection.
Usage on data devices::
ceph-volume simple scan <data device>
Running OSD directories::
ceph-volume simple scan <path to osd dir>
Optional arguments:
* [-h, --help] show the help message and exit
* [--stdout] Send the JSON blob to stdout
* [--force] If the JSON file exists at destination, overwrite it
Required Positional arguments:
* <DATA DEVICE or OSD DIR> Actual data partition or a path to the running OSD
**trigger**
This subcommand is not meant to be used directly, and it is used by systemd so
that it proxies input to ``ceph-volume simple activate`` by parsing the
input from systemd, detecting the UUID and ID associated with an OSD.
Usage::
ceph-volume simple trigger <SYSTEMD-DATA>
The systemd "data" is expected to be in the format of::
<OSD ID>-<OSD UUID>
The JSON file associated with the OSD need to have been persisted previously by
a scan (or manually), so that all needed metadata can be used.
Positional arguments:
* <SYSTEMD_DATA> Data from a systemd unit containing ID and UUID of the OSD.
Availability
============