From b634238eecf6c2b2b84a349b631797f28473654f Mon Sep 17 00:00:00 2001 From: Peter Sabaini Date: Wed, 18 Oct 2023 19:34:13 +0200 Subject: [PATCH] Address review comments Signed-off-by: Peter Sabaini --- docs/reference/commands/cluster.rst | 63 ++++++++++++++--------------- 1 file changed, 31 insertions(+), 32 deletions(-) diff --git a/docs/reference/commands/cluster.rst b/docs/reference/commands/cluster.rst index 61e6af5f..f52b65a5 100644 --- a/docs/reference/commands/cluster.rst +++ b/docs/reference/commands/cluster.rst @@ -2,27 +2,27 @@ ``cluster`` =========== -Manage the MicroCeph cluster +Manages the MicroCeph cluster. Usage: .. code-block:: none - microceph cluster [options] + microceph cluster [flags] microceph cluster [command] Available commands: .. code-block:: none - add Generates a token for a new server - bootstrap Sets up a new cluster - config Manage Ceph Cluster configs - join Joins an existing cluster - list List servers in the cluster - migrate Migrate automatic services from one node to another - remove Removes a server from the cluster - sql Runs a SQL query against the cluster database + add Generates a token for a new server + bootstrap Sets up a new cluster + config Manage Ceph Cluster configs + join Joins an existing cluster + list List servers in the cluster + migrate Migrate automatic services from one node to another + remove Removes a server from the cluster + sql Runs a SQL query against the cluster database Global options: @@ -44,7 +44,7 @@ Usage: .. code-block:: none - microceph cluster add [flags] + microceph cluster add [flags] ``bootstrap`` @@ -56,7 +56,7 @@ Usage: .. code-block:: none - microceph cluster bootstrap [flags] + microceph cluster bootstrap [flags] ``config`` ---------- @@ -67,17 +67,17 @@ Usage: .. code-block:: none - microceph cluster config [flags] - microceph cluster config [command] + microceph cluster config [flags] + microceph cluster config [command] Available Commands: .. code-block:: none - get Get specified Ceph Cluster config - list List all set Ceph level configs - reset Clear specified Ceph Cluster config - set Set specified Ceph Cluster config + get Get specified Ceph Cluster config + list List all set Ceph level configs + reset Clear specified Ceph Cluster config + set Set specified Ceph Cluster config ``config get`` @@ -89,7 +89,7 @@ Usage: .. code-block:: none - microceph cluster config get [flags] + microceph cluster config get [flags] ``config list`` @@ -101,7 +101,7 @@ Usage: .. code-block:: none - microceph cluster config list [flags] + microceph cluster config list [flags] ``config reset`` @@ -113,13 +113,13 @@ Usage: .. code-block:: none - microceph cluster config reset [flags] + microceph cluster config reset [flags] Flags: .. code-block:: none - --wait Wait for required ceph services to restart post config reset. + --wait Wait for required ceph services to restart post config reset. ``config set`` @@ -131,14 +131,14 @@ Usage: .. code-block:: none - microceph cluster config set [flags] + microceph cluster config set [flags] Flags: .. code-block:: none - --wait Wait for required ceph services to restart post config set. + --wait Wait for required ceph services to restart post config set. ``join`` @@ -150,7 +150,7 @@ Usage: .. code-block:: none - microceph cluster join [flags] + microceph cluster join [flags] ``list`` @@ -162,7 +162,7 @@ Usage: .. code-block:: none - microceph cluster list [flags] + microceph cluster list [flags] ``migrate`` @@ -175,7 +175,7 @@ Usage: .. code-block:: none - microceph cluster migrate [flags] + microceph cluster remove [flags] -Options: +Flags: .. code-block:: none - -f, --force Forcibly remove the cluster member + -f, --force Forcibly remove the cluster member ``sql`` @@ -206,5 +206,4 @@ Usage: .. code-block:: none - microceph cluster sql [flags] - + microceph cluster sql [flags]