From bb407bfd101d9707c63655cb3c1b51346a0de8cd Mon Sep 17 00:00:00 2001
From: John Wilkins <john.wilkins@inktank.com>
Date: Thu, 23 May 2013 17:02:17 -0700
Subject: [PATCH] doc: Updated Ceph FS Quick Start.

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
---
 doc/start/quick-cephfs.rst | 84 ++++++++++++++++++++++++++++++--------
 1 file changed, 68 insertions(+), 16 deletions(-)

diff --git a/doc/start/quick-cephfs.rst b/doc/start/quick-cephfs.rst
index 5e17c4d39a4ea..abca4cb901435 100644
--- a/doc/start/quick-cephfs.rst
+++ b/doc/start/quick-cephfs.rst
@@ -1,9 +1,50 @@
+=====================
+ Ceph FS Quick Start
+=====================
+
+To use the :term:`Ceph FS` Quick Start guide, you must have executed the
+procedures in the `Ceph Deploy Quick Start`_ guide first. Execute this quick
+start on the Admin Host.
+
+Prerequisites
+=============
+
+Ensure that the :term:`Ceph Storage Cluster` is running and in an ``active +
+clean``  state. Also, ensure that you have at least one :term:`Ceph Metadata
+Server` running. :: 
+
+	ceph -s [-m {monitor-ip-address}] [-k {path/to/ceph.client.admin.keyring}]
+
+
+Create a Secret File
 ====================
- CephFS Quick Start
-====================
 
-To use this guide, you must have executed the procedures in the `5-minute
-Quick Start`_ guide first. Execute this quick start on the client machine.
+The Ceph Storage Cluster runs with authentication turned on by default. 
+You should have a file containing the secret key (i.e., not the keyring 
+itself). To obtain the secret key for a particular user, perform the 
+following procedure: 
+
+#. Identify a key for a user within a keyring file. For example:: 
+
+	cat ceph.client.admin.keyring
+
+#. Copy the key of the user who will be using the mounted Ceph FS filesystem.
+   It should look something like this:: 
+	
+	[client.admin]
+	   key = AQCj2YpRiAe6CxAA7/ETt7Hcl9IyxyYciVs47w==
+
+#. Open a text editor. 
+
+#. Paste the key into an empty file. It should look something like this::
+
+	AQCj2YpRiAe6CxAA7/ETt7Hcl9IyxyYciVs47w==
+
+#. Save the file with the user ``name`` as an attribute 
+   (e.g., ``admin.secret``).
+
+#. Ensure the file permissions are appropriate for the user, but not
+   visible to other users. 
 
 
 Kernel Driver
@@ -14,28 +55,39 @@ Mount Ceph FS as a kernel driver. ::
 	sudo mkdir /mnt/mycephfs
 	sudo mount -t ceph {ip-address-of-monitor}:6789:/ /mnt/mycephfs
 
+The Ceph Storage Cluster uses authentication by default. Specify a user ``name``
+and the ``secretfile`` you created  in the `Create a Secret File`_ section. For
+example::
+
+	sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs -o name=admin,secretfile=admin.secret
+
 
-.. note:: Mount the CephFS filesystem on the client machine,
-   not the cluster machine. See `FAQ`_ for details.
+.. note:: Mount the Ceph FS filesystem on the admin node,
+   not the server node. See `FAQ`_ for details.
 
 
 Filesystem in User Space (FUSE)
 ===============================
 
-Mount Ceph FS as with FUSE. Replace {username} with your username. ::
+Mount Ceph FS as a Filesystem in User Space (FUSE). ::
+
+	sudo mkdir ~/mycephfs
+	sudo ceph-fuse -m {ip-address-of-monitor}:6789 ~/mycephfs
+
+The Ceph Storage Cluster uses authentication by default. Specify a keyring if it
+is not in the default location (i.e., ``/etc/ceph``)::
 
-	sudo mkdir /home/{username}/cephfs
-	sudo ceph-fuse -m {ip-address-of-monitor}:6789 /home/{username}/cephfs
+	sudo ceph-fuse -k ./ceph.client.admin.keyring -m 192.168.0.1:6789 ~/mycephfs
 
 
 Additional Information
 ======================
 
-See `CephFS`_ for additional information. CephFS is not quite as stable
-as the block device and the object storage gateway. Contact `Inktank`_ for 
-details on running CephFS in a production environment.
+See `Ceph FS`_ for additional information. Ceph FS is not quite as stable
+as the Ceph Block Device and Ceph Object Storage. See `Troubleshooting`_
+if you encounter trouble. 
 
-.. _5-minute Quick Start: ../quick-start
-.. _CephFS: ../../cephfs/
-.. _Inktank: http://inktank.com
-.. _FAQ: ../../faq#try-ceph
+.. _Ceph Deploy Quick Start: ../quick-ceph-deploy
+.. _Ceph FS: ../../cephfs/
+.. _FAQ: http://wiki.ceph.com/03FAQs/01General_FAQ#How_Can_I_Give_Ceph_a_Try.3F
+.. _Troubleshooting: ../../cephfs/troubleshooting
\ No newline at end of file