From: Christophe Courtaut <christophe.courtaut@gmail.com>
Date: Thu, 4 Jul 2013 12:08:41 +0000 (+0200)
Subject: doc: Add a page to document vstart.sh script
X-Git-Tag: v0.67-rc1~128^2~5^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=a793e203fd0b7dff9fa7b8bc2a46d04b081fd9e7;p=ceph.git

doc: Add a page to document vstart.sh script

Signed-off-by: Christophe Courtaut <christophe.courtaut@gmail.com>
---

diff --git a/doc/dev/dev_cluster_deployement.rst b/doc/dev/dev_cluster_deployement.rst
new file mode 100644
index 000000000000..d79f7de4dfa1
--- /dev/null
+++ b/doc/dev/dev_cluster_deployement.rst
@@ -0,0 +1,82 @@
+=================================
+ Deploying a development cluster
+=================================
+
+In order to develop on ceph, a Ceph utility,
+*vstart.sh*, allows you to deploy fake local cluster for development purpose.
+
+Usage
+=====
+
+It allows to deploy a fake local cluster on your machine for development purpose. It starts mon, osd and/or mds, or all of them if not specified.
+
+To start your development cluster, type the following::
+
+	vstart.sh [OPTIONS]... [mon] [osd] [mds]
+
+In order to stop the cluster, you can type::
+
+	./stop.sh
+
+Options
+=======
+
+.. option:: -i ip_address
+
+    Bind to the specified *ip_address* instead of guessing and resolve from hostname.
+
+.. option:: -k
+
+    Keep old configuration files instead of overwritting theses.
+
+.. option:: -l, --localhost
+
+    Use localhost instead of hostanme.
+
+.. option:: -m ip[:port]
+
+    Specifies monitor *ip* address and *port*.
+
+.. option:: -n, --new
+
+    Create a new cluster.
+
+.. option:: -o config
+
+    Add *config* to all sections in the ceph configuration.
+
+.. option:: -r
+
+    Start radosgw (ceph needs to be compiled with --radosgw), create an apache2 configuration file, and start apache2 with it (needs apache2 with mod_fastcgi) on port starting from 8000.
+
+.. option:: --nodaemon
+
+    Use ceph-run as wrapper for mon/osd/mds.
+
+.. option:: --smallmds
+
+    Configure mds with small limit cache size.
+
+.. option:: -x
+
+    Enable Cephx (on by default).
+
+.. option:: -X
+
+    Disable Cephx.
+
+.. option:: -d, --debug
+
+    Launch in debug mode
+
+.. option:: --valgrind[_{osd,mds,mon}] 'valgrind_toolname [args...]'
+
+    Launch the osd/mds/mon/all the ceph binaries using valgrind with the specified tool and arguments.
+
+Environment variables
+=====================
+
+CEPH_NUM_{OSD,MDS,MON,RGW}
+
+Theses environment variables will contains the number of instances of the desired ceph process you want to start.
+