instance-runner-input-schema.json 6.2 KB
Newer Older
1
{
Rafael Monnerat's avatar
Rafael Monnerat committed
2 3 4 5 6
    "$schema": "http://json-schema.org/draft-04/schema#",
    "properties": {
        "user-authorized-key": {
            "title": "User Authorized Key",
            "description": "SSH public key in order to connect to the SSH server of this runner instance.",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
7
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
8 9 10 11 12 13
        },
        "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,
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
14
            "maximum": 40
Rafael Monnerat's avatar
Rafael Monnerat committed
15 16 17 18
        },
        "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",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
19
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
20 21 22 23
        },
        "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)",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
24
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
25 26 27
        },
        "slapos-repository": {
            "title": "SlapOS Git Repository URL",
28
            "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)",
Rafael Monnerat's avatar
Rafael Monnerat committed
29 30
            "type": "string",
            "format": "uri",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
31
            "pattern": "^(http|https|ftp)://"
Rafael Monnerat's avatar
Rafael Monnerat committed
32 33 34 35
        },
        "slapos-reference": {
            "title": "SlapOS Git Branch Name",
            "description": "Branch or hash on which the default repository will checkout (default is master)",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
36
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
37 38 39 40
        },
        "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)",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
41
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
42 43 44 45
        },
        "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)",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
46
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
47 48 49 50
        },
        "slapos-software-type": {
            "title": "Deployed Instance Software Type" ,
            "description": "Software type of your instance inside the runner",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
51
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
52
        },
53 54 55 56 57 58 59 60 61 62 63
        "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
        },
        "instance-name": {
            "title": "Displayed instance name",
            "description": "Name of the instance, to show in the window title",
            "type": "string"
        },
Rafael Monnerat's avatar
Rafael Monnerat committed
64 65 66 67
        "custom-frontend-backend-url": {
            "title": "Custom Frontend Backend URL",
            "description": "return an ipv4 frontend of the given ipv6(+optional port)",
            "type": "string",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
68
            "format": "uri"
Rafael Monnerat's avatar
Rafael Monnerat committed
69 70 71 72 73
        },
        "custom-frontend-backend-type": {
            "title": "Custom Frontend Backend Type",
            "description": "The type of the frontend slave instance to ask",
            "type": "string",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
74
            "enum": ["zope"]
Rafael Monnerat's avatar
Rafael Monnerat committed
75 76 77 78
        },
        "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",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
79
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
80 81 82 83
        },
        "custom-frontend-instance-guid": {
            "title": "Custom Frontend Instance GUID",
            "description": "Instance guid of the frontend you whish to use",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
84
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
85 86 87 88 89
        },
        "custom-frontend-software-type": {
            "title": "Custom Frontend Software Type",
            "description": "SoftwareType of the frontend you request (default is RootSoftwareInstance)",
            "type": "string",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
90
            "enum": ["RootSoftwareInstance", "default"]
Rafael Monnerat's avatar
Rafael Monnerat committed
91 92 93
        },
        "custom-frontend-software-url": {
            "title": "Custom Frontend Software URL",
94
            "description": "Software Url of the frontend you request (ie.: http://git.erp5.org/gitweb/slapos.git/blob_plain/HEAD:/software/apache-frontend/software.cfg)",
Rafael Monnerat's avatar
Rafael Monnerat committed
95
            "type": "string",
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
96
            "format": "uri"
Rafael Monnerat's avatar
Rafael Monnerat committed
97
        },
98 99 100 101 102 103 104
        "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"
        },
Rafael Monnerat's avatar
Rafael Monnerat committed
105 106 107 108 109
        "monitor-port": {
            "title": "Monitor Port",
            "description": "Allow to manually change the port on wich the apache server running monitoring interface is listening. The default value for the webrunner is different from the default value of the standalone stack-monitor server (default 9684)",
            "type": "integer",
            "minimum": 9683,
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
110
            "exclusiveMinimum": true
Rafael Monnerat's avatar
Rafael Monnerat committed
111
        },
112 113 114 115
        "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",
116
            "format": "uri",
117
            "default": "https://monitor.app.officejs.com"
118 119 120 121 122
        },
        "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",
123
            "default": "monitor.app.officejs.com"
Rafael Monnerat's avatar
Rafael Monnerat committed
124
        }
Rafael Monnerat's avatar
Rafael Monnerat committed
125
    }
126
}