instance-runner-input-schema.json 6.99 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.",
7
            "textarea": true,
8
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
9 10 11 12 13 14
        },
        "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,
15
            "maximum": 40
Rafael Monnerat's avatar
Rafael Monnerat committed
16 17 18 19
        },
        "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",
20
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
21 22 23 24
        },
        "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)",
25
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
26 27 28
        },
        "slapos-repository": {
            "title": "SlapOS Git Repository URL",
29
            "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
30 31
            "type": "string",
            "format": "uri",
32
            "pattern": "^(http|https|ftp)://"
Rafael Monnerat's avatar
Rafael Monnerat committed
33 34 35 36
        },
        "slapos-reference": {
            "title": "SlapOS Git Branch Name",
            "description": "Branch or hash on which the default repository will checkout (default is master)",
37
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
38 39 40 41
        },
        "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)",
42
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
43 44 45 46
        },
        "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)",
47
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
48 49 50 51
        },
        "slapos-software-type": {
            "title": "Deployed Instance Software Type" ,
            "description": "Software type of your instance inside the runner",
52
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
53
        },
54 55 56 57 58 59 60 61 62 63 64
        "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
65 66 67 68
        "custom-frontend-backend-url": {
            "title": "Custom Frontend Backend URL",
            "description": "return an ipv4 frontend of the given ipv6(+optional port)",
            "type": "string",
69
            "format": "uri"
Rafael Monnerat's avatar
Rafael Monnerat committed
70 71 72 73 74
        },
        "custom-frontend-backend-type": {
            "title": "Custom Frontend Backend Type",
            "description": "The type of the frontend slave instance to ask",
            "type": "string",
75
            "enum": ["zope"]
Rafael Monnerat's avatar
Rafael Monnerat committed
76 77 78 79
        },
        "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",
80
            "type": "boolean"
Rafael Monnerat's avatar
Rafael Monnerat committed
81 82 83 84
        },
        "custom-frontend-instance-guid": {
            "title": "Custom Frontend Instance GUID",
            "description": "Instance guid of the frontend you whish to use",
85
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
86 87 88 89 90
        },
        "custom-frontend-software-type": {
            "title": "Custom Frontend Software Type",
            "description": "SoftwareType of the frontend you request (default is RootSoftwareInstance)",
            "type": "string",
91
            "enum": ["RootSoftwareInstance", "default"]
Rafael Monnerat's avatar
Rafael Monnerat committed
92 93 94
        },
        "custom-frontend-software-url": {
            "title": "Custom Frontend Software URL",
95
            "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
96
            "type": "string",
97
            "format": "uri"
Rafael Monnerat's avatar
Rafael Monnerat committed
98
        },
99 100 101 102 103 104 105
        "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
106 107 108 109 110
        "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,
111
            "exclusiveMinimum": true
Rafael Monnerat's avatar
Rafael Monnerat committed
112
        },
113 114 115 116
        "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",
117
            "format": "uri",
118
            "default": "https://monitor.app.officejs.com"
119 120 121 122 123
        },
        "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",
124
            "default": "monitor.app.officejs.com"
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
        },
        "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
        },
        "resilient-clone-number": {
            "title": "Number of Resilient Clones",
            "description": "Number of clones to be deployed when a resilient runner, if missing a single clone is provided. Its value can be 1 or 2",
            "type": "integer",
            "enum": [1, 2]
        },
        "instance-name": {
            "title": "Instance Name",
            "description": "Name of the instance, to show in the window title",
            "type": "string"
Rafael Monnerat's avatar
Rafael Monnerat committed
142
        }
Rafael Monnerat's avatar
Rafael Monnerat committed
143
    }
144
}