From 84bf2dc6031adbf8cb34677488586fa83a684d34 Mon Sep 17 00:00:00 2001 From: Rishabh Dave Date: Thu, 23 Mar 2023 23:28:35 +0530 Subject: [PATCH] doc/man/ceph: add missing "ceph fs" commands Signed-off-by: Rishabh Dave --- doc/man/8/ceph.rst | 86 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 80 insertions(+), 6 deletions(-) diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst index 881c0d3077b..f231f56291d 100644 --- a/doc/man/8/ceph.rst +++ b/doc/man/8/ceph.rst @@ -23,7 +23,7 @@ Synopsis | **ceph** **df** *{detail}* -| **ceph** **fs** [ *ls* \| *new* \| *reset* \| *rm* \| *authorize* ] ... +| **ceph** **fs** [ *add_data_pool* \| *authorize* \| *dump* \| *feature ls* \| *flag set* \| *get* \| *ls* \| *lsflags* \| *new* \| *rename* \| *reset* \| *required_client_features add* \| *required_client_features rm* \| *rm* \| *rm_data_pool* \| *set*] ... | **ceph** **fsid** @@ -361,19 +361,87 @@ fs Manage cephfs file systems. It uses some additional subcommands. +Subcommand ``add_data_pool`` adds an new data pool to the FS. Ths pool can +be used for file layouts as an alternate location to store the file data. + +Usage:: + + ceph fs add_data_pool + +Subcommand ``authorize`` creates a new client that will be authorized for the +given path in ````. Pass ``/`` to authorize for the entire FS. +```` below can be ``r``, ``rw`` or ``rwp``. + +Usage:: + + ceph fs authorize client. [ ...] + +Subcommand ``dump`` displays the FSMap at the given epoch (default: current). +This includes all file system settings, MDS daemons and the ranks they hold +and list of standby MDS daemons. + +Usage:: + + ceph fs dump [epoch] + +Subcommand ``feature ls`` lists all CephFS features supported by current +version of Ceph. + +Usage:: + + ceph fs feature ls + +Subcommand ``flag set`` sets a global CephFS flag. Right now the only flag +is ``enable_multiple`` which allows multiple CephFSs on a Ceph cluster. + +Usage:: + + ceph fs flag set --yes-i-really-mean-it + +Subcommand ``get`` displays the information about FS, including settings and +ranks. Information printed here in subset of same information from the +``fs dump`` command. + +Usage:: + + ceph fs get + Subcommand ``ls`` to list file systems Usage:: ceph fs ls +Subcommand ``lsflags`` displays all the flags set on the given FS. + +Usage:: + + ceph fs lsflags + Subcommand ``new`` to make a new file system using named pools and Usage:: ceph fs new -Subcommand ``reset`` is used for disaster recovery only: reset to a single-MDS map +Subcommand ``rename`` assigns a new name to CephFS and also updates +application tags on the pools of this CephFS. + +Usage:: + + ceph fs rename {--yes-i-really-mean-it} + +Subcommand ``required_client_features`` disables a client that doesn't +possess a certain feature from connecting. This subcommand has two +subcommands, one to add a requirement and other to remove the requirement. + +Usage:: + + ceph fs required_client_features add + ceph fs required_client_features rm + +Subcommand ``reset`` is used for disaster recovery only: reset to a single-MDS +map Usage:: @@ -385,13 +453,19 @@ Usage:: ceph fs rm {--yes-i-really-mean-it} -Subcommand ``authorize`` creates a new client that will be authorized for the -given path in ````. Pass ``/`` to authorize for the entire FS. -```` below can be ``r``, ``rw`` or ``rwp``. +Subcommand ``rm_data_pool`` removes the specified pool from FS's list of +data pools. File data on this pool will become unavailable. Default data pool +cannot be removed. Usage:: - ceph fs authorize client. [ ...] + ceph fs rm_data_pool + +Subcommand ``set`` sets or updates a FS setting value for given FS name. + +Usage:: + + ceph fs set fsid ---- -- 2.39.5