4 .. _device management: ../rados/operations/devices
5 .. _libstoragemgmt: https://github.com/libstorage/libstoragemgmt
10 ``ceph-volume`` scans each cluster in the host from time to time in order
11 to determine which devices are present and whether they are eligible to be
14 To print a list of devices discovered by ``cephadm``, run this command:
18 ceph orch device ls [--hostname=...] [--wide] [--refresh]
23 Hostname Path Type Serial Size Health Ident Fault Available
24 srv-01 /dev/sdb hdd 15P0A0YFFRD6 300G Unknown N/A N/A No
25 srv-01 /dev/sdc hdd 15R0A08WFRD6 300G Unknown N/A N/A No
26 srv-01 /dev/sdd hdd 15R0A07DFRD6 300G Unknown N/A N/A No
27 srv-01 /dev/sde hdd 15P0A0QDFRD6 300G Unknown N/A N/A No
28 srv-02 /dev/sdb hdd 15R0A033FRD6 300G Unknown N/A N/A No
29 srv-02 /dev/sdc hdd 15R0A05XFRD6 300G Unknown N/A N/A No
30 srv-02 /dev/sde hdd 15R0A0ANFRD6 300G Unknown N/A N/A No
31 srv-02 /dev/sdf hdd 15R0A06EFRD6 300G Unknown N/A N/A No
32 srv-03 /dev/sdb hdd 15R0A0OGFRD6 300G Unknown N/A N/A No
33 srv-03 /dev/sdc hdd 15R0A0P7FRD6 300G Unknown N/A N/A No
34 srv-03 /dev/sdd hdd 15R0A0O7FRD6 300G Unknown N/A N/A No
36 Using the ``--wide`` option provides all details relating to the device,
37 including any reasons that the device might not be eligible for use as an OSD.
39 In the above example you can see fields named "Health", "Ident", and "Fault".
40 This information is provided by integration with `libstoragemgmt`_. By default,
41 this integration is disabled (because `libstoragemgmt`_ may not be 100%
42 compatible with your hardware). To make ``cephadm`` include these fields,
43 enable cephadm's "enhanced device scan" option as follows;
47 ceph config set mgr mgr/cephadm/device_enhanced_scan true
50 Although the libstoragemgmt library performs standard SCSI inquiry calls,
51 there is no guarantee that your firmware fully implements these standards.
52 This can lead to erratic behaviour and even bus resets on some older
53 hardware. It is therefore recommended that, before enabling this feature,
54 you test your hardware's compatibility with libstoragemgmt first to avoid
55 unplanned interruptions to services.
57 There are a number of ways to test compatibility, but the simplest may be
58 to use the cephadm shell to call libstoragemgmt directly - ``cephadm shell
59 lsmcli ldl``. If your hardware is supported you should see something like
64 Path | SCSI VPD 0x83 | Link Type | Serial Number | Health Status
65 ----------------------------------------------------------------------------
66 /dev/sda | 50000396082ba631 | SAS | 15P0A0R0FRD6 | Good
67 /dev/sdb | 50000396082bbbf9 | SAS | 15P0A0YFFRD6 | Good
70 After you have enabled libstoragemgmt support, the output will look something
76 Hostname Path Type Serial Size Health Ident Fault Available
77 srv-01 /dev/sdb hdd 15P0A0YFFRD6 300G Good Off Off No
78 srv-01 /dev/sdc hdd 15R0A08WFRD6 300G Good Off Off No
81 In this example, libstoragemgmt has confirmed the health of the drives and the ability to
82 interact with the Identification and Fault LEDs on the drive enclosures. For further
83 information about interacting with these LEDs, refer to `device management`_.
86 The current release of `libstoragemgmt`_ (1.8.8) supports SCSI, SAS, and SATA based
87 local disks only. There is no official support for NVMe devices (PCIe)
89 .. _cephadm-deploy-osds:
94 Listing Storage Devices
95 -----------------------
97 In order to deploy an OSD, there must be a storage device that is *available* on
98 which the OSD will be deployed.
100 Run this command to display an inventory of storage devices on all cluster hosts:
106 A storage device is considered *available* if all of the following
109 * The device must have no partitions.
110 * The device must not have any LVM state.
111 * The device must not be mounted.
112 * The device must not contain a file system.
113 * The device must not contain a Ceph BlueStore OSD.
114 * The device must be larger than 5 GB.
116 Ceph will not provision an OSD on a device that is not available.
121 There are a few ways to create new OSDs:
123 * Tell Ceph to consume any available and unused storage device:
127 ceph orch apply osd --all-available-devices
129 * Create an OSD from a specific device on a specific host:
133 ceph orch daemon add osd *<host>*:*<device-path>*
139 ceph orch daemon add osd host1:/dev/sdb
141 * You can use :ref:`drivegroups` to categorize device(s) based on their
142 properties. This might be useful in forming a clearer picture of which
143 devices are available to consume. Properties include device type (SSD or
144 HDD), device model names, size, and the hosts on which the devices exist:
148 ceph orch apply -i spec.yml
153 The ``--dry-run`` flag causes the orchestrator to present a preview of what
154 will happen without actually creating the OSDs.
160 ceph orch apply osd --all-available-devices --dry-run
164 NAME HOST DATA DB WAL
165 all-available-devices node1 /dev/vdb - -
166 all-available-devices node2 /dev/vdc - -
167 all-available-devices node3 /dev/vdd - -
169 .. _cephadm-osd-declarative:
174 The effect of ``ceph orch apply`` is persistent. This means that drives that
175 are added to the system after the ``ceph orch apply`` command completes will be
176 automatically found and added to the cluster. It also means that drives that
177 become available (by zapping, for example) after the ``ceph orch apply``
178 command completes will be automatically found and added to the cluster.
180 We will examine the effects of the following command:
184 ceph orch apply osd --all-available-devices
186 After running the above command:
188 * If you add new disks to the cluster, they will automatically be used to
190 * If you remove an OSD and clean the LVM physical volume, a new OSD will be
191 created automatically.
193 To disable the automatic creation of OSD on available devices, use the
194 ``unmanaged`` parameter:
196 If you want to avoid this behavior (disable automatic creation of OSD on available devices), use the ``unmanaged`` parameter:
200 ceph orch apply osd --all-available-devices --unmanaged=true
204 Keep these three facts in mind:
206 - The default behavior of ``ceph orch apply`` causes cephadm constantly to reconcile. This means that cephadm creates OSDs as soon as new drives are detected.
208 - Setting ``unmanaged: True`` disables the creation of OSDs. If ``unmanaged: True`` is set, nothing will happen even if you apply a new OSD service.
210 - ``ceph orch daemon add`` creates OSDs, but does not add an OSD service.
212 * For cephadm, see also :ref:`cephadm-spec-unmanaged`.
218 Removing an OSD from a cluster involves two steps:
220 #. evacuating all placement groups (PGs) from the cluster
221 #. removing the PG-free OSD from the cluster
223 The following command performs these two steps:
227 ceph orch osd rm <osd_id(s)> [--replace] [--force]
237 Scheduled OSD(s) for removal
239 OSDs that are not safe to destroy will be rejected.
244 You can query the state of OSD operation with the following command:
248 ceph orch osd rm status
252 OSD_ID HOST STATE PG_COUNT REPLACE FORCE STARTED_AT
253 2 cephadm-dev done, waiting for purge 0 True False 2020-07-17 13:01:43.147684
254 3 cephadm-dev draining 17 False True 2020-07-17 13:01:45.162158
255 4 cephadm-dev started 42 False True 2020-07-17 13:01:45.162158
258 When no PGs are left on the OSD, it will be decommissioned and removed from the cluster.
261 After removing an OSD, if you wipe the LVM physical volume in the device used by the removed OSD, a new OSD will be created.
262 For more information on this, read about the ``unmanaged`` parameter in :ref:`cephadm-osd-declarative`.
267 It is possible to stop queued OSD removals by using the following command:
271 ceph orch osd rm stop <osd_id(s)>
277 ceph orch osd rm stop 4
281 Stopped OSD(s) removal
283 This resets the initial state of the OSD and takes it off the removal queue.
291 orch osd rm <osd_id(s)> --replace [--force]
297 ceph orch osd rm 4 --replace
301 Scheduled OSD(s) for replacement
303 This follows the same procedure as the procedure in the "Remove OSD" section, with
304 one exception: the OSD is not permanently removed from the CRUSH hierarchy, but is
305 instead assigned a 'destroyed' flag.
307 **Preserving the OSD ID**
309 The 'destroyed' flag is used to determine which OSD ids will be reused in the
312 If you use OSDSpecs for OSD deployment, your newly added disks will be assigned
313 the OSD ids of their replaced counterparts. This assumes that the new disks
314 still match the OSDSpecs.
316 Use the ``--dry-run`` flag to make certain that the ``ceph orch apply osd``
317 command does what you want it to. The ``--dry-run`` flag shows you what the
318 outcome of the command will be without making the changes you specify. When
319 you are satisfied that the command will do what you want, run the command
320 without the ``--dry-run`` flag.
324 The name of your OSDSpec can be retrieved with the command ``ceph orch ls``
326 Alternatively, you can use your OSDSpec file:
330 ceph orch apply osd -i <osd_spec_file> --dry-run
334 NAME HOST DATA DB WAL
335 <name_of_osd_spec> node1 /dev/vdb - -
338 When this output reflects your intention, omit the ``--dry-run`` flag to
339 execute the deployment.
342 Erasing Devices (Zapping Devices)
343 ---------------------------------
345 Erase (zap) a device so that it can be reused. ``zap`` calls ``ceph-volume
346 zap`` on the remote host.
350 orch device zap <hostname> <path>
356 ceph orch device zap my_hostname /dev/sdx
359 If the unmanaged flag is unset, cephadm automatically deploys drives that
360 match the DriveGroup in your OSDSpec. For example, if you use the
361 ``all-available-devices`` option when creating OSDs, when you ``zap`` a
362 device the cephadm orchestrator automatically creates a new OSD in the
363 device. To disable this behavior, see :ref:`cephadm-osd-declarative`.
368 Automatically tuning OSD memory
369 ===============================
371 OSD daemons will adjust their memory consumption based on the
372 ``osd_memory_target`` config option (several gigabytes, by
373 default). If Ceph is deployed on dedicated nodes that are not sharing
374 memory with other services, cephadm can automatically adjust the per-OSD
375 memory consumption based on the total amount of RAM and the number of deployed
378 This option is enabled globally with::
380 ceph config set osd osd_memory_target_autotune true
382 Cephadm will start with a fraction
383 (``mgr/cephadm/autotune_memory_target_ratio``, which defaults to
384 ``.7``) of the total RAM in the system, subtract off any memory
385 consumed by non-autotuned daemons (non-OSDs, for OSDs for which
386 ``osd_memory_target_autotune`` is false), and then divide by the
389 The final targets are reflected in the config database with options like::
391 WHO MASK LEVEL OPTION VALUE
392 osd host:foo basic osd_memory_target 126092301926
393 osd host:bar basic osd_memory_target 6442450944
395 Both the limits and the current memory consumed by each daemon are visible from
396 the ``ceph orch ps`` output in the ``MEM LIMIT`` column::
398 NAME HOST PORTS STATUS REFRESHED AGE MEM USED MEM LIMIT VERSION IMAGE ID CONTAINER ID
399 osd.1 dael running (3h) 10s ago 3h 72857k 117.4G 17.0.0-3781-gafaed750 7015fda3cd67 9e183363d39c
400 osd.2 dael running (81m) 10s ago 81m 63989k 117.4G 17.0.0-3781-gafaed750 7015fda3cd67 1f0cc479b051
401 osd.3 dael running (62m) 10s ago 62m 64071k 117.4G 17.0.0-3781-gafaed750 7015fda3cd67 ac5537492f27
403 To exclude an OSD from memory autotuning, disable the autotune option
404 for that OSD and also set a specific memory target. For example,
408 ceph config set osd.123 osd_memory_target_autotune false
409 ceph config set osd.123 osd_memory_target 16G
414 Advanced OSD Service Specifications
415 ===================================
417 :ref:`orchestrator-cli-service-spec`\s of type ``osd`` are a way to describe a
418 cluster layout, using the properties of disks. Service specifications give the
419 user an abstract way to tell Ceph which disks should turn into OSDs with which
420 configurations, without knowing the specifics of device names and paths.
422 Service specifications make it possible to define a yaml or json file that can
423 be used to reduce the amount of manual work involved in creating OSDs.
425 For example, instead of running the following command:
427 .. prompt:: bash [monitor.1]#
429 ceph orch daemon add osd *<host>*:*<path-to-device>*
431 for each device and each host, we can define a yaml or json file that allows us
432 to describe the layout. Here's the most basic example.
434 Create a file called (for example) ``osd_spec.yml``:
439 service_id: default_drive_group <- name of the drive_group (name can be custom)
441 host_pattern: '*' <- which hosts to target, currently only supports globs
442 data_devices: <- the type of devices you are applying specs to
443 all: true <- a filter, check below for a full list
447 #. Turn any available device (ceph-volume decides what 'available' is) into an
448 OSD on all hosts that match the glob pattern '*'. (The glob pattern matches
449 against the registered hosts from `host ls`) A more detailed section on
450 host_pattern is available below.
452 #. Then pass it to `osd create` like this:
454 .. prompt:: bash [monitor.1]#
456 ceph orch apply osd -i /path/to/osd_spec.yml
458 This instruction will be issued to all the matching hosts, and will deploy
461 Setups more complex than the one specified by the ``all`` filter are
462 possible. See :ref:`osd_filters` for details.
464 A ``--dry-run`` flag can be passed to the ``apply osd`` command to display a
465 synopsis of the proposed layout.
469 .. prompt:: bash [monitor.1]#
471 ceph orch apply osd -i /path/to/osd_spec.yml --dry-run
481 Filters are applied using an `AND` gate by default. This means that a drive
482 must fulfill all filter criteria in order to get selected. This behavior can
483 be adjusted by setting ``filter_logic: OR`` in the OSD specification.
485 Filters are used to assign disks to groups, using their attributes to group
488 The attributes are based off of ceph-volume's disk query. You can retrieve
489 information about the attributes with this command:
493 ceph-volume inventory </path/to/disk>
498 Specific disks can be targeted by vendor or model:
502 model: disk_model_name
508 vendor: disk_vendor_name
514 Specific disks can be targeted by `Size`:
523 Size specifications can be of the following forms:
532 To include disks of an exact size
538 To include disks within a given range of size:
544 To include disks that are less than or equal to 10G in size:
550 To include disks equal to or greater than 40G in size:
556 Sizes don't have to be specified exclusively in Gigabytes(G).
558 Other units of size are supported: Megabyte(M), Gigabyte(G) and Terrabyte(T).
559 Appending the (B) for byte is also supported: ``MB``, ``GB``, ``TB``.
565 This operates on the 'rotational' attribute of the disk.
571 `1` to match all disks that are rotational
573 `0` to match all disks that are non-rotational (SSD, NVME etc)
579 This will take all disks that are 'available'
581 Note: This is exclusive for the data_devices section.
591 If you have specified some valid filters but want to limit the number of disks that they match, use the ``limit`` directive:
597 For example, if you used `vendor` to match all disks that are from `VendorA`
598 but want to use only the first two, you could use `limit`:
606 Note: `limit` is a last resort and shouldn't be used if it can be avoided.
612 There are multiple optional settings you can use to change the way OSDs are deployed.
613 You can add these options to the base level of a DriveGroup for it to take effect.
615 This example would deploy all OSDs with encryption enabled.
620 service_id: example_osd_spec
627 See a full list in the DriveGroupSpecs
629 .. py:currentmodule:: ceph.deployment.drive_group
631 .. autoclass:: DriveGroupSpec
633 :exclude-members: from_json
641 All nodes with the same setup
655 This is a common setup and can be described quite easily:
660 service_id: osd_spec_default
664 model: HDD-123-foo <- note that HDD-123 would also be valid
666 model: MC-55-44-XZ <- same here, MC-55-44 is valid
668 However, we can improve it by reducing the filters on core properties of the drives:
673 service_id: osd_spec_default
681 Now, we enforce all rotating devices to be declared as 'data devices' and all non-rotating devices will be used as shared_devices (wal, db)
683 If you know that drives with more than 2TB will always be the slower data devices, you can also filter by size:
688 service_id: osd_spec_default
696 Note: All of the above DriveGroups are equally valid. Which of those you want to use depends on taste and on how much you expect your node layout to change.
702 Here we have two distinct setups
722 * 20 HDDs should share 2 SSDs
723 * 10 SSDs should share 2 NVMes
725 This can be described with two layouts.
730 service_id: osd_spec_hdd
737 limit: 2 (db_slots is actually to be favoured here, but it's not implemented yet)
740 service_id: osd_spec_ssd
748 This would create the desired layout by using all HDDs as data_devices with two SSD assigned as dedicated db/wal devices.
749 The remaining SSDs(8) will be data_devices that have the 'VendorC' NVMEs assigned as dedicated db/wal devices.
751 The advanced case (with non-uniform nodes)
752 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
754 The examples above assumed that all nodes have the same drives. That's however not always the case.
782 You can use the 'host_pattern' key in the layout to target certain nodes. Salt target notation helps to keep things easy.
788 service_id: osd_spec_node_one_to_five
790 host_pattern: 'node[1-5]'
797 service_id: osd_spec_six_to_ten
799 host_pattern: 'node[6-10]'
805 This applies different OSD specs to different hosts depending on the `host_pattern` key.
810 All previous cases co-located the WALs with the DBs.
811 It's however possible to deploy the WAL on a dedicated device as well, if it makes sense.
831 The OSD spec for this case would look like the following (using the `model` filter):
836 service_id: osd_spec_default
847 It is also possible to specify directly device paths in specific hosts like the following:
852 service_id: osd_using_paths
868 This can easily be done with other filters, like `size` or `vendor` as well.
870 Activate existing OSDs
871 ======================
873 In case the OS of a host was reinstalled, existing OSDs need to be activated
874 again. For this use case, cephadm provides a wrapper for :ref:`ceph-volume-lvm-activate` that
875 activates all existing OSDs on a host.
879 ceph cephadm osd activate <host>...
881 This will scan all existing disks for OSDs and deploy corresponding daemons.