diff options
author | John Wilkins <john.wilkins@inktank.com> | 2012-06-06 10:45:26 -0700 |
---|---|---|
committer | John Wilkins <john.wilkins@inktank.com> | 2012-06-06 10:45:26 -0700 |
commit | 87327c2d5c57f9b299bff2cfaf4861068807565b (patch) | |
tree | e5f6858626bfe8777ebd5add153a1a94e10f955b /doc | |
parent | 6c1558ecbcce7cfe2b68cee56d0ea283df47f1b9 (diff) | |
download | ceph-87327c2d5c57f9b299bff2cfaf4861068807565b.tar.gz |
doc: Added mount cephfs and included it in quick start.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cephfs/fuse.rst | 15 | ||||
-rw-r--r-- | doc/cephfs/index.rst | 14 | ||||
-rw-r--r-- | doc/cephfs/kernel.rst | 34 | ||||
-rw-r--r-- | doc/index.rst | 1 | ||||
-rw-r--r-- | doc/start/quick-start.rst | 3 |
5 files changed, 67 insertions, 0 deletions
diff --git a/doc/cephfs/fuse.rst b/doc/cephfs/fuse.rst new file mode 100644 index 00000000000..d1b0fa2ffa4 --- /dev/null +++ b/doc/cephfs/fuse.rst @@ -0,0 +1,15 @@ +========================= + Mount Ceph FS as a FUSE +========================= +To mount the Ceph file system as a File System in User Space (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 ``cephx`` authentication is on, ``ceph-fuse`` will retrieve the name and +secret from the key ring automatically. + +See `ceph-fuse`_ for details. + +.. _ceph-fuse: ../../man/8/ceph-fuse/
\ No newline at end of file diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst new file mode 100644 index 00000000000..d045dd76f7a --- /dev/null +++ b/doc/cephfs/index.rst @@ -0,0 +1,14 @@ +========= + Ceph FS +========= + +The Ceph FS file system is a POSIX-compliant file system that uses a RADOS +cluster to store its data. Ceph FS uses the same RADOS object storage device +system as RADOS block devices and RADOS object stores such as the RADOS gateway +with its S3 and Swift APIs, or native bindings. Using Ceph FS requires at least +one metadata server in your ``ceph.conf`` configuration file. + +.. toctree:: + + Mount Ceph FS<kernel> + Mount Ceph FS as FUSE <fuse>
\ No newline at end of file diff --git a/doc/cephfs/kernel.rst b/doc/cephfs/kernel.rst new file mode 100644 index 00000000000..bdc4557001d --- /dev/null +++ b/doc/cephfs/kernel.rst @@ -0,0 +1,34 @@ +====================================== + Mount Ceph FS with the Kernel Driver +====================================== + +To mount the Ceph file system you may use the ``mount`` command if you know the +monitor host IP address(es), or use the ``mount.ceph`` utility to resolve the +monitor host name(s) into IP address(es) for you. For example:: + + sudo mkdir /mnt/mycephfs + sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs + +To mount the Ceph file system with ``cephx`` authentication enabled, you must +specify a user name and a secret. :: + + sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs -o name=admin,secret=AQATSKdNGBnwLhAAnNDKnH65FmVKpXZJVasUeQ== + +The foregoing usage leaves the secret in the Bash history. A more secure +approach reads the secret from a file. For example:: + + sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs -o name=admin,secretfile=/etc/ceph/admin.secret + +See `Authentication`_ for details on cephx. + +To unmount the Ceph file system, you may use the ``umount`` command. For example:: + + sudo umount /mnt/mycephfs + +.. tip:: Ensure that you are not within the file system directories before + executing this command. + +See `mount.ceph`_ for details. + +.. _mount.ceph: ../../man/8/mount.ceph/ +.. _Authentication: ../../config-cluster/authentication/
\ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index 01c70ff2c69..ffdb176a428 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -21,6 +21,7 @@ cluster to ensure that the storage hosts are running smoothly. install/index config-cluster/index init/index + cephfs/index rbd/rbd ops/index rec/index diff --git a/doc/start/quick-start.rst b/doc/start/quick-start.rst index 88c90988c27..c97f214bf28 100644 --- a/doc/start/quick-start.rst +++ b/doc/start/quick-start.rst @@ -11,9 +11,12 @@ single host. Quick start is intended for Debian/Ubuntu Linux distributions. See `Deploy with mkcephfs`_ for details. #. Start a Ceph cluster. See `Starting a Cluster`_ for details. +#. Mount Ceph FS. + See `Ceph FS`_ for details. .. _Install Ceph packages: ../../install/debian .. _Ceph Configuration Files: ../../config-cluster/ceph-conf .. _Deploy with mkcephfs: ../../config-cluster/mkcephfs .. _Starting a Cluster: ../../init/start-cluster/ +.. _Ceph FS: ../../cephfs/
\ No newline at end of file |