diff --git a/docs/how-to/configure-network-keys.rst b/docs/how-to/configure-network-keys.rst index e36f8420..6fa0f94c 100644 --- a/docs/how-to/configure-network-keys.rst +++ b/docs/how-to/configure-network-keys.rst @@ -1,7 +1,9 @@ ======================== -Configuring network keys +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. .. list-table:: Supported Config Keys @@ -12,8 +14,6 @@ The MicroCeph cluster configuration CLI supports setting, getting, resetting and - Description * - cluster_network - Set this key to desired CIDR to configure cluster network - * - public_network - - Set this key to desired CIDR to configure public network 1. Supported config keys can be configured using the 'set' command: @@ -36,22 +36,18 @@ The MicroCeph cluster configuration CLI supports setting, getting, resetting and .. code-block:: shell - $ sudo microceph cluster config set public_network 10.5.0.0/16 $ sudo microceph cluster config list +---+-----------------+-------------+ | # | KEY | VALUE | +---+-----------------+-------------+ | 0 | cluster_network | 10.5.0.0/16 | +---+-----------------+-------------+ - | 1 | public_network | 10.5.0.0/16 | - +---+-----------------+-------------+ 4. Resetting a config key (i.e. setting the key to its default value) can performed using the 'reset' command: .. code-block:: shell $ sudo microceph cluster config reset cluster_network - $ sudo microceph cluster config reset public_network $ sudo microceph cluster config list +---+-----+-------+ | # | KEY | VALUE |