Configuring cluster network

If you configure a cluster network, OSDs will route heartbeat, object replication and recovery traffic over the cluster network. This may improve performance compared to using a single network.

The MicroCeph cluster configuration CLI supports setting, getting, resetting and listing supported config keys mentioned below.

Supported config keys

Key

Description

cluster_network

Set this key to desired CIDR to configure cluster network

Note

cluster_network accepts a comma-delimited list of CIDRs, matching Ceph’s native ceph.conf syntax. The same applies to --public-network and --cluster-network at microceph cluster bootstrap and microceph cluster adopt. Each host in the cluster must have an interface address on at least one of the listed subnets.

public_network is set at microceph cluster bootstrap (or microceph cluster adopt) time and is read-only afterwards: it cannot be changed with microceph cluster config set.

For example, to span two cluster networks:

$ sudo microceph cluster config set cluster_network 10.5.0.0/16,10.6.0.0/16

  1. Supported config keys can be configured using the ‘set’ command:

$ sudo microceph cluster config set cluster_network 10.5.0.0/16

  1. Config value for a particular key could be queried using the ‘get’ command:

$ sudo microceph cluster config get cluster_network
+---+-----------------+-------------+
| # |       KEY       |     VALUE   |
+---+-----------------+-------------+
| 0 | cluster_network | 10.5.0.0/16 |
+---+-----------------+-------------+

  1. A list of all the configured keys can be fetched using the ‘list’ command:

$ sudo microceph cluster config list
+---+-----------------+-------------+
| # |       KEY       |     VALUE   |
+---+-----------------+-------------+
| 0 | cluster_network | 10.5.0.0/16 |
+---+-----------------+-------------+

  1. Resetting a config key (i.e. setting the key to its default value) can performed using the ‘reset’ command:

$ sudo microceph cluster config reset cluster_network
$ sudo microceph cluster config list
+---+-----+-------+
| # | KEY | VALUE |
+---+-----+-------+

For more explanations and implementation details refer to Cluster network configurations.