[pve-docs.git] / pve-storage-rbd.adoc

Ceph RADOS Block Devices (RBD)
------------------------------
include::attributes.txt[]

ifdef::wiki[]
:pve-toplevel:
:title: Storage: RBD
endif::wiki[]

Storage pool type: `rbd`

http://ceph.com[Ceph] is a distributed object store and file system
designed to provide excellent performance, reliability and
scalability. RADOS block devices implement a feature rich block level
storage, and you get the following advantages:

* thin provisioning
* resizable volumes
* distributed and redundant (striped over multiple OSDs)
* full snapshot and clone capabilities
* self healing
* no single point of failure
* scalable to the exabyte level 
* kernel and user space implementation available

NOTE: For smaller deployments, it is also possible to run Ceph
services directly on your {pve} nodes. Recent hardware has plenty
of CPU power and RAM, so running storage services and VMs on same node
is possible.

Configuration
~~~~~~~~~~~~~

This backend supports the common storage properties `nodes`,
`disable`, `content`, and the following `rbd` specific properties:

monhost::

List of monitor daemon IPs.

pool::

Ceph pool name.

username::

RBD user Id.

krbd::

Access rbd through krbd kernel module. This is required if you want to
use the storage for containers.

.Configuration Example (`/etc/pve/storage.cfg`)
----
rbd: ceph3
        monhost 10.1.1.20 10.1.1.21 10.1.1.22
        pool ceph3
        content images
        username admin
----

TIP: You can use the `rbd` utility to do low-level management tasks.

Authentication
~~~~~~~~~~~~~~

If you use `cephx` authentication, you need to copy the keyfile from
Ceph to Proxmox VE host.

Create the directory `/etc/pve/priv/ceph` with

 mkdir /etc/pve/priv/ceph

Then copy the keyring

 scp <cephserver>:/etc/ceph/ceph.client.admin.keyring /etc/pve/priv/ceph/<STORAGE_ID>.keyring

The keyring must be named to match your `<STORAGE_ID>`. Copying the
keyring generally requires root privileges.

Storage Features
~~~~~~~~~~~~~~~~

The `rbd` backend is a block level storage, and implements full
snapshot and clone functionality.

.Storage features for backend `rbd`
[width="100%",cols="m,m,3*d",options="header"]
|==============================================================================
|Content types  |Image formats  |Shared |Snapshots |Clones
|images rootdir |raw            |yes    |yes       |yes
|==============================================================================

ifdef::wiki[]

See Also
~~~~~~~~

* link:/wiki/Storage[Storage]

endif::wiki[]
Commit	Line	Data
	1	Ceph RADOS Block Devices (RBD)
	2	------------------------------
	3	include::attributes.txt[]
	4
	5	ifdef::wiki[]
	6	:pve-toplevel:
	7	:title: Storage: RBD
	8	endif::wiki[]
	9
	10	Storage pool type: `rbd`
	11
	12	http://ceph.com[Ceph] is a distributed object store and file system
	13	designed to provide excellent performance, reliability and
	14	scalability. RADOS block devices implement a feature rich block level
	15	storage, and you get the following advantages:
	16
	17	* thin provisioning
	18	* resizable volumes
	19	* distributed and redundant (striped over multiple OSDs)
	20	* full snapshot and clone capabilities
	21	* self healing
	22	* no single point of failure
	23	* scalable to the exabyte level
	24	* kernel and user space implementation available
	25
	26	NOTE: For smaller deployments, it is also possible to run Ceph
	27	services directly on your {pve} nodes. Recent hardware has plenty
	28	of CPU power and RAM, so running storage services and VMs on same node
	29	is possible.
	30
	31	Configuration
	32	~~~~~~~~~~~~~
	33
	34	This backend supports the common storage properties `nodes`,
	35	`disable`, `content`, and the following `rbd` specific properties:
	36
	37	monhost::
	38
	39	List of monitor daemon IPs.
	40
	41	pool::
	42
	43	Ceph pool name.
	44
	45	username::
	46
	47	RBD user Id.
	48
	49	krbd::
	50
	51	Access rbd through krbd kernel module. This is required if you want to
	52	use the storage for containers.
	53
	54	.Configuration Example (`/etc/pve/storage.cfg`)
	55	----
	56	rbd: ceph3
	57	monhost 10.1.1.20 10.1.1.21 10.1.1.22
	58	pool ceph3
	59	content images
	60	username admin
	61	----
	62
	63	TIP: You can use the `rbd` utility to do low-level management tasks.
	64
	65	Authentication
	66	~~~~~~~~~~~~~~
	67
	68	If you use `cephx` authentication, you need to copy the keyfile from
	69	Ceph to Proxmox VE host.
	70
	71	Create the directory `/etc/pve/priv/ceph` with
	72
	73	mkdir /etc/pve/priv/ceph
	74
	75	Then copy the keyring
	76
	77	scp <cephserver>:/etc/ceph/ceph.client.admin.keyring /etc/pve/priv/ceph/<STORAGE_ID>.keyring
	78
	79	The keyring must be named to match your `<STORAGE_ID>`. Copying the
	80	keyring generally requires root privileges.
	81
	82	Storage Features
	83	~~~~~~~~~~~~~~~~
	84
	85	The `rbd` backend is a block level storage, and implements full
	86	snapshot and clone functionality.
	87
	88	.Storage features for backend `rbd`
	89	[width="100%",cols="m,m,3*d",options="header"]
	90	\|==============================================================================
	91	\|Content types \|Image formats \|Shared \|Snapshots \|Clones
	92	\|images rootdir \|raw \|yes \|yes \|yes
	93	\|==============================================================================
	94
	95	ifdef::wiki[]
	96
	97	See Also
	98	~~~~~~~~
	99
	100	* link:/wiki/Storage[Storage]
	101
	102	endif::wiki[]
	103