diff --git a/doc/man/8/CMakeLists.txt b/doc/man/8/CMakeLists.txt index fd6bbae58ea..c94fb3fc35f 100644 --- a/doc/man/8/CMakeLists.txt +++ b/doc/man/8/CMakeLists.txt @@ -3,6 +3,7 @@ set(client_srcs ceph-conf.rst ceph.rst ceph-authtool.rst + ceph-kvstore-tool.rst rados.rst ceph-post-file.rst ceph-dencoder.rst) diff --git a/doc/man/8/ceph-kvstore-tool.rst b/doc/man/8/ceph-kvstore-tool.rst new file mode 100644 index 00000000000..4baa4928857 --- /dev/null +++ b/doc/man/8/ceph-kvstore-tool.rst @@ -0,0 +1,85 @@ +:orphan: + +===================================================== + ceph-kvstore-tool -- ceph kvstore manipulation tool +===================================================== + +.. program:: ceph-kvstore-tool + +Synopsis +======== + +| **ceph-kvstore-tool** *command* [args...] + + +Description +=========== + +:program:`ceph-kvstore-tool` is a kvstore manipulation tool. It allows users to manipule +leveldb/rocksdb's data (like OSD's omap) offline. + +Commands +======== + +:program:`ceph-kvstore-tool` utility uses many commands for debugging purpose +which are as follows: + +:command:`list [prefix]` + Print key of all KV pairs stored with the URL encoded prefix. + +:command:`list-crc [prefix]` + Print CRC of all KV pairs stored with the URL encoded prefix. + +:command:`exists [key]` + Check if there is any KV pair stored with the URL encoded prefix. If key + is also specified, check for the key with the prefix instead. + +:command:`get [out ]` + Get the value of the KV pair stored with the URL encoded prefix and key. + If file is also specified, write the value to the file. + +:command:`crc ` + Get the CRC of the KV pair stored with the URL encoded prefix and key. + +:command:`get-size [ ]` + Get estimated store size or size of value specified by prefix and key. + +:command:`set [ver |in ]` + Set the value of the KV pair stored with the URL encoded prefix and key. + The value could be *version_t* or text. + +:command:`rm ` + Remove the KV pair stored with the URL encoded prefix and key. + +:command:`rm-prefix ` + Remove all KV pairs stored with the URL encoded prefix. + +:command:`store-copy [num-keys-per-tx]` + Copy all KV pairs to another directory specified by ``path``. + [num-keys-per-tx] is the number of KV pairs copied for a transaction. + +:command:`store-crc ` + Store CRC of all KV pairs to a file specified by ``path``. + +:command:`compact` + Subcommand ``compact`` is used to compact all data of kvstore. It will open + the database, and trigger a database's compaction. After compaction, some + disk space may be released. + +:command:`compact-prefix ` + Compact all entries specified by the URL encoded prefix. + +:command:`compact-range ` + Compact some entries specified by the URL encoded prefix and range. + +Availability +============ + +**ceph-kvstore-tool** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to +the Ceph documentation at http://ceph.com/docs for more information. + + +See also +======== + +:doc:`ceph `\(8) diff --git a/doc/rados/man/index.rst b/doc/rados/man/index.rst index 0d0380945e3..abeb88b1d38 100644 --- a/doc/rados/man/index.rst +++ b/doc/rados/man/index.rst @@ -18,6 +18,7 @@ ../../man/8/ceph-dencoder.rst ../../man/8/ceph-mon.rst ../../man/8/ceph-osd.rst + ../../man/8/ceph-kvstore-tool.rst ../../man/8/ceph-run.rst ../../man/8/ceph-syn.rst ../../man/8/crushtool.rst