Files
ray/python/ray/projects/schema.json
T
2020-04-16 18:08:17 -07:00

184 lines
4.9 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"name": {
"description": "The name of the project",
"type": "string"
},
"description": {
"description": "A short description of the project",
"type": "string"
},
"repo": {
"description": "The URL of the repo this project is part of",
"type": "string"
},
"documentation": {
"description": "Link to the documentation of this project",
"type": "string"
},
"tags": {
"description": "Relevant tags for this project",
"type": "array",
"items": {
"type": "string"
}
},
"cluster": {
"type": "object",
"properties": {
"config": {
"type": "string",
"description": "Path to a .yaml cluster configuration file (relative to the project root)"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"help": {
"type": "string"
},
"choices": {
"type": "array"
},
"default": {
},
"type": {
"type": "string",
"enum": [
"int",
"float",
"str"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": [
"config"
],
"additionalProperties": false
},
"environment": {
"description": "The environment that needs to be set up to run the project",
"type": "object",
"properties": {
"dockerimage": {
"description": "URL to a docker image that can be pulled to run the project in",
"type": "string"
},
"dockerfile": {
"description": "Path to a Dockerfile to set up an image the project can run in (relative to the project root)",
"type": "string"
},
"requirements": {
"description": "Path to a Python requirements.txt file to set up project dependencies (relative to the project root)",
"type": "string"
},
"shell": {
"description": "A sequence of shell commands to run to set up the project environment",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"commands": {
"type": "array",
"items": {
"description": "Possible commands to run to start a session",
"type": "object",
"properties": {
"name": {
"description": "Name of the command",
"type": "string"
},
"help": {
"description": "Help string for the command",
"type": "string"
},
"command": {
"description": "Shell command to run on the cluster",
"type": "string"
},
"params": {
"type": "array",
"items": {
"description": "Possible parameters in the command",
"type": "object",
"properties": {
"name": {
"description": "Name of the parameter",
"type": "string"
},
"help": {
"description": "Help string for the parameter",
"type": "string"
},
"choices": {
"description": "Possible values the parameter can take",
"type": "array"
},
"default": {
},
"type": {
"description": "Required type for the parameter",
"type": "string",
"enum": [
"int",
"float",
"str"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"config": {
"description": "Configuration options for the command",
"type": "object",
"properties": {
"tmux": {
"description": "If true, the command will be run inside of tmux",
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"command"
],
"additionalProperties": false
}
},
"output_files": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"cluster"
],
"additionalProperties": false
}