]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/man/ceph: add missing "ceph fs" commands
authorRishabh Dave <ridave@redhat.com>
Thu, 23 Mar 2023 17:58:35 +0000 (23:28 +0530)
committerRishabh Dave <ridave@redhat.com>
Mon, 3 Apr 2023 17:49:58 +0000 (23:19 +0530)
Signed-off-by: Rishabh Dave <ridave@redhat.com>
doc/man/8/ceph.rst

index 881c0d3077b4161522e36197884aa92d60fb6e20..f231f56291d45d626ae4c23475edce51928bc4b2 100644 (file)
@@ -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 <fs-name> <pool name/id>
+
+Subcommand ``authorize`` creates a new client that will be authorized for the
+given path in ``<fs_name>``. Pass ``/`` to authorize for the entire FS.
+``<perms>`` below can be ``r``, ``rw`` or ``rwp``.
+
+Usage::
+
+    ceph fs authorize <fs_name> client.<client_id> <path> <perms> [<path> <perms>...]
+
+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 <flag-name> <flag-val> --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 <fs-name>
+
 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 <fs-name>
+
 Subcommand ``new`` to make a new file system using named pools <metadata> and <data>
 
 Usage::
 
        ceph fs new <fs_name> <metadata> <data>
 
-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 <fs-name> <new-fs-name> {--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 <fs name> add <feature-name>
+    ceph fs required_client_features <fs name> rm <feature-name>
+
+Subcommand ``reset`` is used for disaster recovery only: reset to a single-MDS
+map
 
 Usage::
 
@@ -385,13 +453,19 @@ Usage::
 
        ceph fs rm <fs_name> {--yes-i-really-mean-it}
 
-Subcommand ``authorize`` creates a new client that will be authorized for the
-given path in ``<fs_name>``. Pass ``/`` to authorize for the entire FS.
-``<perms>`` 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 <fs_name> client.<client_id> <path> <perms> [<path> <perms>...]
+    ceph fs rm_data_pool <fs-name> <pool name/id>
+
+Subcommand ``set`` sets or updates a FS setting value for given FS name.
+
+Usage::
+
+    ceph fs set <fs-name> <fs-setting> <value>
 
 fsid
 ----