From: Jos Collin <jcollin@redhat.com>
Date: Mon, 27 Nov 2017 10:46:35 +0000 (+0530)
Subject: doc: doc for mount.fuse.ceph
X-Git-Tag: v12.2.3~232^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=e21b3af6a378cfffe58df3d56a9f9884adba8a36;p=ceph.git

doc: doc for mount.fuse.ceph

Created doc for mount.fuse.ceph.

Fixes: http://tracker.ceph.com/issues/21539
Signed-off-by: Jos Collin <jcollin@redhat.com>
(cherry picked from commit 6c39818eaf39358cab8dd3dce579c932fba0d05d)
---

diff --git a/doc/man/8/mount.fuse.ceph.rst b/doc/man/8/mount.fuse.ceph.rst
new file mode 100644
index 000000000000..0ce4cc66fdbd
--- /dev/null
+++ b/doc/man/8/mount.fuse.ceph.rst
@@ -0,0 +1,71 @@
+:orphan:
+
+====================================================
+ mount.fuse.ceph -- mount ceph-fuse from /etc/fstab.
+====================================================
+
+.. program:: mount.fuse.ceph
+
+Synopsis
+========
+
+| **mount.fuse.ceph** [-h] [-o OPTIONS [*OPTIONS* ...]]
+                      device [*device* ...]
+                      mountpoint [*mountpoint* ...]
+
+Description
+===========
+
+**mount.fuse.ceph** is a helper for mounting ceph-fuse from
+``/etc/fstab``.
+
+To use mount.fuse.ceph, add an entry in ``/etc/fstab`` like::
+
+  DEVICE    PATH        TYPE        OPTIONS
+  none      /mnt/ceph   fuse.ceph   ceph.id=admin,_netdev,defaults  0 0
+  none      /mnt/ceph   fuse.ceph   ceph.name=client.admin,_netdev,defaults  0 0
+  none      /mnt/ceph   fuse.ceph   ceph.id=myuser,ceph.conf=/etc/ceph/foo.conf,_netdev,defaults  0 0
+
+ceph-fuse options are specified in the ``OPTIONS`` column and must begin
+with ``ceph.`` prefix. This way ceph related fs options will be passed to
+ceph-fuse and others will be ignored by ceph-fuse.
+
+Options
+=======
+
+.. option:: ceph.id=<username>
+
+   Specify that the ceph-fuse will authenticate as the given user.
+
+.. option:: ceph.name=client.admin
+
+   Specify that the ceph-fuse will authenticate as client.admin
+
+.. option:: ceph.conf=/etc/ceph/foo.conf
+
+   Sets 'conf' option to /etc/ceph/foo.conf via ceph-fuse command line.
+
+
+Any valid ceph-fuse options can be passed this way.   
+
+Additional Info
+===============
+
+The old format /etc/fstab entries are also supported::
+
+  DEVICE                              PATH        TYPE        OPTIONS
+  id=admin                            /mnt/ceph   fuse.ceph   defaults   0 0
+  id=myuser,conf=/etc/ceph/foo.conf   /mnt/ceph   fuse.ceph   defaults   0 0
+
+Availability
+============
+
+**mount.fuse.ceph** is part of Ceph, a massively scalable, open-source, distributed storage system. Please
+refer to the Ceph documentation at http://ceph.com/docs for more
+information.
+
+See also
+========
+
+:doc:`ceph-fuse <ceph-fuse>`\(8),
+:doc:`ceph <ceph>`\(8)