-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathconfig.json
290 lines (290 loc) · 12.3 KB
/
config.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
{
"$id": "https://www.eosc-life.eu/d7/WfExS-backend/Config",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "WfExS-backend config",
"description": "WfExS-backend configuration file (EOSC-Life Demonstrator 7 JSON Schemas)",
"type": "object",
"properties": {
"cacheDir": {
"title": "Caching directory",
"description": "Directory where all the cache-able content will be hold.\nThis directory can be removed, as its contents should be available outside.\nWhen it is not set, a temporary directory is created for the session, being destroyed when the program finishes.",
"type": "string",
"minLength": 1
},
"crypt4gh": {
"title": "Installation Crypt4GH key setup",
"description": "WfExS-backend needs an encryption key for several tasks, like encrypting and decrypting random keys of encrypted working directories. When this block does not exist, WfExS-backend.py creates the installation's keys, and updates the configuration file",
"type": "object",
"properties": {
"key": {
"title": "Secret key installation file",
"description": "The path to the Crypt4GH secret key file used by this installation. If the path is relative, the directory where the configuration file resides is used for the resolution",
"type": "string",
"minLength": 1
},
"passphrase": {
"title": "Passphrase used to work with the secret key",
"description": "Passphrase which has to be used to work with the secret key",
"type": "string",
"minLength": 0
},
"pub": {
"title": "Public key installation file",
"description": "The path to the Crypt4GH public key file used by this installation. If the path is relative, the directory where the configuration file resides is used for the resolution",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"key",
"pub",
"passphrase"
]
},
"tools": {
"title": "External tools configuration block",
"description": "External tools configuration block",
"type": "object",
"properties": {
"containerType": {
"title": "Default container technology type in this installation",
"description": "Type of container technology to be used by default when any workflow is launched using this installation. Supported types are:\n- Singularity (default).\n- Docker.\n- Podman\n- No containerisation technology (discouraged)\nEncrypted working directories are unsupported when Docker or Podman are used due technological limitations",
"type": "string",
"enum": [
"singularity",
"docker",
"podman",
"none"
],
"default": "singularity"
},
"engineMode": {
"title": "Workflow engine invocation mode",
"description": "Most of workflow engines are usually available both as installable executables and as containers, but when they are used inside a container usually do not support running containerised jobs, unless a very careful setup is done. Currently, WfExS-backend only partially supports Nextflow in its docker-in-docker mode.",
"enum": [
"local",
"docker"
],
"default": "local"
},
"encrypted_fs": {
"title": "Working directory FUSE encrypted FS configuration block",
"description": "",
"type": "object",
"properties": {
"type": {
"title": "Type of encrypted FS",
"description": "When an encrypted working directory is needed, the type of encrypted FS to be used is set up through this key. Currently, both encfs (default) and gocryptfs (recommended) are supported",
"type": "string",
"enum": [
"encfs",
"gocryptfs"
],
"default": "gocryptfs"
},
"command": {
"title": "Path to encryption mount program",
"description": "When this key is set, it overrides the default command to be used when an encrypted directory has to be created or mounted",
"type": "string"
},
"fusermount_command": {
"title": "Path to unmount command",
"description": "Path to unmounting command to be used, being 'fusermount' by default",
"type": "string",
"default": "fusermount"
},
"idle": {
"title": "Idle minutes before autoumount",
"description": "Number of minutes before an idle, mounted encrypted directory will automatically unmount",
"type": "integer",
"default": 5
}
},
"additionalProperties": false
},
"commands": {
"title": "Custom command paths",
"description": "Different modules depend on locatable programs, like git, docker, java or similar. These declarations are used to provide WfExS either custom paths or custom names. These declarations take precedence over `gitCommand`, `javaCommand` and similar ones",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"key": {
"title": "The command key",
"description": "Internal symbolic name used to represent this command",
"type": "string"
},
"path": {
"title": "The command path",
"description": "Either the absolute path or PATH findable program name",
"type": "string",
"minLength": 1
}
},
"required": [
"key",
"path"
]
},
"uniqueItems": true
},
"gitCommand": {
"title": "Git client path",
"description": "Git is used to materialize workflows being hosted at git repositories, like GitHub. This key sets up custom paths to git command",
"type": "string",
"default": "git"
},
"javaCommand": {
"title": "Java path",
"description": "Java is needed to run Nextflow and future workflow engines. This key sets up custom paths to java installations",
"type": "string",
"default": "java"
},
"singularityCommand": {
"title": "Singularity client path",
"description": "Singularity is used when containerType is 'singularity'. This key sets up custom paths to singularity command",
"type": "string",
"default": "singularity"
},
"dockerCommand": {
"title": "Docker client path",
"description": "Docker is used when containerType is 'docker'. This key sets up custom paths to docker command",
"type": "string",
"default": "docker"
},
"podmanCommand": {
"title": "Podman client path",
"description": "Podman is used when containerType is 'podman'. This key sets up custom paths to podman command",
"type": "string",
"default": "podman"
},
"dotCommand": {
"title": "'dot' client path",
"description": "'dot' is used when the workflow engine generated diagram is in DOT format, to translate it to either PNG or SVG when the diagram is going to be embedded in an RO-Crate",
"type": "string",
"default": "dot"
},
"staticBashCommand": {
"title": "Static bash command (used in singularity based Nextflow engine executions)",
"description": "There is a bug in some bash versions which make them unsuitable to run the trace machinery from Nextflow, as the trace machinery enters in a live lock. As the images containing these faulty bash versions cannot be changed, a 'monkey patch' solution where an external, static bash version is injected on workflow execution is used. The injected static bash is found through this key, which is searched on PATH variable when it is not a full path.",
"type": "string",
"default": "bash.static"
},
"staticPsCommand": {
"title": "Static ps command (used in Nextflow engine executions to assure metrics gathering works even in containers without /bin/ps command)",
"description": "Nextflow uses a bash wrapper to gather process execution statistics. One of the binaries used by the wrapper is `ps`. Some containers (for instance, r-base:latest) do not contain such binary. As the images which do not contain `ps` cannot be changed, a 'monkey patch' solution where an external, static ps version is injected on workflow execution is used. The injected static ps is found through this key, which is searched on PATH variable when it is not a full path.",
"type": "string",
"default": "ps.static"
},
"nextflow": {
"type": "object",
"properties": {
"dockerImage": {
"title": "Image for docker-in-docker mode",
"description": "(unfinished) When `engineMode` is `docker`, the name of the image to be fetched and used. The used tag will depend on the workflow's metadata, being by default the `version`",
"type": "string",
"default": "nextflow/nextflow"
},
"version": {
"title": "Nextflow's version",
"description": "Version of Nextflow engine to be used when workflow's metadata does not provide hints about minimal version needed.",
"type": "string",
"default": "19.04.1"
},
"maxRetries": {
"title": "Retries in docker mode",
"description": "Retries when `engineMode` is `docker`.\nRetries system was introduced when using docker-in-docker pattern because an insidious\nbug happens sometimes. See https://forums.docker.com/t/any-known-problems-with-symlinks-on-bind-mounts/32138",
"type": "integer",
"minimum": 0,
"default": 5
},
"maxProcesses": {
"title": "(deprecated) Max number of CPUs",
"description": "Number of CPUs to be used by Nextflow. When this key has an explicit value of `null`, it depends on Nextflow criteria, which tries creating as many processes as available CPUs, spawning jobs in parallel. Not declaring it, or declaring and explicit value, imposes a limitation in the number of concurrent processes",
"oneOf": [
{
"type": "integer",
"minimum": 1,
"default": 4
},
{
"type": "null"
}
]
},
"maxCPUs": {
"title": "Max number of CPUs",
"description": "Number of CPUs to be used by Nextflow. When this key has an explicit value of `null`, it depends on Nextflow criteria, which tries creating as many processes as available CPUs, spawning jobs in parallel. Not declaring it, or declaring and explicit value, imposes a limitation in the number of concurrent processes",
"oneOf": [
{
"type": "integer",
"minimum": 1,
"default": 4
},
{
"type": "null"
}
]
},
"maxTaskDuration": {
"title": "Max task duration",
"description": "With this parameter it is possible to override the max task time declared for processes. This is needed for workflows which are not so customizable",
"oneOf": [
{
"type": "string",
"pattern": "^[0-9]+.*$"
},
{
"type": "null"
}
]
}
}
},
"cwl": {
"type": "object",
"properties": {
"version": {
"title": "cwltool's version",
"description": "Version of cwltool engine to be used. WfExS is not currently guessing the minimal needed version, so it is either the value set up in this key or the default one",
"type": "string",
"minLength": 1,
"default": "3.1.20210628163208"
}
}
}
},
"patternProperties": {
"^.+Command$": {
"title": "Path to a command",
"description": "This is a wildcard declaration to allow setting up custom paths to commands needed by several parts of the code",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"workDir": {
"title": "Working directory",
"description": "Directory where all the working directories are going to be created.\nWhen it is not set, a temporary directory is created, which will be removed when the program finishes (which avoids inspecting the working directory after the program has finished).",
"type": "string",
"minLength": 1
},
"fetchers-setup": {
"title": "Fetchers parameters setup",
"description": "Some fetchers could need customizations at the configuration level, like limiting throughput or setting up some proxy",
"type": "object",
"patternProperties": {
"^[a-z][a-z0-9+.-]*$": {
"title": "Scheme fetcher setup",
"description": "Some scheme fetchers could need customizations which depend on local WfExS installation environment. This is the place where to pass that",
"type": "object"
}
},
"minProperties": 1
}
},
"additionalProperties": false
}