From f728b4f9b4f5809cb900b796d63d16179b873839 Mon Sep 17 00:00:00 2001 From: Rishabh Dave Date: Mon, 11 Sep 2023 15:25:46 +0530 Subject: [PATCH] doc/cephfs: write cephfs commands fully in docs We write CephFS commands incompletely in docs. For example, "ceph tell mds.a help" is simply written as "tell mds.a help". This might confuse the reader and it won't harm to write the command in full. Fixes: https://tracker.ceph.com/issues/62791 Signed-off-by: Rishabh Dave (cherry picked from commit e63b573d3edc272d83ee1b5eb3dace037f762d87) --- doc/cephfs/administration.rst | 65 ++++++++++++++++++----------------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/doc/cephfs/administration.rst b/doc/cephfs/administration.rst index e5acc9ab87051..cd912b42aeafd 100644 --- a/doc/cephfs/administration.rst +++ b/doc/cephfs/administration.rst @@ -15,7 +15,7 @@ creation of multiple file systems use ``ceph fs flag set enable_multiple true``. :: - fs new + ceph fs new This command creates a new file system. The file system name and metadata pool name are self-explanatory. The specified data pool is the default data pool and @@ -25,19 +25,19 @@ to accommodate the new file system. :: - fs ls + ceph fs ls List all file systems by name. :: - fs lsflags + ceph fs lsflags List all the flags set on a file system. :: - fs dump [epoch] + ceph fs dump [epoch] This dumps the FSMap at the given epoch (default: current) which includes all file system settings, MDS daemons and the ranks they hold, and the list of @@ -46,7 +46,7 @@ standby MDS daemons. :: - fs rm [--yes-i-really-mean-it] + ceph fs rm [--yes-i-really-mean-it] Destroy a CephFS file system. This wipes information about the state of the file system from the FSMap. The metadata pool and data pools are untouched and @@ -54,28 +54,28 @@ must be destroyed separately. :: - fs get + ceph fs get Get information about the named file system, including settings and ranks. This -is a subset of the same information from the ``fs dump`` command. +is a subset of the same information from the ``ceph fs dump`` command. :: - fs set + ceph fs set Change a setting on a file system. These settings are specific to the named file system and do not affect other file systems. :: - fs add_data_pool + ceph fs add_data_pool Add a data pool to the file system. This pool can be used for file layouts as an alternate location to store file data. :: - fs rm_data_pool + ceph fs rm_data_pool This command removes the specified pool from the list of data pools for the file system. If any files have layouts for the removed data pool, the file @@ -84,7 +84,7 @@ system) cannot be removed. :: - fs rename [--yes-i-really-mean-it] + ceph fs rename [--yes-i-really-mean-it] Rename a Ceph file system. This also changes the application tags on the data pools and metadata pool of the file system to the new file system name. @@ -98,7 +98,7 @@ Settings :: - fs set max_file_size + ceph fs set max_file_size CephFS has a configurable maximum file size, and it's 1TB by default. You may wish to set this limit higher if you expect to store large files @@ -132,13 +132,13 @@ Taking a CephFS cluster down is done by setting the down flag: :: - fs set down true + ceph fs set down true To bring the cluster back online: :: - fs set down false + ceph fs set down false This will also restore the previous value of max_mds. MDS daemons are brought down in a way such that journals are flushed to the metadata pool and all @@ -149,11 +149,11 @@ Taking the cluster down rapidly for deletion or disaster recovery ----------------------------------------------------------------- To allow rapidly deleting a file system (for testing) or to quickly bring the -file system and MDS daemons down, use the ``fs fail`` command: +file system and MDS daemons down, use the ``ceph fs fail`` command: :: - fs fail + ceph fs fail This command sets a file system flag to prevent standbys from activating on the file system (the ``joinable`` flag). @@ -162,7 +162,7 @@ This process can also be done manually by doing the following: :: - fs set joinable false + ceph fs set joinable false Then the operator can fail all of the ranks which causes the MDS daemons to respawn as standbys. The file system will be left in a degraded state. @@ -170,7 +170,7 @@ respawn as standbys. The file system will be left in a degraded state. :: # For all ranks, 0-N: - mds fail : + ceph mds fail : Once all ranks are inactive, the file system may also be deleted or left in this state for other purposes (perhaps disaster recovery). @@ -179,7 +179,7 @@ To bring the cluster back up, simply set the joinable flag: :: - fs set joinable true + ceph fs set joinable true Daemons @@ -198,34 +198,35 @@ Commands to manipulate MDS daemons: :: - mds fail + ceph mds fail Mark an MDS daemon as failed. This is equivalent to what the cluster would do if an MDS daemon had failed to send a message to the mon for ``mds_beacon_grace`` second. If the daemon was active and a suitable -standby is available, using ``mds fail`` will force a failover to the standby. +standby is available, using ``ceph mds fail`` will force a failover to the +standby. -If the MDS daemon was in reality still running, then using ``mds fail`` +If the MDS daemon was in reality still running, then using ``ceph mds fail`` will cause the daemon to restart. If it was active and a standby was available, then the "failed" daemon will return as a standby. :: - tell mds. command ... + ceph tell mds. command ... Send a command to the MDS daemon(s). Use ``mds.*`` to send a command to all daemons. Use ``ceph tell mds.* help`` to learn available commands. :: - mds metadata + ceph mds metadata Get metadata about the given MDS known to the Monitors. :: - mds repaired + ceph mds repaired Mark the file system rank as repaired. Unlike the name suggests, this command does not change a MDS; it manipulates the file system rank which has been @@ -244,14 +245,14 @@ Commands to manipulate required client features of a file system: :: - fs required_client_features add reply_encoding - fs required_client_features rm reply_encoding + ceph fs required_client_features add reply_encoding + ceph fs required_client_features rm reply_encoding To list all CephFS features :: - fs feature ls + ceph fs feature ls Clients that are missing newly added features will be evicted automatically. @@ -346,7 +347,7 @@ Global settings :: - fs flag set [] + ceph fs flag set [] Sets a global CephFS flag (i.e. not specific to a particular file system). Currently, the only flag setting is 'enable_multiple' which allows having @@ -368,13 +369,13 @@ file system. :: - mds rmfailed + ceph mds rmfailed This removes a rank from the failed set. :: - fs reset + ceph fs reset This command resets the file system state to defaults, except for the name and pools. Non-zero ranks are saved in the stopped set. @@ -382,7 +383,7 @@ pools. Non-zero ranks are saved in the stopped set. :: - fs new --fscid --force + ceph fs new --fscid --force This command creates a file system with a specific **fscid** (file system cluster ID). You may want to do this when an application expects the file system's ID to be -- 2.39.5