CI
0b591c6e40
Build pipeline: viash-hub.toolbox.check-resources-pmqch
Source commit: c27e41c13e
Source message: add better documentation
71 lines
2.7 KiB
JSON
71 lines
2.7 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"title": "check_resources",
|
|
"description": "Check for available resources on the system.\n\nThis component is only useful when working with persistent storage environments\nwhere all workflow steps execute on the same instance or share the same\nstorage volume. That is, running thus component on e.g. AWS Batch or\nother cloud-based systems will not work as expected, since each step\ncan run on a different instance and resources will not be shared.\n\nFor distributed environments, consider integrating resource checks directly\ninto the components that will actually consume the storage, rather than\nusing this standalone check.\n",
|
|
"type": "object",
|
|
"$defs": {
|
|
"inputs": {
|
|
"title": "Inputs",
|
|
"type": "object",
|
|
"description": "No description",
|
|
"properties": {
|
|
"tmp_space_required": {
|
|
"type": "integer",
|
|
"description": "Temporary space required in MB.",
|
|
"help_text": "Type: `integer`, multiple: `False`, default: `1000`. ",
|
|
"default": 1000
|
|
},
|
|
"publish_space_required": {
|
|
"type": "integer",
|
|
"description": "Publish space required in MB.",
|
|
"help_text": "Type: `integer`, multiple: `False`, default: `500`. ",
|
|
"default": 500
|
|
},
|
|
"publish_dir": {
|
|
"type": "string",
|
|
"format": "path",
|
|
"description": "Directory where workflow outputs will be published.",
|
|
"help_text": "Type: `file`, multiple: `False`, direction: `input`. "
|
|
}
|
|
}
|
|
},
|
|
"outputs": {
|
|
"title": "Outputs",
|
|
"type": "object",
|
|
"description": "No description",
|
|
"properties": {
|
|
"output": {
|
|
"type": "string",
|
|
"format": "path",
|
|
"description": "Output file containing system resources details.",
|
|
"help_text": "Type: `file`, multiple: `False`, default: `\"output.txt\"`, direction: `output`. ",
|
|
"default": "output.txt"
|
|
}
|
|
}
|
|
},
|
|
"nextflow input-output arguments": {
|
|
"title": "Nextflow input-output arguments",
|
|
"type": "object",
|
|
"description": "Input/output parameters for Nextflow itself. Please note that both publishDir and publish_dir are supported but at least one has to be configured.",
|
|
"properties": {
|
|
"publish_dir": {
|
|
"type": "string",
|
|
"description": "Path to an output directory.",
|
|
"help_text": "Type: `string`, multiple: `False`, required, example: `\"output/\"`. "
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/inputs"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/outputs"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/nextflow input-output arguments"
|
|
}
|
|
]
|
|
}
|