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