Blame view

software/slaprunner/instance-runner-input-schema.json 5.88 KB
Nicolas Wavrant committed
1
{
Jérome Perrin committed
2 3
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
Cédric Le Ninivin committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
    "instance-name": {
      "title": "Instance Name",
      "description": "Name of the instance, to show in the window title",
      "type": "string"
    },
    "custom-frontend-backend-url": {
      "title": "Custom Frontend Backend URL",
      "description": "return an ipv4 frontend of the given ipv6(+optional port)",
      "type": "string",
      "format": "uri"
    },
    "custom-frontend-backend-type": {
      "title": "Custom Frontend Backend Type",
      "description": "The type of the frontend slave instance to ask",
      "type": "string",
      "enum": [
        "zope"
      ]
    },
Jérome Perrin committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
    "user-authorized-key": {
      "title": "User Authorized Key",
      "description": "SSH public key in order to connect to the SSH server of this runner instance.",
      "textarea": true,
      "type": "string"
    },
    "instance-amount": {
      "title": "Partition Amount",
      "description": "Number of slappart to deploy inside the runner (default is 10). Needs instance to be restarted.",
      "type": "integer",
      "minimum": 1,
      "maximum": 40
    },
    "auto-deploy": {
      "title": "Automatically Deploy Software",
      "description": "Authorizes the software declared with 'slapos-software' to be automatically deployed, or not. Needs instance to be restarted. (default is false)",
      "type": "boolean"
    },
Cédric Le Ninivin committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
    "auto-deploy-instance": {
      "title": "Automatically Deploy Instances",
      "description": "Prevent the runner from deploying and starting instances. Needs instance to be restarted. It is set to false for instances of type 'import' in resiliency in any case (default is false)",
      "type": "boolean"
    },
    "autorun": {
      "title": "Automatically Run Sofware/Instance",
      "description": "Let automaticaly build and run a declared software with 'slapos-software'. Only works if 'slapos-software' is set, and 'auto-deploy' is true. Needs instance to be restarted. (default is false)",
      "type": "boolean"
    },
    "slapos-software": {
      "title": "Pre-selected Software Release",
      "description": "a relative path from the slapos git repo to a folder containing a software release, which will be automaticaly deployed while the runner instanciation, and only if the parameter auto-deploy is set to 'true'. For example: 'software/helloworld",
      "type": "string"
    },
Jérome Perrin committed
56 57 58 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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
    "slapos-repository": {
      "title": "SlapOS Git Repository URL",
      "description": "url of the default git repository that will be download by the runner while its instanciation. Will be cloned in a directory named 'slapos' (default is https://lab.nexedi.com/nexedi/slapos.git)",
      "type": "string",
      "format": "uri",
      "pattern": "^(http|https|ftp)://"
    },
    "slapos-reference": {
      "title": "SlapOS Git Branch Name",
      "description": "Branch or hash on which the default repository will checkout (default is master)",
      "type": "string"
    },
    "slapos-software-type": {
      "title": "Deployed Instance Software Type",
      "description": "Software type of your instance inside the runner",
      "type": "string"
    },
    "cpu-usage-ratio": {
      "title": "CPU Usage Ratio",
      "description": "Ratio of the CPU use for compilation, if value is set to n, compilation will use number-of-cpu/n of cpus (need instance restart)",
      "type": "integer",
      "default": 4
    },
    "no-ipv4-frontend": {
      "title": "No IPv4 frontend",
      "description": "Prevent the slaprunner to order an IPv4 frontend for itself",
      "enum": [
        "true",
        "false"
      ],
      "default": "false"
    },
    "custom-frontend-basic-auth": {
      "title": "Custom Frontend Basic Auth",
      "description": "if the ip given with 'custom-frontend-backend-url' is secure, set it to true for the promise do not fail",
      "type": "boolean"
    },
    "custom-frontend-instance-guid": {
      "title": "Custom Frontend Instance GUID",
      "description": "Instance guid of the frontend you whish to use",
      "type": "string"
    },
    "custom-frontend-software-type": {
      "title": "Custom Frontend Software Type",
      "description": "SoftwareType of the frontend you request (default is RootSoftwareInstance)",
      "type": "string",
      "enum": [
        "RootSoftwareInstance",
        "default"
      ]
    },
    "custom-frontend-software-url": {
      "title": "Custom Frontend Software URL",
      "description": "Software Url of the frontend you request (ie.: http://git.erp5.org/gitweb/slapos.git/blob_plain/HEAD:/software/apache-frontend/software.cfg)",
      "type": "string",
      "format": "uri"
    },
    "check-custom-frontend-promise": {
      "title": "Check Custom Frontend Promise",
      "description": "Enable a promise to check that HTTP frontend created from custom-frontend-backend-url is available",
      "type": "string",
      "enum": [
        "true",
        "false"
      ],
      "default": "false"
    },
Julien Muchembled committed
123 124 125 126 127 128 129
    "slaprunner-httpd-port": {
      "title": "Webrunner Server Port",
      "description": "Port of the Apache server serving the Webrunner interface.",
      "type": "integer",
      "default": 9686
    },
    "monitor-httpd-port": {
Jérome Perrin committed
130
      "title": "Monitor Port",
Julien Muchembled committed
131
      "description": "Port of the Apache server serving the monitoring interface.",
Jérome Perrin committed
132
      "type": "integer",
Julien Muchembled committed
133
      "default": 8386
Jérome Perrin committed
134 135 136 137 138 139 140 141 142 143 144 145 146
    },
    "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"
Rafael Monnerat committed
147
    }
Jérome Perrin committed
148
  }
Nicolas Wavrant committed
149
}