NEO: missing/fixed JSON parameters, removed README (redundant with JSON schema)

software/neoppod/README.txt

-Software types
-==============
-Which software type is an entry point and can be used for root software
-instance.
-
-Parameters are expected to be passed as of *.serialised recipes expect them.
-Minimal parameters::
-
-```
-<?xml version='1.0' encoding='utf-8'?>
-<instance>
-  <parameter id="_">{
-    "cluster": "dummy",
-  }</parameter>
-</instance>
-```
-
-For each available key in the outmost dict are described below.
-
-default (default)
------------------
-Deploy a NEO cluster.
-
-'cluster' (str, mandatory)
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-Cluster unique identifier. Your last line of defense against mixing up neo
-clusters and corrupting your data. Choose a unique value for each of your
-cluster.
-
-'partitions' (int, optional)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Number of partitions. You cannot change this value once you created a cluster.
-Defaults to 12.
-
-'replicas' (int, optional)
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-Number of replicates.
-Defaults to 0 (no resilience).
-
-'node-list' (list, optional)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-List of dictionaries. Defaults to list containing one empty dictionary.
-One can specify following parameters in each of the dictionary.
-
-* 'storage-count': Number of storage nodes to deploy. Defaults to 1.
-  One master and one admin node is deployed with each storage.
-
-* 'mysql': Dictionary containing configuration options for MySQL.
-
-* 'engine': Configures storage engine,
-  currently only InnoDB and TokuDB are supported.

software/neoppod/instance-neo-schema.json → software/neoppod/instance-neo-input-schema.json

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "extends": "./schema-definitions.json#",
-  "description": "Parameters to instantiate neo",
+  "description": "Parameters to instantiate a NEO cluster. See https://git.erp5.org/gitweb/neoppod.git/blob/HEAD:/neo.conf?js=1 for more information.",
   "additionalProperties": false,
   "required": ["cluster"],
   "properties": {
     "cluster": {
-      "description": "Cluster unique identifier. Your last line of defense against mixing up neo clusters and corrupting your data. Choose a unique value for each of your cluster.",
+      "description": "Cluster unique identifier. Your last line of defense against mixing up NEO clusters and corrupting your data. Choose a unique value for each of your cluster.",
       "type": "string"
     },
     "partitions": {
@@ -19,6 +19,14 @@
       "default": 0,
       "type": "integer"
     },
+    "upstream-cluster": {
+      "description": "Identifier of the cluster to backup.",
+      "type": "string"
+    },
+    "upstream-masters": {
+      "description": "Master nodes in the cluster to backup.",
+      "type": "string"
+    },
     "sla-dict": {
       "description": "Where to request instances. Each key is a query string for criterions (e.g. \"computer_guid=foo\"), and each value is a list of partition references.",
       "patternProperties": {
@@ -32,36 +40,36 @@
     },
     "node-list": {
       "description": "List of dictionaries containing parameters for each node.",
-      "default": [],
       "items": {
         "description": "Dictionary containing parameters required to configure individual nodes.",
         "default": {},
-        "patternProperties": {
-          ".*": {
-            "additionalProperties": false,
+        "properties": {
+          "storage-count": {
+            "description": "Number of storage nodes to deploy. One master and one admin node is deployed with each storage.",
+            "default": 1,
+            "type": "integer"
+          },
+          "mysql": {
+            "description": "Dictionary containing parameters for MySQL.",
+            "default": {},
             "properties": {
-              "storage-count": {
-                "description": "Number of storage nodes to deploy. One master and one admin node is deployed with each storage.",
-                "default": 1,
-                "type": "integer"
-              },
-              "mysql": {
-                "description": "Dictionary containing parameters for MySQL.",
-                "default": {},
-                "patternProperties": {
-                  ".*": {
-                    "description": "To configure important parameters like innodb_buffer_pool_size, innodb-log-buffer-size, etc.",
-                    "type": "string"
-                  }
-                },
-                "type": "object"
-              },
-              "engine": {
-                "description": "Configures storage engine, currently only InnoDB and TokuDB are supported.",
-                "default": "innodb",
+              "relaxed-writes": {
+                "description": "When enabled, sets innodb_flush_log_at_trx_commit = 0, innodb_flush_method = nosync, innodb_doublewrite = 0 and sync_frm = 0 - RTFM, those options are dangerous",
+                "default": false,
+                "type": "boolean"
+              }
+            },
+            "patternProperties": {
+              ".": {
+                "description": "To configure important parameters like innodb_buffer_pool_size, tokudb_cache_size, etc.",
                 "type": "string"
               }
-            }
+            },
+            "type": "object"
+          },
+          "engine": {
+            "description": "Configures storage engine, currently only InnoDB and TokuDB are supported. Defaults to NEO's default.",
+            "type": "string"
           }
         }
       },

software/neoppod/instance-neo-output-schema.json

+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Values returned by NEO instantiation",
+  "properties": {
+    "masters": {
+      "description": "Connection parameters of all the master nodes",
+      "type": "string"
+    },
+    "admins": {
+      "description": "Connection parameters of all the admin nodes",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}