From: Kefu Chai <k.chai@proxmox.com>
Date: Sat, 16 May 2026 02:53:41 +0000 (+0800)
Subject: doc/dev: refresh vstart.sh options in dev_cluster_deployment
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F68946%2Fhead;p=ceph.git

doc/dev: refresh vstart.sh options in dev_cluster_deployment

Bring doc/dev/dev_cluster_deployment.rst back in line with the current
src/vstart.sh:

* drop the removed -K/--kstore objectstore backend
* drop -N/--not-new, which was dropped in 8dd2e418; reusing the existing
  cluster config is simply the default when -n is not given
* correct the --rgw_frontend default from civetweb to beast
* note that -b/--bluestore is the default objectstore backend
* update the example and add a note that a fresh build needs -n on the
  first run, while later runs can omit it
* note that the option list is not exhaustive and point at src/vstart.sh

Fixes: https://tracker.ceph.com/issues/57272
Signed-off-by: Kefu Chai <k.chai@proxmox.com>
---

diff --git a/doc/dev/dev_cluster_deployment.rst b/doc/dev/dev_cluster_deployment.rst
index 7ee65a0c721e..4b00f7b57b7d 100644
--- a/doc/dev/dev_cluster_deployment.rst
+++ b/doc/dev/dev_cluster_deployment.rst
@@ -16,6 +16,9 @@ To start your development cluster, type the following::
 
 	vstart.sh [OPTIONS]...
 
+On a fresh build, the first run must create the cluster by passing ``-n``;
+later runs can omit it to restart and reuse the existing cluster.
+
 In order to stop the cluster, you can type::
 
 	./stop.sh
@@ -23,9 +26,13 @@ In order to stop the cluster, you can type::
 Options
 =======
 
+The most common options are listed below.  ``vstart.sh`` accepts many more
+(crimson, seastore, msgr versions, bluestore devices, and so on); see the
+``usage`` text near the top of ``src/vstart.sh`` for the complete list.
+
 .. option:: -b, --bluestore
 
-    Use bluestore as the objectstore backend for osds.
+    Use bluestore as the objectstore backend for osds.  This is the default.
 
 .. option:: --cache <pool>
 
@@ -51,10 +58,6 @@ Options
 
     Keep old configuration files instead of overwriting these.
 
-.. option:: -K, --kstore
-
-    Use kstore as the osd objectstore backend.
-
 .. option:: -l, --localhost
 
     Use localhost instead of hostname.
@@ -73,11 +76,8 @@ Options
 
 .. option:: -n, --new
 
-    Create a new cluster.
-
-.. option:: -N, --not-new
-
-    Reuse existing cluster config (default).
+    Create a new cluster, replacing any existing one.  Without this flag,
+    ``vstart.sh`` reuses the existing cluster config; that is the default.
 
 .. option:: --nodaemon
 
@@ -97,7 +97,7 @@ Options
 
 .. option:: --rgw_frontend <frontend>
 
-    Specify the rgw frontend configuration (default is civetweb).
+    Specify the rgw frontend configuration (default is beast).
 
 .. option:: --rgw_compression <compression_type>
 
@@ -137,7 +137,7 @@ These environment variables will contains the number of instances of the desired
 
 Example: ::
 
-	OSD=3 MON=3 RGW=1 vstart.sh
+	OSD=3 MON=3 RGW=1 vstart.sh -n
 
 
 ============================================================