1
0
mirror of https://github.com/ceph/ceph synced 2024-12-29 23:12:27 +00:00
ceph/doc/start/quick-cephfs.rst
John Wilkins bb407bfd10 doc: Updated Ceph FS Quick Start.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-23 17:02:17 -07:00

93 lines
2.7 KiB
ReStructuredText

=====================
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
====================
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
=============
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 Ceph FS filesystem on the admin node,
not the server node. See `FAQ`_ for details.
Filesystem in User Space (FUSE)
===============================
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 ceph-fuse -k ./ceph.client.admin.keyring -m 192.168.0.1:6789 ~/mycephfs
Additional Information
======================
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.
.. _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