]> git.proxmox.com Git - pve-docs.git/blame - pveceph.adoc
move footnote of Ceph's intro into TIP section
[pve-docs.git] / pveceph.adoc
CommitLineData
80c0adcb 1[[chapter_pveceph]]
0840a663 2ifdef::manvolnum[]
b2f242ab
DM
3pveceph(1)
4==========
404a158e 5:pve-toplevel:
0840a663
DM
6
7NAME
8----
9
21394e70 10pveceph - Manage Ceph Services on Proxmox VE Nodes
0840a663 11
49a5e11c 12SYNOPSIS
0840a663
DM
13--------
14
15include::pveceph.1-synopsis.adoc[]
16
17DESCRIPTION
18-----------
19endif::manvolnum[]
0840a663 20ifndef::manvolnum[]
4bfe3e35
TL
21Deploy Hyper-Converged Ceph Cluster
22===================================
49d3ad91 23:pve-toplevel:
0840a663
DM
24endif::manvolnum[]
25
1ff5e4e8 26[thumbnail="screenshot/gui-ceph-status.png"]
8997dd6e 27
a474ca1f
AA
28{pve} unifies your compute and storage systems, i.e. you can use the same
29physical nodes within a cluster for both computing (processing VMs and
30containers) and replicated storage. The traditional silos of compute and
31storage resources can be wrapped up into a single hyper-converged appliance.
32Separate storage networks (SANs) and connections via network attached storages
33(NAS) disappear. With the integration of Ceph, an open source software-defined
34storage platform, {pve} has the ability to run and manage Ceph storage directly
35on the hypervisor nodes.
c994e4e5
DM
36
37Ceph is a distributed object store and file system designed to provide
1d54c3b4
AA
38excellent performance, reliability and scalability.
39
04ba9b24
TL
40.Some advantages of Ceph on {pve} are:
41- Easy setup and management with CLI and GUI support
a474ca1f
AA
42- Thin provisioning
43- Snapshots support
44- Self healing
a474ca1f
AA
45- Scalable to the exabyte level
46- Setup pools with different performance and redundancy characteristics
47- Data is replicated, making it fault tolerant
48- Runs on economical commodity hardware
49- No need for hardware RAID controllers
a474ca1f
AA
50- Open source
51
1d54c3b4
AA
52For small to mid sized deployments, it is possible to install a Ceph server for
53RADOS Block Devices (RBD) directly on your {pve} cluster nodes, see
c994e4e5
DM
54xref:ceph_rados_block_devices[Ceph RADOS Block Devices (RBD)]. Recent
55hardware has plenty of CPU power and RAM, so running storage services
56and VMs on the same node is possible.
21394e70
DM
57
58To simplify management, we provide 'pveceph' - a tool to install and
59manage {ceph} services on {pve} nodes.
60
d241b01b 61.Ceph consists of a couple of Daemons, for use as a RBD storage:
1d54c3b4
AA
62- Ceph Monitor (ceph-mon)
63- Ceph Manager (ceph-mgr)
64- Ceph OSD (ceph-osd; Object Storage Daemon)
65
d241b01b
AA
66TIP: We highly recommend to get familiar with Ceph
67footnote:[Ceph intro https://docs.ceph.com/docs/{ceph_codename}/start/intro/],
68its architecture
2798d126 69footnote:[Ceph architecture https://docs.ceph.com/docs/{ceph_codename}/architecture/]
477fbcfb 70and vocabulary
2798d126 71footnote:[Ceph glossary https://docs.ceph.com/docs/{ceph_codename}/glossary].
1d54c3b4 72
21394e70
DM
73
74Precondition
75------------
76
76f6eca4
AA
77To build a hyper-converged Proxmox + Ceph Cluster there should be at least
78three (preferably) identical servers for the setup.
21394e70
DM
79
80Check also the recommendations from
2798d126 81https://docs.ceph.com/docs/{ceph_codename}/start/hardware-recommendations/[Ceph's website].
21394e70 82
76f6eca4 83.CPU
2f19a6b0
TL
84Higher CPU core frequency reduce latency and should be preferred. As a simple
85rule of thumb, you should assign a CPU core (or thread) to each Ceph service to
86provide enough resources for stable and durable Ceph performance.
76f6eca4
AA
87
88.Memory
89Especially in a hyper-converged setup, the memory consumption needs to be
2f19a6b0 90carefully monitored. In addition to the intended workload from virtual machines
5b502340
AA
91and containers, Ceph needs enough memory available to provide excellent and
92stable performance.
93
94As a rule of thumb, for roughly **1 TiB of data, 1 GiB of memory** will be used
95by an OSD. Especially during recovery, rebalancing or backfilling.
96
97The daemon itself will use additional memory. The Bluestore backend of the
98daemon requires by default **3-5 GiB of memory** (adjustable). In contrast, the
99legacy Filestore backend uses the OS page cache and the memory consumption is
100generally related to PGs of an OSD daemon.
76f6eca4
AA
101
102.Network
103We recommend a network bandwidth of at least 10 GbE or more, which is used
104exclusively for Ceph. A meshed network setup
105footnote:[Full Mesh Network for Ceph {webwiki-url}Full_Mesh_Network_for_Ceph_Server]
106is also an option if there are no 10 GbE switches available.
107
2f19a6b0
TL
108The volume of traffic, especially during recovery, will interfere with other
109services on the same network and may even break the {pve} cluster stack.
76f6eca4
AA
110
111Further, estimate your bandwidth needs. While one HDD might not saturate a 1 Gb
2f19a6b0 112link, multiple HDD OSDs per node can, and modern NVMe SSDs will even saturate
5f318cc0 11310 Gbps of bandwidth quickly. Deploying a network capable of even more bandwidth
2f19a6b0
TL
114will ensure that it isn't your bottleneck and won't be anytime soon, 25, 40 or
115even 100 GBps are possible.
76f6eca4
AA
116
117.Disks
118When planning the size of your Ceph cluster, it is important to take the
119recovery time into consideration. Especially with small clusters, the recovery
120might take long. It is recommended that you use SSDs instead of HDDs in small
121setups to reduce recovery time, minimizing the likelihood of a subsequent
122failure event during recovery.
123
2f19a6b0 124In general SSDs will provide more IOPs than spinning disks. This fact and the
76f6eca4 125higher cost may make a xref:pve_ceph_device_classes[class based] separation of
2f19a6b0 126pools appealing. Another possibility to speedup OSDs is to use a faster disk
352c803f
TL
127as journal or DB/**W**rite-**A**head-**L**og device, see
128xref:pve_ceph_osds[creating Ceph OSDs]. If a faster disk is used for multiple
129OSDs, a proper balance between OSD and WAL / DB (or journal) disk must be
130selected, otherwise the faster disk becomes the bottleneck for all linked OSDs.
76f6eca4
AA
131
132Aside from the disk type, Ceph best performs with an even sized and distributed
2f19a6b0
TL
133amount of disks per node. For example, 4 x 500 GB disks with in each node is
134better than a mixed setup with a single 1 TB and three 250 GB disk.
135
136One also need to balance OSD count and single OSD capacity. More capacity
137allows to increase storage density, but it also means that a single OSD
138failure forces ceph to recover more data at once.
76f6eca4 139
a474ca1f 140.Avoid RAID
86be506d 141As Ceph handles data object redundancy and multiple parallel writes to disks
c78756be 142(OSDs) on its own, using a RAID controller normally doesn’t improve
86be506d
TL
143performance or availability. On the contrary, Ceph is designed to handle whole
144disks on it's own, without any abstraction in between. RAID controller are not
145designed for the Ceph use case and may complicate things and sometimes even
146reduce performance, as their write and caching algorithms may interfere with
147the ones from Ceph.
a474ca1f
AA
148
149WARNING: Avoid RAID controller, use host bus adapter (HBA) instead.
150
76f6eca4 151NOTE: Above recommendations should be seen as a rough guidance for choosing
2f19a6b0
TL
152hardware. Therefore, it is still essential to adapt it to your specific needs,
153test your setup and monitor health and performance continuously.
76f6eca4 154
2394c306
TM
155[[pve_ceph_install_wizard]]
156Initial Ceph installation & configuration
157-----------------------------------------
158
159[thumbnail="screenshot/gui-node-ceph-install.png"]
160
161With {pve} you have the benefit of an easy to use installation wizard
162for Ceph. Click on one of your cluster nodes and navigate to the Ceph
6a711e64
TL
163section in the menu tree. If Ceph is not already installed you will be
164offered to do so now.
2394c306
TM
165
166The wizard is divided into different sections, where each needs to be
6a711e64
TL
167finished successfully in order to use Ceph. After starting the installation
168the wizard will download and install all required packages from {pve}'s ceph
169repository.
2394c306
TM
170
171After finishing the first step, you will need to create a configuration.
6a711e64
TL
172This step is only needed once per cluster, as this configuration is distributed
173automatically to all remaining cluster members through {pve}'s clustered
174xref:chapter_pmxcfs[configuration file system (pmxcfs)].
2394c306
TM
175
176The configuration step includes the following settings:
177
178* *Public Network:* You should setup a dedicated network for Ceph, this
179setting is required. Separating your Ceph traffic is highly recommended,
6a711e64
TL
180because it could lead to troubles with other latency dependent services,
181e.g., cluster communication may decrease Ceph's performance, if not done.
2394c306
TM
182
183[thumbnail="screenshot/gui-node-ceph-install-wizard-step2.png"]
184
185* *Cluster Network:* As an optional step you can go even further and
186separate the xref:pve_ceph_osds[OSD] replication & heartbeat traffic
187as well. This will relieve the public network and could lead to
188significant performance improvements especially in big clusters.
189
190You have two more options which are considered advanced and therefore
191should only changed if you are an expert.
192
193* *Number of replicas*: Defines the how often a object is replicated
194* *Minimum replicas*: Defines the minimum number of required replicas
6a711e64 195 for I/O to be marked as complete.
2394c306 196
6a711e64 197Additionally you need to choose your first monitor node, this is required.
2394c306
TM
198
199That's it, you should see a success page as the last step with further
200instructions on how to go on. You are now prepared to start using Ceph,
201even though you will need to create additional xref:pve_ceph_monitors[monitors],
202create some xref:pve_ceph_osds[OSDs] and at least one xref:pve_ceph_pools[pool].
203
204The rest of this chapter will guide you on how to get the most out of
205your {pve} based Ceph setup, this will include aforementioned and
206more like xref:pveceph_fs[CephFS] which is a very handy addition to your
207new Ceph cluster.
21394e70 208
58f95dd7 209[[pve_ceph_install]]
21394e70
DM
210Installation of Ceph Packages
211-----------------------------
2394c306
TM
212Use {pve} Ceph installation wizard (recommended) or run the following
213command on each node:
21394e70
DM
214
215[source,bash]
216----
19920184 217pveceph install
21394e70
DM
218----
219
220This sets up an `apt` package repository in
221`/etc/apt/sources.list.d/ceph.list` and installs the required software.
222
223
b3338e29
AA
224Create initial Ceph configuration
225---------------------------------
21394e70 226
1ff5e4e8 227[thumbnail="screenshot/gui-ceph-config.png"]
8997dd6e 228
2394c306
TM
229Use the {pve} Ceph installation wizard (recommended) or run the
230following command on one node:
21394e70
DM
231
232[source,bash]
233----
234pveceph init --network 10.10.10.0/24
235----
236
2394c306
TM
237This creates an initial configuration at `/etc/pve/ceph.conf` with a
238dedicated network for ceph. That file is automatically distributed to
239all {pve} nodes by using xref:chapter_pmxcfs[pmxcfs]. The command also
240creates a symbolic link from `/etc/ceph/ceph.conf` pointing to that file.
241So you can simply run Ceph commands without the need to specify a
242configuration file.
21394e70
DM
243
244
d9a27ee1 245[[pve_ceph_monitors]]
b3338e29
AA
246Ceph Monitor
247-----------
1d54c3b4 248The Ceph Monitor (MON)
2798d126 249footnote:[Ceph Monitor https://docs.ceph.com/docs/{ceph_codename}/start/intro/]
a474ca1f 250maintains a master copy of the cluster map. For high availability you need to
2394c306 251have at least 3 monitors. One monitor will already be installed if you
620d6725 252used the installation wizard. You won't need more than 3 monitors as long
2394c306
TM
253as your cluster is small to midsize, only really large clusters will
254need more than that.
1d54c3b4 255
b3338e29 256
c998bdf2 257[[pveceph_create_mon]]
b3338e29
AA
258Create Monitors
259~~~~~~~~~~~~~~~
260
261[thumbnail="screenshot/gui-ceph-monitor.png"]
262
1d54c3b4
AA
263On each node where you want to place a monitor (three monitors are recommended),
264create it by using the 'Ceph -> Monitor' tab in the GUI or run.
21394e70
DM
265
266
267[source,bash]
268----
d1fdb121 269pveceph mon create
21394e70
DM
270----
271
c998bdf2 272[[pveceph_destroy_mon]]
b3338e29
AA
273Destroy Monitors
274~~~~~~~~~~~~~~~~
0e38a564
AA
275
276To remove a Ceph Monitor via the GUI first select a node in the tree view and
277go to the **Ceph -> Monitor** panel. Select the MON and click the **Destroy**
278button.
279
280To remove a Ceph Monitor via the CLI first connect to the node on which the MON
281is running. Then execute the following command:
282[source,bash]
283----
284pveceph mon destroy
285----
286
287NOTE: At least three Monitors are needed for quorum.
288
289
1d54c3b4 290[[pve_ceph_manager]]
b3338e29
AA
291Ceph Manager
292------------
293The Manager daemon runs alongside the monitors. It provides an interface to
294monitor the cluster. Since the Ceph luminous release at least one ceph-mgr
2798d126 295footnote:[Ceph Manager https://docs.ceph.com/docs/{ceph_codename}/mgr/] daemon is
b3338e29
AA
296required.
297
55d634e6 298[[pveceph_create_mgr]]
b3338e29
AA
299Create Manager
300~~~~~~~~~~~~~~
1d54c3b4 301
b3338e29 302Multiple Managers can be installed, but at any time only one Manager is active.
1d54c3b4 303
1d54c3b4
AA
304[source,bash]
305----
d1fdb121 306pveceph mgr create
1d54c3b4
AA
307----
308
c1f38fe3
AA
309NOTE: It is recommended to install the Ceph Manager on the monitor nodes. For
310high availability install more then one manager.
311
21394e70 312
c998bdf2 313[[pveceph_destroy_mgr]]
b3338e29
AA
314Destroy Manager
315~~~~~~~~~~~~~~~
549350fe
AA
316
317To remove a Ceph Manager via the GUI first select a node in the tree view and
318go to the **Ceph -> Monitor** panel. Select the Manager and click the
319**Destroy** button.
320
321To remove a Ceph Monitor via the CLI first connect to the node on which the
322Manager is running. Then execute the following command:
323[source,bash]
324----
325pveceph mgr destroy
326----
327
328NOTE: A Ceph cluster can function without a Manager, but certain functions like
329the cluster status or usage require a running Manager.
330
331
d9a27ee1 332[[pve_ceph_osds]]
b3338e29
AA
333Ceph OSDs
334---------
335Ceph **O**bject **S**torage **D**aemons are storing objects for Ceph over the
336network. It is recommended to use one OSD per physical disk.
337
338NOTE: By default an object is 4 MiB in size.
339
081cb761 340[[pve_ceph_osd_create]]
b3338e29
AA
341Create OSDs
342~~~~~~~~~~~
21394e70 343
1ff5e4e8 344[thumbnail="screenshot/gui-ceph-osd-status.png"]
8997dd6e 345
21394e70
DM
346via GUI or via CLI as follows:
347
348[source,bash]
349----
d1fdb121 350pveceph osd create /dev/sd[X]
21394e70
DM
351----
352
b3338e29
AA
353TIP: We recommend a Ceph cluster size, starting with 12 OSDs, distributed
354evenly among your, at least three nodes (4 OSDs on each node).
1d54c3b4 355
a474ca1f 356If the disk was used before (eg. ZFS/RAID/OSD), to remove partition table, boot
9bddef40 357sector and any OSD leftover the following command should be sufficient.
a474ca1f
AA
358
359[source,bash]
360----
9bddef40 361ceph-volume lvm zap /dev/sd[X] --destroy
a474ca1f
AA
362----
363
9bddef40 364WARNING: The above command will destroy data on the disk!
1d54c3b4 365
b3338e29 366.Ceph Bluestore
21394e70 367
1d54c3b4
AA
368Starting with the Ceph Kraken release, a new Ceph OSD storage type was
369introduced, the so called Bluestore
2798d126 370footnote:[Ceph Bluestore https://ceph.com/community/new-luminous-bluestore/].
9bddef40 371This is the default when creating OSDs since Ceph Luminous.
21394e70
DM
372
373[source,bash]
374----
d1fdb121 375pveceph osd create /dev/sd[X]
1d54c3b4
AA
376----
377
1e834cb2 378.Block.db and block.wal
1d54c3b4
AA
379
380If you want to use a separate DB/WAL device for your OSDs, you can specify it
b3338e29
AA
381through the '-db_dev' and '-wal_dev' options. The WAL is placed with the DB, if
382not specified separately.
1d54c3b4
AA
383
384[source,bash]
385----
d1fdb121 386pveceph osd create /dev/sd[X] -db_dev /dev/sd[Y] -wal_dev /dev/sd[Z]
1d54c3b4
AA
387----
388
9bddef40 389You can directly choose the size for those with the '-db_size' and '-wal_size'
5f318cc0 390parameters respectively. If they are not given the following values (in order)
9bddef40
DC
391will be used:
392
352c803f
TL
393* bluestore_block_{db,wal}_size from ceph configuration...
394** ... database, section 'osd'
395** ... database, section 'global'
396** ... file, section 'osd'
397** ... file, section 'global'
9bddef40
DC
398* 10% (DB)/1% (WAL) of OSD size
399
1d54c3b4 400NOTE: The DB stores BlueStore’s internal metadata and the WAL is BlueStore’s
ee4a0e96 401internal journal or write-ahead log. It is recommended to use a fast SSD or
1d54c3b4
AA
402NVRAM for better performance.
403
404
b3338e29 405.Ceph Filestore
9bddef40 406
352c803f 407Before Ceph Luminous, Filestore was used as default storage type for Ceph OSDs.
9bddef40 408Starting with Ceph Nautilus, {pve} does not support creating such OSDs with
352c803f
TL
409'pveceph' anymore. If you still want to create filestore OSDs, use
410'ceph-volume' directly.
1d54c3b4
AA
411
412[source,bash]
413----
9bddef40 414ceph-volume lvm create --filestore --data /dev/sd[X] --journal /dev/sd[Y]
21394e70
DM
415----
416
081cb761 417[[pve_ceph_osd_destroy]]
b3338e29
AA
418Destroy OSDs
419~~~~~~~~~~~~
be2d137e
AA
420
421To remove an OSD via the GUI first select a {PVE} node in the tree view and go
422to the **Ceph -> OSD** panel. Select the OSD to destroy. Next click the **OUT**
423button. Once the OSD status changed from `in` to `out` click the **STOP**
424button. As soon as the status changed from `up` to `down` select **Destroy**
425from the `More` drop-down menu.
426
427To remove an OSD via the CLI run the following commands.
428[source,bash]
429----
430ceph osd out <ID>
431systemctl stop ceph-osd@<ID>.service
432----
433NOTE: The first command instructs Ceph not to include the OSD in the data
434distribution. The second command stops the OSD service. Until this time, no
435data is lost.
436
437The following command destroys the OSD. Specify the '-cleanup' option to
438additionally destroy the partition table.
439[source,bash]
440----
441pveceph osd destroy <ID>
442----
443WARNING: The above command will destroy data on the disk!
444
445
07fef357 446[[pve_ceph_pools]]
b3338e29
AA
447Ceph Pools
448----------
1d54c3b4 449A pool is a logical group for storing objects. It holds **P**lacement
90682f35 450**G**roups (`PG`, `pg_num`), a collection of objects.
1d54c3b4 451
b3338e29
AA
452
453Create Pools
454~~~~~~~~~~~~
455
456[thumbnail="screenshot/gui-ceph-pools.png"]
457
90682f35
TL
458When no options are given, we set a default of **128 PGs**, a **size of 3
459replicas** and a **min_size of 2 replicas** for serving objects in a degraded
460state.
1d54c3b4 461
5a54ef44 462NOTE: The default number of PGs works for 2-5 disks. Ceph throws a
90682f35 463'HEALTH_WARNING' if you have too few or too many PGs in your cluster.
1d54c3b4
AA
464
465It is advised to calculate the PG number depending on your setup, you can find
a474ca1f 466the formula and the PG calculator footnote:[PG calculator
fc59c6d3
DJ
467https://ceph.com/pgcalc/] online. From Ceph Nautilus onwards it is possible to
468increase and decrease the number of PGs later on footnote:[Placement Groups
469https://docs.ceph.com/docs/{ceph_codename}/rados/operations/placement-groups/].
1d54c3b4
AA
470
471
472You can create pools through command line or on the GUI on each PVE host under
473**Ceph -> Pools**.
474
475[source,bash]
476----
d1fdb121 477pveceph pool create <name>
1d54c3b4
AA
478----
479
620d6725
FE
480If you would like to automatically also get a storage definition for your pool,
481mark the checkbox "Add storages" in the GUI or use the command line option
482'--add_storages' at pool creation.
21394e70 483
1d54c3b4
AA
484Further information on Ceph pool handling can be found in the Ceph pool
485operation footnote:[Ceph pool operation
2798d126 486https://docs.ceph.com/docs/{ceph_codename}/rados/operations/pools/]
1d54c3b4 487manual.
21394e70 488
166c91fe 489
b3338e29
AA
490Destroy Pools
491~~~~~~~~~~~~~
166c91fe
AA
492
493To destroy a pool via the GUI select a node in the tree view and go to the
494**Ceph -> Pools** panel. Select the pool to destroy and click the **Destroy**
495button. To confirm the destruction of the pool you need to enter the pool name.
496
497Run the following command to destroy a pool. Specify the '-remove_storages' to
498also remove the associated storage.
499[source,bash]
500----
501pveceph pool destroy <name>
502----
503
504NOTE: Deleting the data of a pool is a background task and can take some time.
505You will notice that the data usage in the cluster is decreasing.
506
76f6eca4 507[[pve_ceph_device_classes]]
9fad507d
AA
508Ceph CRUSH & device classes
509---------------------------
510The foundation of Ceph is its algorithm, **C**ontrolled **R**eplication
511**U**nder **S**calable **H**ashing
512(CRUSH footnote:[CRUSH https://ceph.com/wp-content/uploads/2016/08/weil-crush-sc06.pdf]).
513
514CRUSH calculates where to store to and retrieve data from, this has the
515advantage that no central index service is needed. CRUSH works with a map of
516OSDs, buckets (device locations) and rulesets (data replication) for pools.
517
518NOTE: Further information can be found in the Ceph documentation, under the
2798d126 519section CRUSH map footnote:[CRUSH map https://docs.ceph.com/docs/{ceph_codename}/rados/operations/crush-map/].
9fad507d
AA
520
521This map can be altered to reflect different replication hierarchies. The object
522replicas can be separated (eg. failure domains), while maintaining the desired
523distribution.
524
525A common use case is to use different classes of disks for different Ceph pools.
526For this reason, Ceph introduced the device classes with luminous, to
527accommodate the need for easy ruleset generation.
528
529The device classes can be seen in the 'ceph osd tree' output. These classes
530represent their own root bucket, which can be seen with the below command.
531
532[source, bash]
533----
534ceph osd crush tree --show-shadow
535----
536
537Example output form the above command:
538
539[source, bash]
540----
541ID CLASS WEIGHT TYPE NAME
542-16 nvme 2.18307 root default~nvme
543-13 nvme 0.72769 host sumi1~nvme
544 12 nvme 0.72769 osd.12
545-14 nvme 0.72769 host sumi2~nvme
546 13 nvme 0.72769 osd.13
547-15 nvme 0.72769 host sumi3~nvme
548 14 nvme 0.72769 osd.14
549 -1 7.70544 root default
550 -3 2.56848 host sumi1
551 12 nvme 0.72769 osd.12
552 -5 2.56848 host sumi2
553 13 nvme 0.72769 osd.13
554 -7 2.56848 host sumi3
555 14 nvme 0.72769 osd.14
556----
557
558To let a pool distribute its objects only on a specific device class, you need
559to create a ruleset with the specific class first.
560
561[source, bash]
562----
563ceph osd crush rule create-replicated <rule-name> <root> <failure-domain> <class>
564----
565
566[frame="none",grid="none", align="left", cols="30%,70%"]
567|===
568|<rule-name>|name of the rule, to connect with a pool (seen in GUI & CLI)
569|<root>|which crush root it should belong to (default ceph root "default")
570|<failure-domain>|at which failure-domain the objects should be distributed (usually host)
571|<class>|what type of OSD backing store to use (eg. nvme, ssd, hdd)
572|===
573
574Once the rule is in the CRUSH map, you can tell a pool to use the ruleset.
575
576[source, bash]
577----
578ceph osd pool set <pool-name> crush_rule <rule-name>
579----
580
581TIP: If the pool already contains objects, all of these have to be moved
b3338e29
AA
582accordingly. Depending on your setup this may introduce a big performance hit
583on your cluster. As an alternative, you can create a new pool and move disks
9fad507d
AA
584separately.
585
586
21394e70
DM
587Ceph Client
588-----------
589
1ff5e4e8 590[thumbnail="screenshot/gui-ceph-log.png"]
8997dd6e 591
21394e70
DM
592You can then configure {pve} to use such pools to store VM or
593Container images. Simply use the GUI too add a new `RBD` storage (see
594section xref:ceph_rados_block_devices[Ceph RADOS Block Devices (RBD)]).
595
620d6725 596You also need to copy the keyring to a predefined location for an external Ceph
1d54c3b4
AA
597cluster. If Ceph is installed on the Proxmox nodes itself, then this will be
598done automatically.
21394e70
DM
599
600NOTE: The file name needs to be `<storage_id> + `.keyring` - `<storage_id>` is
601the expression after 'rbd:' in `/etc/pve/storage.cfg` which is
602`my-ceph-storage` in the following example:
603
604[source,bash]
605----
606mkdir /etc/pve/priv/ceph
607cp /etc/ceph/ceph.client.admin.keyring /etc/pve/priv/ceph/my-ceph-storage.keyring
608----
0840a663 609
58f95dd7
TL
610[[pveceph_fs]]
611CephFS
612------
613
614Ceph provides also a filesystem running on top of the same object storage as
615RADOS block devices do. A **M**eta**d**ata **S**erver (`MDS`) is used to map
616the RADOS backed objects to files and directories, allowing to provide a
617POSIX-compliant replicated filesystem. This allows one to have a clustered
618highly available shared filesystem in an easy way if ceph is already used. Its
619Metadata Servers guarantee that files get balanced out over the whole Ceph
620cluster, this way even high load will not overload a single host, which can be
d180eb39 621an issue with traditional shared filesystem approaches, like `NFS`, for
58f95dd7
TL
622example.
623
1e834cb2
TL
624[thumbnail="screenshot/gui-node-ceph-cephfs-panel.png"]
625
2394c306 626{pve} supports both, using an existing xref:storage_cephfs[CephFS as storage]
58f95dd7
TL
627to save backups, ISO files or container templates and creating a
628hyper-converged CephFS itself.
629
630
631[[pveceph_fs_mds]]
632Metadata Server (MDS)
633~~~~~~~~~~~~~~~~~~~~~
634
635CephFS needs at least one Metadata Server to be configured and running to be
636able to work. One can simply create one through the {pve} web GUI's `Node ->
637CephFS` panel or on the command line with:
638
639----
640pveceph mds create
641----
642
643Multiple metadata servers can be created in a cluster. But with the default
644settings only one can be active at any time. If an MDS, or its node, becomes
645unresponsive (or crashes), another `standby` MDS will get promoted to `active`.
646One can speed up the hand-over between the active and a standby MDS up by using
647the 'hotstandby' parameter option on create, or if you have already created it
648you may set/add:
649
650----
651mds standby replay = true
652----
653
654in the ceph.conf respective MDS section. With this enabled, this specific MDS
655will always poll the active one, so that it can take over faster as it is in a
3580eb13 656`warm` state. But naturally, the active polling will cause some additional
58f95dd7
TL
657performance impact on your system and active `MDS`.
658
1e834cb2 659.Multiple Active MDS
58f95dd7
TL
660
661Since Luminous (12.2.x) you can also have multiple active metadata servers
662running, but this is normally only useful for a high count on parallel clients,
663as else the `MDS` seldom is the bottleneck. If you want to set this up please
664refer to the ceph documentation. footnote:[Configuring multiple active MDS
2798d126 665daemons https://docs.ceph.com/docs/{ceph_codename}/cephfs/multimds/]
58f95dd7
TL
666
667[[pveceph_fs_create]]
8a38333f
AA
668Create CephFS
669~~~~~~~~~~~~~
58f95dd7
TL
670
671With {pve}'s CephFS integration into you can create a CephFS easily over the
672Web GUI, the CLI or an external API interface. Some prerequisites are required
673for this to work:
674
675.Prerequisites for a successful CephFS setup:
676- xref:pve_ceph_install[Install Ceph packages], if this was already done some
677 time ago you might want to rerun it on an up to date system to ensure that
678 also all CephFS related packages get installed.
679- xref:pve_ceph_monitors[Setup Monitors]
680- xref:pve_ceph_monitors[Setup your OSDs]
681- xref:pveceph_fs_mds[Setup at least one MDS]
682
683After this got all checked and done you can simply create a CephFS through
684either the Web GUI's `Node -> CephFS` panel or the command line tool `pveceph`,
685for example with:
686
687----
688pveceph fs create --pg_num 128 --add-storage
689----
690
691This creates a CephFS named `'cephfs'' using a pool for its data named
692`'cephfs_data'' with `128` placement groups and a pool for its metadata named
693`'cephfs_metadata'' with one quarter of the data pools placement groups (`32`).
694Check the xref:pve_ceph_pools[{pve} managed Ceph pool chapter] or visit the
695Ceph documentation for more information regarding a fitting placement group
696number (`pg_num`) for your setup footnote:[Ceph Placement Groups
2798d126 697https://docs.ceph.com/docs/{ceph_codename}/rados/operations/placement-groups/].
58f95dd7
TL
698Additionally, the `'--add-storage'' parameter will add the CephFS to the {pve}
699storage configuration after it was created successfully.
700
701Destroy CephFS
702~~~~~~~~~~~~~~
703
fa9b4ee1 704WARNING: Destroying a CephFS will render all its data unusable, this cannot be
58f95dd7
TL
705undone!
706
707If you really want to destroy an existing CephFS you first need to stop, or
620d6725 708destroy, all metadata servers (`M̀DS`). You can destroy them either over the Web
58f95dd7
TL
709GUI or the command line interface, with:
710
711----
712pveceph mds destroy NAME
713----
714on each {pve} node hosting a MDS daemon.
715
716Then, you can remove (destroy) CephFS by issuing a:
717
718----
de2f8225 719ceph fs rm NAME --yes-i-really-mean-it
58f95dd7
TL
720----
721on a single node hosting Ceph. After this you may want to remove the created
722data and metadata pools, this can be done either over the Web GUI or the CLI
723with:
724
725----
726pveceph pool destroy NAME
727----
0840a663 728
6ff32926 729
081cb761
AA
730Ceph maintenance
731----------------
af6f59f4 732
081cb761
AA
733Replace OSDs
734~~~~~~~~~~~~
af6f59f4 735
081cb761
AA
736One of the common maintenance tasks in Ceph is to replace a disk of an OSD. If
737a disk is already in a failed state, then you can go ahead and run through the
738steps in xref:pve_ceph_osd_destroy[Destroy OSDs]. Ceph will recreate those
af6f59f4
TL
739copies on the remaining OSDs if possible. This rebalancing will start as soon
740as an OSD failure is detected or an OSD was actively stopped.
741
742NOTE: With the default size/min_size (3/2) of a pool, recovery only starts when
743`size + 1` nodes are available. The reason for this is that the Ceph object
744balancer xref:pve_ceph_device_classes[CRUSH] defaults to a full node as
745`failure domain'.
081cb761
AA
746
747To replace a still functioning disk, on the GUI go through the steps in
748xref:pve_ceph_osd_destroy[Destroy OSDs]. The only addition is to wait until
749the cluster shows 'HEALTH_OK' before stopping the OSD to destroy it.
750
751On the command line use the following commands.
752----
753ceph osd out osd.<id>
754----
755
756You can check with the command below if the OSD can be safely removed.
757----
758ceph osd safe-to-destroy osd.<id>
759----
760
761Once the above check tells you that it is save to remove the OSD, you can
762continue with following commands.
763----
764systemctl stop ceph-osd@<id>.service
765pveceph osd destroy <id>
766----
767
768Replace the old disk with the new one and use the same procedure as described
769in xref:pve_ceph_osd_create[Create OSDs].
770
835f322d
TL
771Trim/Discard
772~~~~~~~~~~~~
081cb761
AA
773It is a good measure to run 'fstrim' (discard) regularly on VMs or containers.
774This releases data blocks that the filesystem isn’t using anymore. It reduces
c78cd2b6
AA
775data usage and resource load. Most modern operating systems issue such discard
776commands to their disks regularly. You only need to ensure that the Virtual
777Machines enable the xref:qm_hard_disk_discard[disk discard option].
081cb761 778
c998bdf2 779[[pveceph_scrub]]
081cb761
AA
780Scrub & Deep Scrub
781~~~~~~~~~~~~~~~~~~
782Ceph ensures data integrity by 'scrubbing' placement groups. Ceph checks every
783object in a PG for its health. There are two forms of Scrubbing, daily
b16f8c5f
TL
784cheap metadata checks and weekly deep data checks. The weekly deep scrub reads
785the objects and uses checksums to ensure data integrity. If a running scrub
786interferes with business (performance) needs, you can adjust the time when
787scrubs footnote:[Ceph scrubbing https://docs.ceph.com/docs/{ceph_codename}/rados/configuration/osd-config-ref/#scrubbing]
081cb761
AA
788are executed.
789
790
10df14fb
TL
791Ceph monitoring and troubleshooting
792-----------------------------------
793A good start is to continuosly monitor the ceph health from the start of
794initial deployment. Either through the ceph tools itself, but also by accessing
795the status through the {pve} link:api-viewer/index.html[API].
6ff32926 796
10df14fb
TL
797The following ceph commands below can be used to see if the cluster is healthy
798('HEALTH_OK'), if there are warnings ('HEALTH_WARN'), or even errors
799('HEALTH_ERR'). If the cluster is in an unhealthy state the status commands
620d6725 800below will also give you an overview of the current events and actions to take.
6ff32926
AA
801
802----
10df14fb
TL
803# single time output
804pve# ceph -s
805# continuously output status changes (press CTRL+C to stop)
806pve# ceph -w
6ff32926
AA
807----
808
809To get a more detailed view, every ceph service has a log file under
810`/var/log/ceph/` and if there is not enough detail, the log level can be
2798d126 811adjusted footnote:[Ceph log and debugging https://docs.ceph.com/docs/{ceph_codename}/rados/troubleshooting/log-and-debug/].
6ff32926
AA
812
813You can find more information about troubleshooting
2798d126 814footnote:[Ceph troubleshooting https://docs.ceph.com/docs/{ceph_codename}/rados/troubleshooting/]
620d6725 815a Ceph cluster on the official website.
6ff32926
AA
816
817
0840a663
DM
818ifdef::manvolnum[]
819include::pve-copyright.adoc[]
820endif::manvolnum[]