Skip to content

Commit

Permalink
Removed public_network key from cluster config docs.
Browse files Browse the repository at this point in the history
Signed-off-by: Utkarsh Bhatt <[email protected]>
  • Loading branch information
UtkarshBhatthere committed Dec 7, 2023
1 parent 0819c49 commit 15b5d47
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions docs/how-to/configure-network-keys.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:

Expand All @@ -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 |
Expand Down

0 comments on commit 15b5d47

Please sign in to comment.