slaprunner: add configurable cpu-ratio parameter
[slapos.git] / software / neoppod / README.txt
1 Software types
2 ==============
3 Which software type is an entry point and can be used for root software
4 instance.
5
6 Parameters are expected to be passed as of *.serialised recipes expect them.
7 Minimal parameters::
8
9 ```
10 <?xml version='1.0' encoding='utf-8'?>
11 <instance>
12   <parameter id="_">{
13     "cluster": "dummy",
14   }</parameter>
15 </instance>
16 ```
17
18 For each available key in the outmost dict are described below.
19
20 default (default)
21 -----------------
22 Deploy a NEO cluster.
23
24 'cluster' (str, mandatory)
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~
26 Cluster unique identifier. Your last line of defense against mixing up neo
27 clusters and corrupting your data. Choose a unique value for each of your
28 cluster.
29
30 'partitions' (int, optional)
31 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 Number of partitions. You cannot change this value once you created a cluster.
33 Defautls to 12.
34
35 'replicas' (int, optional)
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~
37 Number of replicates.
38 Defaults to 0 (no resilience).
39
40 'mysql-storage-count' (int, optional)
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42 Number of MySQL-based storage nodes to deploy. One master node is deployed
43 along with each storage.
44 Defaults to 1.
45
46 'admin-count' (int, optional)
47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48 Number of admin nodes to deploy.
49 Defaults to 1.