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:: -b, --bluestore
  25
  26     Use bluestore as the objectstore backend for osds.
  27
  28 .. option:: --cache <pool>
  29
  30     Set a cache-tier for the specified pool.
  31
  32 .. option:: -d, --debug
  33
  34     Launch in debug mode.
  35
  36 .. option:: -e
  37
  38     Create an erasure pool.
  39
  40 .. option:: -f, --filestore
  41
  42     Use filestore as the osd objectstore backend.
  43
  44 .. option:: --hitset <pool> <hit_set_type>
  45
  46     Enable hitset tracking.
  47
  48 .. option:: -i ip_address
  49
  50     Bind to the specified *ip_address* instead of guessing and resolve from hostname.
  51
  52 .. option:: -k
  53
  54     Keep old configuration files instead of overwritting theses.
  55
  56 .. option:: -K, --kstore
  57
  58     Use kstore as the osd objectstore backend.
  59
  60 .. option:: -l, --localhost
  61
  62     Use localhost instead of hostanme.
  63
  64 .. option:: -m ip[:port]
  65
  66     Specifies monitor *ip* address and *port*.
  67
  68 .. option:: --memstore
  69
  70     Use memstore as the objectstore backend for osds
  71
  72 .. option:: --multimds <count>
  73
  74     Allow multimds with maximum active count.
  75
  76 .. option:: -n, --new
  77
  78     Create a new cluster.
  79
  80 .. option:: -N, --not-new
  81
  82     Reuse existing cluster config (default).
  83
  84 .. option:: --nodaemon
  85
  86     Use ceph-run as wrapper for mon/osd/mds.
  87
  88 .. option:: --nolockdep
  89
  90     Disable lockdep
  91
  92 .. option:: -o <config>
  93
  94     Add *config* to all sections in the ceph configuration.
  95
  96 .. option:: --rgw_port <port>
  97
  98     Specify ceph rgw http listen port.
  99
 100 .. option:: --rgw_frontend <frontend>
 101
 102     Specify the rgw frontend configuration (default is civetweb).
 103
 104 .. option:: --rgw_compression <compression_type>
 105
 106     Specify the rgw compression plugin (default is disabled).
 107
 108 .. option:: --smallmds
 109
 110     Configure mds with small limit cache size.
 111
 112 .. option:: --short
 113
 114     Short object names only; necessary for ext4 dev
 115
 116 .. option:: --valgrind[_{osd,mds,mon}] 'valgrind_toolname [args...]'
 117
 118     Launch the osd/mds/mon/all the ceph binaries using valgrind with the specified tool and arguments.
 119
 120 .. option:: --without-dashboard
 121
 122     Do not run using mgr dashboard.
 123
 124 .. option:: -x
 125
 126     Enable cephx (on by default).
 127
 128 .. option:: -X
 129
 130     Disable cephx.
 131
 132
 133 Environment variables
 134 =====================
 135
 136 {OSD,MDS,MON,RGW}
 137
 138 Theses environment variables will contains the number of instances of the desired ceph process you want to start.
 139
 140 Example: ::
 141
 142         OSD=3 MON=3 RGW=1 vstart.sh
 143
 144
 145 ============================================================
 146  Deploying multiple development clusters on the same machine
 147 ============================================================
 148
 149 In order to bring up multiple ceph clusters on the same machine, *mstart.sh* a
 150 small wrapper around the above *vstart* can help.
 151
 152 Usage
 153 =====
 154
 155 To start multiple clusters, you would run mstart for each cluster you would want
 156 to deploy, and it will start monitors, rgws for each cluster on different ports
 157 allowing you to run multiple mons, rgws etc. on the same cluster. Invoke it in
 158 the following way::
 159
 160   mstart.sh <cluster-name> <vstart options>
 161
 162 For eg::
 163
 164   ./mstart.sh cluster1 -n
 165
 166
 167 For stopping the cluster, you do::
 168
 169   ./mstop.sh <cluster-name>