src/ceph/doc/dev/dev_cluster_deployement.rst

   1 =================================
   2  Deploying a development cluster
   3 =================================
   4
   5 In order to develop on ceph, a Ceph utility,
   6 *vstart.sh*, allows you to deploy fake local cluster for development purpose.
   7
   8 Usage
   9 =====
  10
  11 It allows to deploy a fake local cluster on your machine for development purpose. It starts rgw, mon, osd and/or mds, or all of them if not specified.
  12
  13 To start your development cluster, type the following::
  14
  15         vstart.sh [OPTIONS]...
  16
  17 In order to stop the cluster, you can type::
  18
  19         ./stop.sh
  20
  21 Options
  22 =======
  23
  24 .. option:: -i ip_address
  25
  26     Bind to the specified *ip_address* instead of guessing and resolve from hostname.
  27
  28 .. option:: -k
  29
  30     Keep old configuration files instead of overwritting theses.
  31
  32 .. option:: -l, --localhost
  33
  34     Use localhost instead of hostanme.
  35
  36 .. option:: -m ip[:port]
  37
  38     Specifies monitor *ip* address and *port*.
  39
  40 .. option:: -n, --new
  41
  42     Create a new cluster.
  43
  44 .. option:: -o config
  45
  46     Add *config* to all sections in the ceph configuration.
  47
  48 .. option:: --nodaemon
  49
  50     Use ceph-run as wrapper for mon/osd/mds.
  51
  52 .. option:: --smallmds
  53
  54     Configure mds with small limit cache size.
  55
  56 .. option:: -x
  57
  58     Enable Cephx (on by default).
  59
  60 .. option:: -X
  61
  62     Disable Cephx.
  63
  64 .. option:: -d, --debug
  65
  66     Launch in debug mode
  67
  68 .. option:: --valgrind[_{osd,mds,mon}] 'valgrind_toolname [args...]'
  69
  70     Launch the osd/mds/mon/all the ceph binaries using valgrind with the specified tool and arguments.
  71
  72 .. option:: --bluestore
  73
  74     Use bluestore as the objectstore backend for osds
  75
  76 .. option:: --memstore
  77
  78     Use memstore as the objectstore backend for osds
  79
  80 .. option:: --cache <pool>
  81
  82     Set a cache-tier for the specified pool
  83
  84
  85 Environment variables
  86 =====================
  87
  88 {OSD,MDS,MON,RGW}
  89
  90 Theses environment variables will contains the number of instances of the desired ceph process you want to start.
  91
  92 Example: ::
  93
  94         OSD=3 MON=3 RGW=1 vstart.sh
  95
  96
  97 ============================================================
  98  Deploying multiple development clusters on the same machine
  99 ============================================================
 100
 101 In order to bring up multiple ceph clusters on the same machine, *mstart.sh* a
 102 small wrapper around the above *vstart* can help.
 103
 104 Usage
 105 =====
 106
 107 To start multiple clusters, you would run mstart for each cluster you would want
 108 to deploy, and it will start monitors, rgws for each cluster on different ports
 109 allowing you to run multiple mons, rgws etc. on the same cluster. Invoke it in
 110 the following way::
 111
 112   mstart.sh <cluster-name> <vstart options>
 113
 114 For eg::
 115
 116   ./mstart.sh cluster1 -n -r
 117
 118
 119 For stopping the cluster, you do::
 120
 121   ./mstop.sh <cluster-name>