summaryrefslogtreecommitdiffstats
path: root/doc/cephfs/fstab.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cephfs/fstab.rst')
-rw-r--r--doc/cephfs/fstab.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/cephfs/fstab.rst b/doc/cephfs/fstab.rst
new file mode 100644
index 00000000..344c80d9
--- /dev/null
+++ b/doc/cephfs/fstab.rst
@@ -0,0 +1,47 @@
+========================================
+ 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} {filesystem-name} [name=username,secret=secretkey|secretfile=/path/to/secretfile],[{mount.options}]
+
+For example::
+
+ 10.10.10.10:6789:/ /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 filesystem in user space, add the
+following to ``/etc/fstab``::
+
+ #DEVICE PATH TYPE OPTIONS
+ none /mnt/ceph fuse.ceph ceph.id={user-ID}[,ceph.conf={path/to/conf.conf}],_netdev,defaults 0 0
+
+For example::
+
+ none /mnt/ceph fuse.ceph ceph.id=myuser,_netdev,defaults 0 0
+ none /mnt/ceph 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.
+
+See `User Management`_ for details.
+
+
+.. _User Management: ../../rados/operations/user-management/