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