summaryrefslogtreecommitdiffstats
path: root/src/ceph/doc/cephfs/fuse.rst
diff options
context:
space:
mode:
authorQiaowei Ren <qiaowei.ren@intel.com>2018-01-04 13:43:33 +0800
committerQiaowei Ren <qiaowei.ren@intel.com>2018-01-05 11:59:39 +0800
commit812ff6ca9fcd3e629e49d4328905f33eee8ca3f5 (patch)
tree04ece7b4da00d9d2f98093774594f4057ae561d4 /src/ceph/doc/cephfs/fuse.rst
parent15280273faafb77777eab341909a3f495cf248d9 (diff)
initial code repo
This patch creates initial code repo. For ceph, luminous stable release will be used for base code, and next changes and optimization for ceph will be added to it. For opensds, currently any changes can be upstreamed into original opensds repo (https://github.com/opensds/opensds), and so stor4nfv will directly clone opensds code to deploy stor4nfv environment. And the scripts for deployment based on ceph and opensds will be put into 'ci' directory. Change-Id: I46a32218884c75dda2936337604ff03c554648e4 Signed-off-by: Qiaowei Ren <qiaowei.ren@intel.com>
Diffstat (limited to 'src/ceph/doc/cephfs/fuse.rst')
-rw-r--r--src/ceph/doc/cephfs/fuse.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/src/ceph/doc/cephfs/fuse.rst b/src/ceph/doc/cephfs/fuse.rst
new file mode 100644
index 0000000..d8c6cdf
--- /dev/null
+++ b/src/ceph/doc/cephfs/fuse.rst
@@ -0,0 +1,52 @@
+=========================
+Mount Ceph FS using FUSE
+=========================
+
+Before mounting a Ceph File System in User Space (FUSE), ensure that the client
+host has a copy of the Ceph configuration file and a keyring with CAPS for the
+Ceph metadata server.
+
+#. From your client host, copy the Ceph configuration file from the monitor host
+ to the ``/etc/ceph`` directory. ::
+
+ sudo mkdir -p /etc/ceph
+ sudo scp {user}@{server-machine}:/etc/ceph/ceph.conf /etc/ceph/ceph.conf
+
+#. From your client host, copy the Ceph keyring from the monitor host to
+ to the ``/etc/ceph`` directory. ::
+
+ sudo scp {user}@{server-machine}:/etc/ceph/ceph.keyring /etc/ceph/ceph.keyring
+
+#. Ensure that the Ceph configuration file and the keyring have appropriate
+ permissions set on your client machine (e.g., ``chmod 644``).
+
+For additional details on ``cephx`` configuration, see
+`CEPHX Config Reference`_.
+
+To mount the Ceph file system as a FUSE, you may use the ``ceph-fuse`` command.
+For example::
+
+ sudo mkdir /home/usernname/cephfs
+ sudo ceph-fuse -m 192.168.0.1:6789 /home/username/cephfs
+
+If you have more than one filesystem, specify which one to mount using
+the ``--client_mds_namespace`` command line argument, or add a
+``client_mds_namespace`` setting to your ``ceph.conf``.
+
+See `ceph-fuse`_ for additional details.
+
+To automate mounting ceph-fuse, you may add an entry to the system fstab_.
+Additionally, ``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``. An example ceph-fuse mount on
+``/mnt`` would be::
+
+ sudo systemctl start ceph-fuse@/mnt.service
+
+A persistent mount point can be setup via::
+
+ sudo systemctl enable ceph-fuse@/mnt.service
+
+.. _ceph-fuse: ../../man/8/ceph-fuse/
+.. _fstab: ./fstab
+.. _CEPHX Config Reference: ../../rados/configuration/auth-config-ref