instance-erp5-input-schema.json 8.01 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "extends": "./schema-definitions.json#",
  "description": "Parameters to instantiate ERP5",
  "additionalProperties": false,
  "properties": {
    "site-id": {
      "description": "ERP5Site object's id",
      "default": "erp5",
      "type": "string"
    },
    "timezone": {
      "description": "Main site's timezone",
      "default": "UTC",
      "type": "string"
    },
17 18 19 20
    "deadlock-debugger-password": {
      "description": "Password for /manage_debug_threads",
      "default": "random",
      "type": "string"
21
    },
22 23 24 25 26 27 28 29 30 31
    "inituser-login": {
      "description": "Login of the initial/rescue user",
      "default": "zope",
      "type": "string"
    },
    "inituser-password": {
      "description": "Password of the initial/rescue user",
      "default": "random",
      "type": "string"
    },
32 33 34 35
    "developer-list": {
      "description": "List of logins which should get the Developper role (required to modify portal_components' content)",
      "default": "inituser-login's value",
      "items": {
36
        "pattern": "/^\\S+$/",
37 38 39 40 41
        "type": "string"
      },
      "uniqueItems": true,
      "type": "array"
    },
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
    "hosts": {
      "description": "Host entries to be used in addition to and/or overriding auto-generated ones",
      "default": {
        "erp5-catalog-0": "some-ip",
        "erp5-catalog-...": "some-ip",
        "erp5-cloudooo": "some-ip",
        "erp5-memcached-persistent": "some-ip",
        "erp5-memcached-volatile": "some-ip"
      },
      "patternProperties": {
        ".*": {
          "description": "An IP to which current entry will resolve",
          "type": "string"
        }
      },
      "type": "object"
    },
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
    "frontend": {
      "description": "Front-end slave instance request parameters",
      "properties": {
        "software-url": {
          "description": "Front-end's software type. If this parameter is the empty string, no front-end instance is requested.",
          "default": "",
          "type": "string"
        },
        "domain": {
          "description": "The domain name to request front-end to respond as.",
          "default": "",
          "type": "string"
        },
        "software-type": {
          "description": "Request a front-end slave instance of this software type.",
          "default": "RootSoftwareInstance",
          "type": ""
        },
        "instance-guid": {
          "description": "GUID of computer instance must be requested on. Mandatory if software-url is a non-empty string.",
          "type": "string"
        }
      },
      "type": "object"
    },
84 85 86 87 88 89 90
    "zope-partition-dict": {
      "description": "Zope layout definition",
      "patternProperties": {
        ".*": {
          "additionalProperties": false,
          "properties": {
            "family": {
91
              "description": "The family this partition is part of. For example: 'public', 'admin', 'backoffice', 'web-service'... Each family gets its own balancer entry. It has no special meaning for the system.",
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
              "default": "default",
              "type": "string"
            },
            "instance-count": {
              "description": "Number of Zopes to setup on this partition",
              "default": 1,
              "type": "integer"
            },
            "thread-amount": {
              "description": "Number of worker threads for each created Zope process",
              "default": 1,
              "type": "integer"
            },
            "timerserver-interval": {
              "description": "Timerserver tick perdiod, in seconds, or 0 to disable",
              "default": 5,
              "type": "integer"
            },
110 111 112 113 114
            "webdav": {
              "description": "Serve webdav queries, implies timerserver-interval=0 (disabled). Mixing webdav and non-webdav nodes in a single family will give unspecified results.",
              "default": false,
              "type": "boolean"
            },
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
            "longrequest-logger-interval": {
              "description": "Period, in seconds, with which LongRequestLogger polls worker thread stack traces, or -1 to disable",
              "default": -1,
              "type": "integer"
            },
            "longrequest-logger-timeout": {
              "description": "Transaction duration after which LongRequestLogger will start logging its stack trace, in seconds",
              "default": 1,
              "type": "integer"
            },
            "port-base": {
              "allOf": [{
                "$ref": "#/definitions/tcpv4port"
              }, {
                "description": "Start allocating ports at this value. Useful if one needs to make several partitions share the same port range (ie, several partitions bound to a single address)",
                "default": 2200
              }]
            },
            "computer-guid": {
              "description": "GUID of computer instance must be requested on",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    },
    "kumofs-computer-guid": {
      "description": "GUID of computer instance must be requested on",
      "type": "string"
    },
    "kumofs": {
      "description": "Persistent memcached service",
      "additionalProperties": {
        "$ref": "./instance-kumofs-input-schema.json#properties"
      },
      "type": "object"
    },
    "memcached-computer-guid": {
      "description": "GUID of computer instance must be requested on",
      "type": "string"
    },
    "memcached": {
      "description": "Volatile memcached service",
      "additionalProperties": {
        "$ref": "./instance-kumofs-input-schema.json#properties"
      },
      "type": "object"
    },
    "cloudooo-computer-guid": {
      "description": "GUID of computer instance must be requested on",
      "type": "string"
    },
    "cloudooo": {
      "description": "Format conversion service",
      "additionalProperties": {
        "$ref": "./instance-cloudooo-input-schema.json#properties"
      },
      "type": "object"
    },
    "mariadb-computer-guid": {
      "description": "GUID of computer instance must be requested on",
      "type": "string"
    },
    "mariadb": {
      "description": "Relational database service",
      "additionalProperties": {
        "$ref": "./instance-mariadb-input-schema.json#properties"
      },
      "type": "object"
    },
187 188 189 190
    "zodb-computer-guid": {
      "description": "GUID of computer instance must be requested on",
      "type": "string"
    },
191 192
    "zodb-software-type": {
      "description": "Zope Object DataBase implementation",
193
      "enum": ["zeo"],
194 195 196 197 198 199 200
      "type": "string"
    },
    "zodb": {
      "description": "Zope Object DataBase service",
      "oneOf": [
        {"$ref": "./instance-zeo-input-schema.json#properties"}
      ]
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    },
    "zodb-extern": {
      "description": "External ZODB Mountpoints. See https://github.com/zopefoundation/ZODB/blob/3.10/src/ZODB/component.xml for extra options.",
      "minItems": 0,
      "items": {
        "required": ["storage_dict"],
        "properties": {
          "name": {
            "description": "Database name",
            "default": "main",
            "type": "string"
          },
          "mount_point": {
            "description": "Mount point",
            "default": "/",
            "type": "string"
          },
          "storage-type": {
            "description": "Storage type",
            "default": "NEOStorage",
            "type": "string"
          },
          "storage-dict": {
            "description": "Storage configuration. For NEOStorage, 'logfile' is automatically set (see http://git.erp5.org/gitweb/neoppod.git/blob/HEAD:/neo/client/component.xml for other settings).",
            "patternProperties": {
              ".": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "patternProperties": {
            ".": {
              "type": "string"
            }
          }
        },
        "type": "object"
      },
      "type": "array"
241 242 243
    }
  }
}