2 Ceph Filesystem (CephFS)
3 ------------------------
6 :title: Storage: CephFS
9 Storage pool type: `cephfs`
11 CephFS implements a POSIX-compliant filesystem, using a https://ceph.com[Ceph]
12 storage cluster to store its data. As CephFS builds upon Ceph, it shares most of
13 its properties. This includes redundancy, scalability, self-healing, and high
16 TIP: {pve} can xref:chapter_pveceph[manage Ceph setups], which makes
17 configuring a CephFS storage easier. As modern hardware offers a lot of
18 processing power and RAM, running storage services and VMs on same node is
19 possible without a significant performance impact.
21 To use the CephFS storage plugin, you must replace the stock Debian Ceph client,
22 by adding our xref:sysadmin_package_repositories_ceph[Ceph repository].
23 Once added, run `apt update`, followed by `apt dist-upgrade`, in order to get
26 WARNING: Please ensure that there are no other Ceph repositories configured.
27 Otherwise the installation will fail or there will be mixed package versions on
28 the node, leading to unexpected behavior.
30 [[storage_cephfs_config]]
34 This backend supports the common storage properties `nodes`,
35 `disable`, `content`, as well as the following `cephfs` specific properties:
39 List of monitor daemon addresses. Optional, only needed if Ceph is not running
44 The local mount point. Optional, defaults to `/mnt/pve/<STORAGE_ID>/`.
48 Ceph user id. Optional, only needed if Ceph is not running on the PVE cluster,
49 where it defaults to `admin`.
53 CephFS subdirectory to mount. Optional, defaults to `/`.
57 Access CephFS through FUSE, instead of the kernel client. Optional, defaults
60 .Configuration example for an external Ceph cluster (`/etc/pve/storage.cfg`)
62 cephfs: cephfs-external
63 monhost 10.1.1.20 10.1.1.21 10.1.1.22
64 path /mnt/pve/cephfs-external
68 NOTE: Don't forget to set up the client's secret key file, if cephx was not
74 If you use `cephx` authentication, which is enabled by default, you need to copy
75 the secret from your external Ceph cluster to a Proxmox VE host.
77 Create the directory `/etc/pve/priv/ceph` with
79 mkdir /etc/pve/priv/ceph
83 scp cephfs.secret <proxmox>:/etc/pve/priv/ceph/<STORAGE_ID>.secret
85 The secret must be renamed to match your `<STORAGE_ID>`. Copying the
86 secret generally requires root privileges. The file must only contain the
87 secret key itself, as opposed to the `rbd` backend which also contains a
88 `[client.userid]` section.
90 A secret can be received from the Ceph cluster (as Ceph admin) by issuing the
91 command below, where `userid` is the client ID that has been configured to
92 access the cluster. For further information on Ceph user management, see the
93 Ceph docs footnote:[Ceph user management
94 {cephdocs-url}/rados/operations/user-management/].
96 ceph auth get-key client.userid > cephfs.secret
98 If Ceph is installed locally on the PVE cluster, that is, it was set up using
99 `pveceph`, this is done automatically.
104 The `cephfs` backend is a POSIX-compliant filesystem, on top of a Ceph cluster.
106 .Storage features for backend `cephfs`
107 [width="100%",cols="m,m,3*d",options="header"]
108 |==============================================================================
109 |Content types |Image formats |Shared |Snapshots |Clones
110 |vztmpl iso backup snippets |none |yes |yes^[1]^ |no
111 |==============================================================================
112 ^[1]^ While no known bugs exist, snapshots are not yet guaranteed to be stable,
113 as they lack sufficient testing.
120 * link:/wiki/Storage[Storage]