instance-repman-input-schema.json 15.1 KB
Newer Older
1
{
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "Input Parameters",
  "properties": {
    "slave-frontend": {
      "title": "Web frontend",
      "description": "Front end used to provide web access for internal services at the kvm.",
      "properties": {
        "slave-domain": {
          "title": "Slave frontend domain",
          "description": "Unique domain name for this slave frontend.",
          "type": "string",
          "default": ""
        },
        "instance-guid": {
          "title": "Main Frontend Instance ID",
          "description": "Unique identifier of the frontend instance, like \"SOFTINST-11031\".",
          "type": "string",
          "default": ""
        },
        "frontend-software-type": {
          "title": "Frontend Software Type",
          "description": "Type of the frontend instance, like \"frontend\".",
          "type": "string"
        },
        "frontend-software-url": {
          "title": "Frontend Software URL",
          "description": "Software Release URL of the frontend instance, like \"http://example.com/path/to/software.cfg\".",
          "type": "string",
          "format": "uri",
          "default": "http://git.erp5.org/gitweb/slapos.git/blob_plain/HEAD:/software/apache-frontend/software.cfg"
        }
      },
      "type": "object"
    },
    "computer-memory-percent-threshold": {
      "title": "Computer memory percent threshold.",
      "description": "Computer memory percent threshold.",
      "type": "integer",
      "default": 80
    },
    "monitor-interface-url": {
      "title": "Monitor Web Interface URL",
      "description": "Give Url of HTML web interface that will be used to render this monitor instance.",
      "type": "string",
      "format": "uri",
      "default": "https://monitor.app.officejs.com"
    },
    "monitor-cors-domains": {
      "title": "Monitor CORS domains",
      "description": "List of cors domains separated with space. Needed for ajax query on this monitor instance from a different domain.",
      "type": "string",
      "default": "monitor.app.officejs.com"
    },
    "mail-from": {
      "title": "Mail From",
      "description": "Mail From address",
      "type": "string",
      "default": ""
    },
    "mail-smtp-addr": {
      "title": "Mail SMTP address",
64
      "description": "Mail SMTP address. Default: localhost",
65
      "type": "string",
66 67 68 69 70 71 72
      "default": "localhost"
    },
    "mail-smtp-port": {
      "title": "Mail SMTP port",
      "description": "Mail SMTP port. Default: 25",
      "type": "integer",
      "default": "25"
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    },
    "mail-smtp-password": {
      "title": "Mail SMTP password",
      "description": "Mail SMTP password",
      "type": "string",
      "default": ""
    },
    "mail-smtp-user": {
      "title": "Mail SMTP User",
      "description": "Mail SMTP User",
      "type": "string",
      "default": ""
    },
    "mail-to": {
      "title": "Mail To",
      "description": "",
      "type": "string",
      "default": ""
    },
    "tags": {
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
      "title": "Provisioning db tag list",
      "description": "Provisioning db tags. Set one tag per line.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": [
        "gtidstrict",
        "bind",
        "pkg",
        "innodb",
        "noquerycache",
        "slow",
        "pfs",
        "linux",
        "readonly",
        "diskmonitor",
        "sqlerror",
        "compressbinlog",
        "bm4ci",
        "mroonga",
        "utctime",
        "readcommitted",
116 117
        "nohandshake",
        "ssl"
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
    },
    "http-session-lifetime": {
      "title": "Web Session life time in s",
      "description": "Web interface Session life time in seconds. Default 86400",
      "type": "integer",
      "default": 86400
    },
    "http-refresh-interval": {
      "title": "Web refresh interval in s",
      "description": "Web interface refresh interval in s. Default 4s.",
      "type": "integer",
      "default": 4
    },
    "autorejoin": {
      "title": "Automatic rejoin a failed master",
      "description": "Automatic rejoin a failed master (default true)",
      "type": "boolean",
      "default": true
    },
    "autoseed": {
      "title": "Automatic join a standalone node",
      "description": "Automatic join a standalone node",
      "type": "boolean",
      "default": true
    },
144 145 146 147 148 149
    "require-ssl": {
      "title": "Enable REQUIRE SSL for repman database users",
      "description": "Enable secure connection between repman and mariadb databases. This option is an initial value, used only when creating database users.",
      "type": "boolean",
      "default": false
    },
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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    "repman-cluster-dict": {
      "title": "Replication Manager clusters definition",
      "description": "Replication Manager clusters definition",
      "patternProperties": {
        ".*": {
          "properties": {
            "name": {
              "title": "Name of the cluster",
              "description": "Name of the cluster: Should not contains spaces or any special characters.",
              "type": "string",
              "default": ""
            },
            "database-amount": {
              "title": "Amount of databases for cluster",
              "description": "Database amount to deploy with this cluster. Minimal amount is 2 required to enable replication.",
              "type": "integer",
              "default": 2,
              "minimum": 2
            },
            "-sla-0-computer_guid": {
              "title": "Prefered Master Computer Guid",
              "description": "Computer Guid for prefered Master database.",
              "type": "string",
              "default": ""
            },
            "-sla-1-computer_guid": {
              "title": "Slave 1 Computer Guid",
              "description": "Computer Guid for the first slave database.",
              "type": "string",
              "default": ""
            },
            "-sla-2-computer_guid": {
              "title": "Slave 2 Computer Guid",
              "description": "Computer Guid for the second slave database.",
              "type": "string",
              "default": ""
            },
            "-sla-3-computer_guid": {
              "title": "Slave 3 Computer Guid",
              "description": "Computer Guid for the third slave database.",
              "type": "string",
              "default": ""
            },
            "-sla-4-computer_guid": {
              "title": "Slave 4 Computer Guid",
              "description": "Computer Guid for the fourth slave database.",
              "type": "string",
              "default": ""
            },
            "proxysql-user": {
              "title": "Proxysql username",
              "description": "Proxysql external user, default is 'external'.",
              "type": "string",
              "default": "external"
            },
            "proxy-tags": {
206
              "title": "Proxy tag list",
207
              "description": "playbook configuration tags. Default: [\"pkg\", \"masterslave\", \"linux\", \"noreadwritesplit\", \"ssl\"]",
208 209 210 211 212 213 214 215
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "pkg",
                "masterslave",
                "linux",
216 217
                "noreadwritesplit",
                "ssl"
218
              ]
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
            },
            "logical-backup-cron": {
              "title": "Mysqldump backup cron definition.",
              "description": "Logical backup cron expression represents a set of times, using cron format.",
              "type": "string",
              "default": "0 21 * * *"
            },
            "physical-backup-cron": {
              "title": "Mariabackup cron definition",
              "description": "Physical backup cron expression represents a set of times, using cron format.",
              "type": "string",
              "default": "0 1 * * *"
            },
            "proxy-cpu-cores": {
              "title": "Proxy Cpu cores",
              "description": "Proxy Cpu cores. Default: 2",
              "type": "integer",
              "default": 2,
              "minimum": 1
            },
            "proxy-memory": {
              "title": "Proxy Memory usage in giga bytes",
              "description": "Proxy Memory usage in giga bytes. Default: 1G",
              "type": "integer",
              "default": 1,
              "minimum": 1
            },
            "db-cpu-cores": {
              "title": "Database Cpu cores",
              "description": "Database Cpu cores. Default: 2",
              "type": "integer",
              "default": 2,
              "minimum": 1
            },
            "db-disk-iops": {
              "title": "Database Rnd IO/s",
              "description": "Rnd IO/s in seconds for micro service VM (default 300).",
              "type": "integer",
              "default": 300
            },
            "db-memory": {
              "title": "Database memory in M",
              "description": "Memory in M for micro service VM (default 256)",
              "type": "integer",
              "default": 256,
              "minimum": 256,
              "multipleOf": 256
            },
            "db-memory-shared-pct": {
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
              "title": "Percent memory list shared per buffer",
              "description": "Percent memory shared per buffer. Default: [\"threads:16\", \"innodb:60\", \"myisam:10\", \"aria:10\", \"rocksdb:1\", \"tokudb:1\", \"s3:1\", \"archive:1\", \"querycache:0\"]",
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "threads:16",
                "innodb:60",
                "myisam:10",
                "aria:10",
                "rocksdb:1",
                "tokudb:1",
                "s3:1",
                "archive:1",
                "querycache:0"
              ]
285 286 287
            },
            "db-memory-threaded-pct": {
              "title": "Percent memory allocted per threads",
288 289 290 291 292 293 294 295 296 297
              "description": "Percent memory allocted per threads. Default: [\"tmp:70\", \"join:20\", \"sort:10\"]",
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "tmp:70",
                "join:20",
                "sort:10"
              ]
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
            },
            "innodb-file-per-table": {
              "title": "enable Innodb file per table",
              "description": "enable Innodb file per table. Possible value: 0=disabled, 1=enabled",
              "type": "integer",
              "default": 1,
              "minimum": 0,
              "maximum": 1
            },
            "use-ipv6": {
              "title": "Mariadb server listen on IPv6",
              "description": "Listen on IPv6 instead of IPv4.",
              "type": "boolean",
              "default": true
            },
            "failover-mode": {
              "title": "Failover mode",
              "description": "Failover is manual or automatic (default \"manual\").",
              "type": "string",
              "default": "manual",
318 319 320 321
              "enum": [
                "manual",
                "automatic"
              ]
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
            },
            "failover-limit": {
              "title": "Failover amount limit",
              "description": "Failover is canceld if already failover this number of time (0: unlimited) (default 5).",
              "type": "integer",
              "default": 5
            },
            "failover-falsepositive-heartbeat": {
              "title": "Failover check slaves do not receive heartbeat",
              "description": "Failover checks that slaves do not receive heartbeat (default true).",
              "type": "boolean",
              "default": true
            },
            "failover-falsepositive-heartbeat-timeout": {
              "title": "Failover check slaves do not receive heartbeat timeout",
              "description": "Failover checks that slaves do not receive heartbeat detection timeout  (default 3).",
              "type": "integer",
              "default": 3
            },
            "failover-falsepositive-ping-counter": {
              "title": "Failover amount of ping failures",
              "description": "Failover after this number of ping failures (interval 1s) (default 5).",
              "type": "integer",
              "default": 5
            },
            "failover-max-slave-delay": {
              "title": "Failover election ignore slave with replication delay",
              "description": "Election ignore slave with replication delay over this time in sec (default 30).",
              "type": "integer",
              "default": 30
            },
            "failover-readonly-state": {
              "title": "Failover Switchover set slaves as read-only",
              "description": "Failover Switchover set slaves as read-only (default true).",
              "type": "boolean",
              "default": true
            },
            "failover-restart-unsafe": {
              "title": "Failover when cluster down if a slave is start first",
              "description": "Failover when cluster down if a slave is start first.",
              "type": "boolean",
              "default": false
            },
            "failover-time-limit": {
              "title": "Cancel failover if time in sec not passed after previous failover",
              "description": "Failover is canceled if timer in sec is not passed with previous failover (0: do not wait).",
              "type": "integer",
              "default": 0
            },
            "switchover-at-equal-gtid": {
              "title": "Switchover only when slaves are fully in sync",
              "description": "Switchover only when slaves are fully in sync.",
              "type": "boolean",
              "default": false
            },
            "switchover-slave-wait-catch": {
              "title": "Switchover wait for slave to catch with replication",
              "description": "Switchover wait for slave to catch with replication, not needed in GTID mode but enable to detect possible issues like witing on old master (default true).",
              "type": "boolean",
              "default": true
            },
            "switchover-wait-kill": {
              "title": "Switchover wait ms before killing threads on demoted master",
              "description": "Switchover wait this many milliseconds before killing threads on demoted master (default 5000).",
              "type": "integer",
              "default": 5000
            },
            "switchover-wait-trx": {
              "title": "Cancel switchover after timeout seconds if can't aquire FTWRL",
              "description": "Switchover is cancel after this timeout in second if can't aquire FTWRL (default 10).",
              "type": "integer",
              "default": 10
            },
            "switchover-wait-write-query": {
              "title": "Cancel switchover after timeout if a write query is running",
              "description": "Switchover is canceled if a write query is running for this time (default 10).",
              "type": "integer",
              "default": 10
            }
          },
          "type": "object"
        }
      },
      "type": "object"
    }
  }
408
}