doc/cephfs: merge fstab doc with respective mount docs

Fixes: https://tracker.ceph.com/issues/42601
Signed-off-by: Rishabh Dave <ridave@redhat.com>

diff --git a/doc/cephfs/fstab.rst b/doc/cephfs/fstab.rst
deleted file mode 100644 (file)
index e6be4a2..0000000
--- a/doc/cephfs/fstab.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-========================================
- Mount CephFS in your File Systems Table
-========================================
-
-If you mount CephFS in your file systems table, the Ceph file system will mount
-automatically on startup. 
-
-Kernel Driver
-=============
-
-To mount CephFS in your file systems table as a kernel driver, add the
-following to ``/etc/fstab``::
-
-       [{ipaddress}:{port}]:/ {mount}/{mountpoint} ceph [name=username,secret=secretkey|secretfile=/path/to/secretfile],[{mount.options}]
-
-For example:: 
-
-       :/     /mnt/ceph    ceph    name=admin,noatime,_netdev    0       2
-       
-The default for the ``name=`` parameter is ``guest``. If the ``secret`` or
-``secretfile`` options are not specified then the mount helper will attempt to
-find a secret for the given ``name`` in one of the configured keyrings.
- 
-See `User Management`_ for details.
-   
-   
-FUSE
-====
-
-To mount CephFS in your file systems table as a file system in user space, add
-the following to ``/etc/fstab``::
-
-       #DEVICE PATH       TYPE      OPTIONS
-       none    /mnt/mycephfs  fuse.ceph ceph.id={user-ID}[,ceph.conf={path/to/conf.conf}],_netdev,defaults  0 0
-
-For example::
-
-       none    /mnt/mycephfs  fuse.ceph ceph.id=myuser,_netdev,defaults  0 0
-       none    /mnt/mycephfs  fuse.ceph ceph.id=myuser,ceph.conf=/etc/ceph/foo.conf,_netdev,defaults  0 0
-
-Ensure you use the ID (e.g., ``admin``, not ``client.admin``). You can pass
-any valid ``ceph-fuse`` option to the command line this way.
-
-``ceph-fuse@.service`` and ``ceph-fuse.target`` systemd units are available.
-As usual, these unit files declare the default dependencies and recommended
-execution context for ``ceph-fuse``. For example, after making the fstab entry
-shown above, ``ceph-fuse`` run following commands::
-
-    systemctl start ceph-fuse@-mnt-mycephfs.service
-    systemctl enable ceph-fuse@-mnt-mycephfs.service
-
-See `User Management`_ for details.
-
-
-.. _User Management: ../../rados/operations/user-management/

diff --git a/doc/cephfs/fuse.rst b/doc/cephfs/fuse.rst
index 64c5b6a382ab0c8ed4f4e4f17889a3cb09f7116c..7f3db231dae67762571010e62e1399ed835452ce 100644 (file)
--- a/doc/cephfs/fuse.rst
+++ b/doc/cephfs/fuse.rst
@@ -95,9 +95,33 @@ Use ``umount`` to unmount CephFS like any other FS::
 .. tip:: Ensure that you are not within the file system directories before
    executing this command.
 
-See fstab_ to find out how to make FUSE-mounted CephFS persist across reboots,
-`User Management`_ for details on CephX user management and mount.ceph_ manual
-for more options it can take. For troubleshooting, see
+Persistent Mounts
+-----------------
+
+To mount CephFS in your file systems table as a file system in user space, add
+the following to ``/etc/fstab``::
+
+       #DEVICE PATH       TYPE      OPTIONS
+       none    /mnt/mycephfs  fuse.ceph ceph.id={user-ID}[,ceph.conf={path/to/conf.conf}],_netdev,defaults  0 0
+
+For example::
+
+       none    /mnt/mycephfs  fuse.ceph ceph.id=myuser,_netdev,defaults  0 0
+       none    /mnt/mycephfs  fuse.ceph ceph.id=myuser,ceph.conf=/etc/ceph/foo.conf,_netdev,defaults  0 0
+
+Ensure you use the ID (e.g., ``admin``, not ``client.admin``). You can pass
+any valid ``ceph-fuse`` option to the command line this way.
+
+``ceph-fuse@.service`` and ``ceph-fuse.target`` systemd units are available.
+As usual, these unit files declare the default dependencies and recommended
+execution context for ``ceph-fuse``. For example, after making the fstab entry
+shown above, ``ceph-fuse`` run following commands::
+
+    systemctl start ceph-fuse@-mnt-mycephfs.service
+    systemctl enable ceph-fuse@-mnt-mycephfs.service
+
+See `User Management`_ for details on CephX user management and mount.ceph_
+manual for more options it can take. For troubleshooting, see
 :ref:`kernel_mount_debugging`.
 
 .. _ceph-fuse: ../../man/8/ceph-fuse/

diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst
index 9f876422832d5410c403711f45f27105b50e1e32..21145fc39d7b6e9604bdc066c778f1d42441906b 100644 (file)
--- a/doc/cephfs/index.rst
+++ b/doc/cephfs/index.rst
@@ -93,7 +93,6 @@ Mounting CephFS
        Create a CephFS file system <createfs>
        Mount CephFS using Kernel Driver <kernel>
        Mount CephFS using FUSE <fuse>
-       Mount CephFS in fstab <fstab>
        Use the CephFS Shell <cephfs-shell>
        Supported Features of Kernel Driver <kernel-features>
        Manpage ceph-fuse <../../man/8/ceph-fuse>

diff --git a/doc/cephfs/kernel.rst b/doc/cephfs/kernel.rst
index c496415ca4cef38408f60a5555159424eeb642cc..5a3caa10c97d5678b35a9d3f665268d3741de75d 100644 (file)
--- a/doc/cephfs/kernel.rst
+++ b/doc/cephfs/kernel.rst
@@ -111,9 +111,24 @@ To unmount the Ceph file system, use the ``umount`` command as usual::
 .. tip:: Ensure that you are not within the file system directories before
    executing this command.
 
-See fstab_ to find out how to make kernel mounted CephFS persist across
-reboots, `User Management`_ for details on CephX user management and
-mount.ceph_ manual for more options it can take. For troubleshooting, see
+Persistent Mounts
+------------------
+
+To mount CephFS in your file systems table as a kernel driver, add the
+following to ``/etc/fstab``::
+
+    [{ipaddress}:{port}]:/ {mount}/{mountpoint} ceph [name=username,secret=secretkey|secretfile=/path/to/secretfile],[{mount.options}]
+
+For example::
+
+    :/     /mnt/ceph    ceph    name=admin,noatime,_netdev    0       2
+
+The default for the ``name=`` parameter is ``guest``. If the ``secret`` or
+``secretfile`` options are not specified then the mount helper will attempt to
+find a secret for the given ``name`` in one of the configured keyrings.
+
+See `User Management`_ for details on CephX user management and mount.ceph_
+manual for more options it can take. For troubleshooting, see
 :ref:`kernel_mount_debugging`.
 
 .. _fstab: ../fstab/#kernel-driver