-
Notifications
You must be signed in to change notification settings - Fork 7
/
spec.json
492 lines (492 loc) · 12.6 KB
/
spec.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
{
"global_options": [
{
"long_name": "config-file",
"description": "Location of config file",
"default_value": [
""
],
"choices": null
},
{
"long_name": "session-file",
"description": "Location of session file",
"default_value": [
""
],
"choices": null
},
{
"long_name": "debug",
"description": "Show debug output",
"default_value": [
"false"
],
"choices": null
},
{
"long_name": "output",
"description": "Format of the output",
"default_value": [
"pretty"
],
"choices": [
"pretty",
"raw",
"json"
]
}
],
"commands": {
"dataset": {
"usage": "nerd dataset \u003csubcommand\u003e",
"synopsis": "Manage job datasets.",
"description": "Manage job datasets.",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": []
}
},
"dataset delete": {
"usage": "nerd dataset delete DATASET_NAME [DATASET_NAME...]",
"synopsis": "Remove a dataset from the cluster",
"description": "Remove a dataset from the cluster",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": [
{
"long_name": "all",
"short_name": "a",
"description": "delete all your datasets in one command",
"default_value": null,
"choices": null
}
]
}
},
"dataset download": {
"usage": "nerd dataset [OPTIONS] download DATASET_NAME DOWNLOAD_PATH",
"synopsis": "Download results from a running job",
"description": "Download results from a running job",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": [
{
"long_name": "input-of",
"description": "specify a job name where the datasets were used as its input. Dataset name is no longer mandatory.",
"default_value": null,
"choices": null
},
{
"long_name": "output-of",
"description": "specify a job name where the datasets were used as its output. Dataset name is no longer mandatory.",
"default_value": null,
"choices": null
}
]
}
},
"dataset list": {
"usage": "nerd dataset list [OPTIONS]",
"synopsis": "Return datasets that are managed by the cluster",
"description": "Return datasets that are managed by the cluster",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": []
}
},
"dataset upload": {
"usage": "nerd dataset upload [OPTIONS] DIR_TO_UPLOAD",
"synopsis": "Upload a dataset to your compute cluster.",
"description": "Upload a dataset to your compute cluster.",
"options": {
"Advanced Options": [
{
"long_name": "s3-bucket",
"description": "S3 Bucket name that will be used for dataset storage",
"default_value": [
"nlz-datasets-dev"
],
"choices": null
},
{
"long_name": "aws-region",
"description": "AWS region used for dataset storage",
"default_value": null,
"choices": null
},
{
"long_name": "s3-access-key",
"description": "access key used for auth with the storage backend",
"default_value": null,
"choices": null
},
{
"long_name": "s3-secret-key",
"description": "secret key for auth with the storage backend",
"default_value": null,
"choices": null
},
{
"long_name": "s3-session-token",
"description": "temporary auth token for the storage backend",
"default_value": null,
"choices": null
},
{
"long_name": "s3-prefix",
"description": "store this dataset under a specific prefix",
"default_value": null,
"choices": null
}
],
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": [
{
"long_name": "name",
"short_name": "n",
"description": "assign a name to the dataset",
"default_value": null,
"choices": null
}
]
}
},
"job": {
"usage": "nerd job \u003csubcommand\u003e",
"synopsis": "Manage the lifecycle of compute jobs.",
"description": "Manage the lifecycle of compute jobs.",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": []
}
},
"job delete": {
"usage": "nerd job delete JOB [JOB...]",
"synopsis": "Remove one or more job(s) from the cluster",
"description": "Remove one or more job(s) from the cluster",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": [
{
"long_name": "all",
"short_name": "a",
"description": "delete all your jobs in one command",
"default_value": null,
"choices": null
}
]
}
},
"job list": {
"usage": "nerd job list [OPTIONS]",
"synopsis": "Return jobs that are managed by the cluster",
"description": "Return jobs that are managed by the cluster",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": []
}
},
"job logs": {
"usage": "nerd job logs [OPTIONS] JOB",
"synopsis": "Return logs for a running job",
"description": "Return logs for a running job",
"options": {
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": [
{
"long_name": "tail",
"short_name": "t",
"description": "only return the oldest N lines of the process logs",
"default_value": null,
"choices": null
}
]
}
},
"job run": {
"usage": "nerd job run [OPTIONS] IMAGE [ARG...]",
"synopsis": "Runs a job on your compute cluster",
"description": "Runs a job on your compute cluster",
"options": {
"Advanced Options": [
{
"long_name": "s3-bucket",
"description": "S3 Bucket name that will be used for dataset storage",
"default_value": [
"nlz-datasets-dev"
],
"choices": null
},
{
"long_name": "aws-region",
"description": "AWS region used for dataset storage",
"default_value": null,
"choices": null
},
{
"long_name": "s3-access-key",
"description": "access key used for auth with the storage backend",
"default_value": null,
"choices": null
},
{
"long_name": "s3-secret-key",
"description": "secret key for auth with the storage backend",
"default_value": null,
"choices": null
},
{
"long_name": "s3-session-token",
"description": "temporary auth token for the storage backend",
"default_value": null,
"choices": null
},
{
"long_name": "s3-prefix",
"description": "store this dataset under a specific prefix",
"default_value": null,
"choices": null
}
],
"Global Options": [
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
},
{
"long_name": "timeout",
"description": "duration for which Nerd will wait for Kubernetes",
"default_value": [
"10s"
],
"choices": null
}
],
"Options": [
{
"long_name": "name",
"short_name": "n",
"description": "assign a name to the job",
"default_value": null,
"choices": null
},
{
"long_name": "env",
"short_name": "e",
"description": "environment variables to use",
"default_value": null,
"choices": null
},
{
"long_name": "memory",
"short_name": "m",
"description": "memory to use for this job, expressed in gigabytes",
"default_value": [
"3"
],
"choices": null
},
{
"long_name": "vcpu",
"description": "number of vcpus to use for this job",
"default_value": [
"2"
],
"choices": null
},
{
"long_name": "input",
"description": "specify one or more inputs that will be used for the job using the following format: \u003cDIR|DATASET_NAME\u003e:\u003cJOB_DIR\u003e",
"default_value": null,
"choices": null
},
{
"long_name": "output",
"description": "specify one or more output folders that will be stored as datasets after the job is finished using the following format: \u003cDATASET_NAME\u003e:\u003cJOB_DIR\u003e",
"default_value": null,
"choices": null
},
{
"long_name": "private",
"description": "use this flag with a private image, a prompt will ask for your username and password of the repository that stores the image. If NERD_IMAGE_USERNAME and/or NERD_IMAGE_PASSWORD environment variables are set, those values are used instead.",
"default_value": null,
"choices": null
},
{
"long_name": "clean-creds",
"description": "to be used with the '--private' flag, a prompt will ask again for your image repository username and password. If NERD_IMAGE_USERNAME and/or NERD_IMAGE_PASSWORD environment variables are provided, they will be used as values to update the secret.",
"default_value": null,
"choices": null
}
]
}
},
"login": {
"usage": "nerd login",
"synopsis": "Start a new authorized session.",
"description": "Start a new authorized session.",
"options": {
"Options": [
{
"long_name": "config-src",
"description": "type of configuration to use (from env, endpoint, or oidc)",
"default_value": [
"oidc"
],
"choices": null
},
{
"long_name": "kube-config",
"description": "file at which Nerd will look for Kubernetes credentials",
"default_value": null,
"choices": null
}
]
}
},
"version": {
"usage": "nerd version",
"synopsis": "Check the current version.",
"description": "Check the current version.",
"options": {}
}
}
}