Skip to main content

Manifest version 05

What's new

  • warningCodes: Declares what non-zero exit codes will lead to a WARNING jobs state rather than a FAILED one.

Overview

Manifests of version io.batchx.manifest-05 are JSON documents containing for following information:

Field NameDescriptionRequired
nameImage name.true
versionImage version.true
titleShort description of the purpose of the image.true
readmeDetailed image documentation. Markdown supported.false
scmSource code repository URL.false
authorImage creator.true
schemaSection where image inputs and outputs must be defined.true
errorCodesError codes that might be returned. Keys must be integer numbers.false
warningCodesWarning codes that might be returned. Keys must be integer numbers.false
runtimeSection that defines the minimum resident set size (RSS) memory assigned to the container (in MB) and GPU usage.true
changeLogDescription of how this version improves the previous one.false

Definition

More precisely, io.batchx.manifest-05 manifests are JSON documents adhering to the following JSON schema:

JSON Schema for io.batchx.manifest-05
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"name",
"title",
"schema",
"author",
"version",
"runtime",
"changeLog"
],
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Image name",
"maxLength": 60
},
"version": {
"type": "string",
"description": "Semantic version of the image",
"maxLength": 15,
"pattern": "^\\d+\\.\\d+\\.\\d+$"
},
"title": {
"type": "string",
"description": "Short description of the purpose of the image",
"maxLength": 100
},
"readme": {
"type": "string",
"description": "Detailed image documentation. Markdown supported"
},
"changeLog": {
"type": "string",
"description": "Short description of what news this version brings, compared to the previous one",
"maxLength": 80
},
"schema": {
"type": "object",
"required": ["input", "output"],
"additionalProperties": false,
"properties": {
"input": {
"type": "object",
"description": "JSON-Schema of the input data",
"additionalProperties": true
},
"output": {
"type": "object",
"description": "JSON-Schema of the output data",
"additionalProperties": true
}
}
},
"errorCodes": {
"description": "Error codes that might be returned. Keys must be integer numbers",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"warningCodes": {
"description": "Warning return codes that might be returned. Keys must be integer numbers",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"author": {
"type": "string",
"description": "Individual or environment",
"maxLength": 40
},
"scm": {
"type": "string",
"description": "Source code repository URL",
"maxLength": 70
},
"runtime": {
"type": "object",
"required": ["minMem"],
"additionalProperties": false,
"properties": {
"gpus": {
"type": "string",
"description": "Indicates whether the image requires at least one gpu to run",
"enum": ["required", "supported"]
},
"minMem": {
"type": "integer",
"description": "Minimum RSS limit for the container (in MB)"
}
}
}
}
}