update sources to v12.1.0

[ceph.git] / ceph / doc / man / 8 / ceph.rst

diff --git a/ceph/doc/man/8/ceph.rst b/ceph/doc/man/8/ceph.rst
index ba3ccdfe2765d5bc82c3effc728c59bd0cdda870..fa3d126fb11bd96d35840e386f6f5fe28bd3e576 100644 (file)
--- a/ceph/doc/man/8/ceph.rst
+++ b/ceph/doc/man/8/ceph.rst
@@ -39,7 +39,7 @@ Synopsis
 
 | **ceph** **mon_status**
 
-| **ceph** **osd** [ *blacklist* \| *blocked-by* \| *create* \| *deep-scrub* \| *df* \| *down* \| *dump* \| *erasure-code-profile* \| *find* \| *getcrushmap* \| *getmap* \| *getmaxosd* \| *in* \| *lspools* \| *map* \| *metadata* \| *out* \| *pause* \| *perf* \| *pg-temp* \| *primary-affinity* \| *primary-temp* \| *repair* \| *reweight* \| *reweight-by-pg* \| *rm* \| *scrub* \| *set* \| *setcrushmap* \| *setmaxosd*  \| *stat* \| *tree* \| *unpause* \| *unset* ] ...
+| **ceph** **osd** [ *blacklist* \| *blocked-by* \| *create* \| *new* \| *deep-scrub* \| *df* \| *down* \| *dump* \| *erasure-code-profile* \| *find* \| *getcrushmap* \| *getmap* \| *getmaxosd* \| *in* \| *lspools* \| *map* \| *metadata* \| *out* \| *pause* \| *perf* \| *pg-temp* \| *primary-affinity* \| *primary-temp* \| *repair* \| *reweight* \| *reweight-by-pg* \| *rm* \| *destroy* \| *purge* \| *scrub* \| *set* \| *setcrushmap* \| *setmaxosd*  \| *stat* \| *tree* \| *unpause* \| *unset* ] ...
 
 | **ceph** **osd** **crush** [ *add* \| *add-bucket* \| *create-or-move* \| *dump* \| *get-tunable* \| *link* \| *move* \| *remove* \| *rename-bucket* \| *reweight* \| *reweight-all* \| *reweight-subtree* \| *rm* \| *rule* \| *set* \| *set-tunable* \| *show-tunables* \| *tunables* \| *unlink* ] ...
 
@@ -478,10 +478,40 @@ Usage::
 
 Subcommand ``create`` creates new osd (with optional UUID and ID).
 
+This command is DEPRECATED as of the Luminous release, and will be removed in
+a future release.
+
+Subcommand ``new`` should instead be used.
+
 Usage::
 
        ceph osd create {<uuid>} {<id>}
 
+Subcommand ``new`` reuses a previously destroyed OSD *id*. The new OSD will
+have the specified *uuid*, and the command expects a JSON file containing
+the base64 cephx key for auth entity *client.osd.<id>*, as well as optional
+base64 cepx key for dm-crypt lockbox access and a dm-crypt key. Specifying
+a dm-crypt requires specifying the accompanying lockbox cephx key.
+
+Usage::
+
+    ceph osd new {<id>} {<uuid>} -i {<secrets.json>}
+
+The secrets JSON file is expected to maintain a form of the following format::
+
+    {
+        "cephx_secret": "AQBWtwhZdBO5ExAAIDyjK2Bh16ZXylmzgYYEjg=="
+    }
+
+Or::
+
+    {
+        "cephx_secret": "AQBWtwhZdBO5ExAAIDyjK2Bh16ZXylmzgYYEjg==",
+        "cephx_lockbox_secret": "AQDNCglZuaeVCRAAYr76PzR1Anh7A0jswkODIQ==",
+        "dmcrypt_key": "<dm-crypt key>"
+    }
+        
+
 Subcommand ``crush`` is used for CRUSH management. It uses some additional
 subcommands.
 
@@ -938,6 +968,29 @@ Usage::
 
        ceph osd rm <ids> [<ids>...]
 
+Subcommand ``destroy`` marks OSD *id* as *destroyed*, removing its cephx
+entity's keys and all of its dm-crypt and daemon-private config key
+entries.
+
+This command will not remove the OSD from crush, nor will it remove the
+OSD from the OSD map. Instead, once the command successfully completes,
+the OSD will show marked as *destroyed*.
+
+In order to mark an OSD as destroyed, the OSD must first be marked as
+**lost**.
+
+Usage::
+
+    ceph osd destroy <id> {--yes-i-really-mean-it}
+
+
+Subcommand ``purge`` performs a combination of ``osd destroy``,
+``osd rm`` and ``osd crush remove``.
+
+Usage::
+
+    ceph osd purge <id> {--yes-i-really-mean-it}
+
 Subcommand ``scrub`` initiates scrub on specified osd.
 
 Usage::
@@ -1265,6 +1318,13 @@ Usage::
 
        ceph tell <name (type.id)> <args> [<args>...]
 
+
+List all available commands.
+
+Usage::
+
+       ceph tell <name (type.id)> help
+
 version
 -------