src/ceph/doc/start/quick-cephfs.rst

   1 =====================
   2  Ceph FS Quick Start
   3 =====================
   4
   5 To use the :term:`Ceph FS` Quick Start guide, you must have executed the
   6 procedures in the `Storage Cluster Quick Start`_ guide first. Execute this quick
   7 start on the Admin Host.
   8
   9 Prerequisites
  10 =============
  11
  12 #. Verify that you have an appropriate version of the Linux kernel.
  13    See `OS Recommendations`_ for details. ::
  14
  15         lsb_release -a
  16         uname -r
  17
  18 #. On the admin node, use ``ceph-deploy`` to install Ceph on your
  19    ``ceph-client`` node. ::
  20
  21         ceph-deploy install ceph-client
  22
  23
  24 #. Ensure that the :term:`Ceph Storage Cluster` is running and in an ``active +
  25    clean``  state. Also, ensure that you have at least one :term:`Ceph Metadata
  26    Server` running. ::
  27
  28         ceph -s [-m {monitor-ip-address}] [-k {path/to/ceph.client.admin.keyring}]
  29
  30
  31 Create a Filesystem
  32 ===================
  33
  34 You have already created an MDS (`Storage Cluster Quick Start`_) but it will not
  35 become active until you create some pools and a filesystem.  See :doc:`/cephfs/createfs`.
  36
  37 ::
  38
  39     ceph osd pool create cephfs_data <pg_num>
  40     ceph osd pool create cephfs_metadata <pg_num>
  41     ceph fs new <fs_name> cephfs_metadata cephfs_data
  42
  43
  44 Create a Secret File
  45 ====================
  46
  47 The Ceph Storage Cluster runs with authentication turned on by default.
  48 You should have a file containing the secret key (i.e., not the keyring
  49 itself). To obtain the secret key for a particular user, perform the
  50 following procedure:
  51
  52 #. Identify a key for a user within a keyring file. For example::
  53
  54         cat ceph.client.admin.keyring
  55
  56 #. Copy the key of the user who will be using the mounted Ceph FS filesystem.
  57    It should look something like this::
  58
  59         [client.admin]
  60            key = AQCj2YpRiAe6CxAA7/ETt7Hcl9IyxyYciVs47w==
  61
  62 #. Open a text editor.
  63
  64 #. Paste the key into an empty file. It should look something like this::
  65
  66         AQCj2YpRiAe6CxAA7/ETt7Hcl9IyxyYciVs47w==
  67
  68 #. Save the file with the user ``name`` as an attribute
  69    (e.g., ``admin.secret``).
  70
  71 #. Ensure the file permissions are appropriate for the user, but not
  72    visible to other users.
  73
  74
  75 Kernel Driver
  76 =============
  77
  78 Mount Ceph FS as a kernel driver. ::
  79
  80         sudo mkdir /mnt/mycephfs
  81         sudo mount -t ceph {ip-address-of-monitor}:6789:/ /mnt/mycephfs
  82
  83 The Ceph Storage Cluster uses authentication by default. Specify a user ``name``
  84 and the ``secretfile`` you created  in the `Create a Secret File`_ section. For
  85 example::
  86
  87         sudo mount -t ceph 192.168.0.1:6789:/ /mnt/mycephfs -o name=admin,secretfile=admin.secret
  88
  89
  90 .. note:: Mount the Ceph FS filesystem on the admin node,
  91    not the server node. See `FAQ`_ for details.
  92
  93
  94 Filesystem in User Space (FUSE)
  95 ===============================
  96
  97 Mount Ceph FS as a Filesystem in User Space (FUSE). ::
  98
  99         sudo mkdir ~/mycephfs
 100         sudo ceph-fuse -m {ip-address-of-monitor}:6789 ~/mycephfs
 101
 102 The Ceph Storage Cluster uses authentication by default. Specify a keyring if it
 103 is not in the default location (i.e., ``/etc/ceph``)::
 104
 105         sudo ceph-fuse -k ./ceph.client.admin.keyring -m 192.168.0.1:6789 ~/mycephfs
 106
 107
 108 Additional Information
 109 ======================
 110
 111 See `Ceph FS`_ for additional information. Ceph FS is not quite as stable
 112 as the Ceph Block Device and Ceph Object Storage. See `Troubleshooting`_
 113 if you encounter trouble.
 114
 115 .. _Storage Cluster Quick Start: ../quick-ceph-deploy
 116 .. _Ceph FS: ../../cephfs/
 117 .. _FAQ: http://wiki.ceph.com/How_Can_I_Give_Ceph_a_Try
 118 .. _Troubleshooting: ../../cephfs/troubleshooting
 119 .. _OS Recommendations: ../os-recommendations