Custom Storage Configuration


Custom storage configuration is only available for rook v1.6 and above.

Custom storage configuration is i.e. needed for rook/ceph clusters not running on OpenStack but on bare metal. The default cinder storage class used to set up OSDs is not available if you’re not running on OpenStack. In such an environment, one wants to directly define fine-granular the nodes to used and their devices.

If you’re not running on OpenStack you need to set the following variable to false:

on_openstack = false


All the subsequent described configuration does only take effect if you disabled on_openstack.

You can configure to automatically use all available nodes and/or devices:

use_all_available_nodes = true
use_all_available_devices = true

You do also have the option to manually define the to be used nodes, their configuration and devices of the configured nodes as well as device-specific configurations. For these configurations to take effect one must set use_all_available_nodes and use_all_available_devices to false.

In the following an example for a fine-granular node-device-configuration can be found:

# One node
# Node-specific configuration
encryptedDevice = "true"
# A node devices and its configuration
metadataDevice = "nvme0n1"
# Another node devices and its configuration
encryptedDevice = true
metadataDevice = "nvme0n1"

# Another node
metadataDevice = "nvme0n1"

You can use the tool tools/ to generate node-device-configuration to be included in the CephCluster manifest. The output can manually transformed to be included in the config.toml file as shown above. The tool has to be executed on each storage node after the operation system has been installed. It automatically determines the disks suitable for OSDs and metadata devices and distributes the OSDs evenly across the metadata devices. This half-automated way of generating node-device-configuration helps to avoid misconfiguration and thus to avoid time consuming correction of a wrongly deployed Ceph cluster.

For node- and device-specific configuration options please refer to the official rook documentation.