pve-storage-cephfs.adoc

   1 [[storage_cephfs]]
   2 Ceph Filesystem (CephFS)
   3 ------------------------
   4 ifdef::wiki[]
   5 :pve-toplevel:
   6 :title: Storage: CephFS
   7 endif::wiki[]
   8
   9 Storage pool type: `cephfs`
  10
  11 http://ceph.com[Ceph] is a distributed object store and file system designed to
  12 provide excellent performance, reliability and scalability. CephFS implements a
  13 POSIX-compliant filesystem storage, with the following advantages:
  14
  15 * thin provisioning
  16 * distributed and redundant (striped over multiple OSDs)
  17 * snapshot capabilities
  18 * self healing
  19 * no single point of failure
  20 * scalable to the exabyte level
  21 * kernel and user space implementation available
  22
  23 NOTE: For smaller deployments, it is also possible to run Ceph
  24 services directly on your {pve} nodes. Recent hardware has plenty
  25 of CPU power and RAM, so running storage services and VMs on same node
  26 is possible.
  27
  28 [[storage_cephfs_config]]
  29 Configuration
  30 ~~~~~~~~~~~~~
  31
  32 This backend supports the common storage properties `nodes`,
  33 `disable`, `content`, and the following `cephfs` specific properties:
  34
  35 monhost::
  36
  37 List of monitor daemon IPs. Optional, only needed if Ceph is not running on the
  38 PVE cluster.
  39
  40 path::
  41
  42 The local mount point. Optional, defaults to `/mnt/pve/<STORAGE_ID>/`.
  43
  44 username::
  45
  46 Ceph user Id. Optional, only needed if Ceph is not running on the PVE cluster.
  47
  48 subdir::
  49
  50 CephFS subdirectory to mount. Optional, defaults to `/`.
  51
  52 fuse::
  53
  54 Access CephFS through FUSE, instead of the kernel client. Optional, defaults
  55 to `0`.
  56
  57 .Configuration Example for a external Ceph cluster (`/etc/pve/storage.cfg`)
  58 ----
  59 cephfs: cephfs-external
  60         monhost 10.1.1.20 10.1.1.21 10.1.1.22
  61         path /mnt/pve/cephfs-external
  62         content backup
  63         username admin
  64 ----
  65
  66 Authentication
  67 ~~~~~~~~~~~~~~
  68
  69 If you use `cephx` authentication, you need to copy the secret from your
  70 external Ceph cluster to a Proxmox VE host.
  71
  72 Create the directory `/etc/pve/priv/ceph` with
  73
  74  mkdir /etc/pve/priv/ceph
  75
  76 Then copy the secret
  77
  78  scp <cephserver>:/etc/ceph/cephfs.secret /etc/pve/priv/ceph/<STORAGE_ID>.secret
  79
  80 The secret must be named to match your `<STORAGE_ID>`. Copying the
  81 secret generally requires root privileges. The file must only contain the
  82 secret itself, opposed to the `rbd` backend.
  83
  84 If Ceph is installed locally on the PVE cluster, this is done automatically.
  85
  86 Storage Features
  87 ~~~~~~~~~~~~~~~~
  88
  89 The `cephfs` backend is a POSIX-compliant filesystem on top of a Ceph cluster.
  90
  91 .Storage features for backend `cephfs`
  92 [width="100%",cols="m,m,3*d",options="header"]
  93 |==============================================================================
  94 |Content types     |Image formats  |Shared |Snapshots |Clones
  95 |vztmpl iso backup |none           |yes    |yes       |no
  96 |==============================================================================
  97
  98 ifdef::wiki[]
  99
 100 See Also
 101 ~~~~~~~~
 102
 103 * link:/wiki/Storage[Storage]
 104
 105 endif::wiki[]
 106