]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephfs: mention new options for "fs volume create" cmd
authorRishabh Dave <ridave@redhat.com>
Mon, 3 Mar 2025 16:36:10 +0000 (22:06 +0530)
committerRishabh Dave <ridave@redhat.com>
Thu, 20 Mar 2025 07:09:55 +0000 (12:39 +0530)
Command "ceph fs volume create" accepts 2 new options to allow users to
pass data and metadata pool name. Update docs to include mention of both
the options.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
doc/cephfs/fs-volumes.rst
doc/cephfs/multifs.rst

index bf3f79e693bd7457a4c454830687fb7a6ecfac8e..d5ddccaae2f97a05570fd54bcc02ed73dbe94d74 100644 (file)
@@ -44,11 +44,14 @@ Create a volume by running the following command:
 
 .. prompt:: bash #
 
-   ceph fs volume create <vol_name> [placement]
-
-This creates a CephFS file system and its data and metadata pools. This command
-can also deploy MDS daemons for the filesystem using a Ceph Manager orchestrator
-module (for example Rook). See :doc:`/mgr/orchestrator`.
+   ceph fs volume create <vol_name> [placement] [--data-pool <data-pool-name>] [--meta-pool <metadata-pool-name>]
+
+This creates a CephFS file system and its data and metadata pools. Alternately,
+if the data pool and/or metadata pool needed for creating a CephFS volume
+already exist, these pool names can be passed to this command so that the
+volume is created using these existing pools. This command can also deploy MDS
+daemons for the filesystem using a Ceph Manager orchestrator module (for
+example Rook). See :doc:`/mgr/orchestrator`.
 
 ``<vol_name>`` is the volume name (an arbitrary string). ``[placement]`` is an
 optional string that specifies the :ref:`orchestrator-cli-placement-spec` for
index 2dcba7ae006ab6d41c8317a4e6afd1a6f5d2850d..8a001052ce4a7fe8bfda2dd6a2aefb3b98b96680 100644 (file)
@@ -29,6 +29,12 @@ support the new file system. The deployment technology used, e.g. cephadm, will
 also configure the MDS affinity (see: :ref:`mds-join-fs`) of new MDS daemons to
 operate the new file system.
 
+If the data and metadata pools for the volume are already present, the names of
+these pool(s) can be passed as follows::
+
+    ceph fs volume create <vol-name> --meta-pool <meta-pool-name> --data-pool <data-pool-name>
+
+
 
 Securing access
 ---------------