-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yml
1034 lines (1023 loc) · 28.2 KB
/
openapi.yml
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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Covey API
version: v0.1
description: Orchestration and management engine.
servers:
- url: 'http://{host}:{port}/api/v1'
variables:
host:
description: Address of the Covey server.
default: localhost
port:
description: Port Covey is listening on.
default: '8080'
paths:
/nodes:
summary: Group of nodes (and adding to it).
post:
summary: Add a new Node.
description: >
Running this will SSH into the specified server (`{ip}:{port}`), using
the specified credentials. Covey will then proceed to install and start
the agent onto the server.
operationId: newNode
requestBody:
description: The information about the node to add.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Node'
examples:
newNode:
$ref: '#/components/examples/newNode'
responses:
'200':
$ref: '#/components/responses/node'
'401':
$ref: '#/components/responses/unauth'
'409':
description: A node with the specifed name exsists.
tags:
- nodes
get:
summary: Get a list of all node names.
description: ''
operationId: getNodes
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/sortby'
- $ref: '#/components/parameters/expand'
responses:
'200':
description: Successfully retrieved nodes.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Array'
- type: array
items:
$ref: '#/components/schemas/Node'
examples:
expandIsFalse:
value:
- node1
- node2
expandIsTrue:
$ref: '#/components/examples/getNodes'
'401':
$ref: '#/components/responses/unauth'
tags:
- nodes
'/nodes/{nodeID}':
summary: Get the information of an individual node.
parameters:
- in: path
name: nodeID
schema:
type: string
required: true
description: 'ID, short ID or name of the node to get.'
get:
summary: Get a node.
description: ''
operationId: getNode
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Node'
examples:
getNode:
$ref: '#/components/examples/getNode'
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such node exists.
tags:
- nodes
delete:
summary: Delete a node.
description: ''
operationId: deleteNode
parameters:
- in: path
name: nodeId
schema:
type: string
required: true
description: 'ID, short ID or name of the node to delete.'
responses:
'200':
description: Successfully deleted node.
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such node exists.
tags:
- nodes
/tasks:
summary: Running things on nodes.
post:
summary: Add and run a new task.
description: ''
operationId: newTask
requestBody:
description: The task to run.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
examples:
newTask:
$ref: '#/components/examples/newTask'
responses:
'200':
$ref: '#/components/responses/task'
'401':
$ref: '#/components/responses/unauth'
tags:
- tasks
get:
summary: Get a list of all tasks.
operationId: getTasks
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/sortby'
- $ref: '#/components/parameters/expand'
responses:
'200':
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Array'
- type: array
items:
$ref: '#/components/schemas/Task'
examples:
expandIsFalse:
value:
- a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
- e258d248fda94c63753607f7c4494ee0fcbe92f1a76bfdac795c9d84101eb317
expandIsTrue:
$ref: '#/components/examples/getTasks'
'401':
$ref: '#/components/responses/unauth'
tags:
- tasks
'/tasks/{taskID}':
summary: Get the information of an individual task.
parameters:
- in: path
name: taskID
schema:
type: string
required: true
description: 'ID or short ID of the task to get.'
get:
summary: Get a task.
description: ''
operationId: getTask
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
examples:
getNode:
$ref: '#/components/examples/getTask'
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such task exists.
tags:
- tasks
/jobs:
description: All the jobs.
post:
summary: Add a job.
operationId: newJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
examples:
newJob:
$ref: '#/components/examples/newJob'
responses:
'200':
$ref: '#/components/responses/job'
'401':
$ref: '#/components/responses/unauth'
'409':
description: A job with the specifed name exsists.
tags:
- jobs
get:
summary: List of all jobs (name).
operationId: getJobs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/sortby'
- $ref: '#/components/parameters/expand'
responses:
'200':
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Array'
- type: array
items:
$ref: '#/components/schemas/Job'
examples:
expandIsFalse:
value:
- update
- backup
expandIsTrue:
$ref: '#/components/examples/getJobs'
tags:
- jobs
'/jobs/{jobID}':
summary: Get the information of an individual job.
parameters:
- in: path
name: jobID
schema:
type: string
required: true
description: 'ID, short ID or name of the job.'
get:
summary: Get a job.
description: ''
operationId: getJob
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
examples:
getNode:
$ref: '#/components/examples/getJob'
links:
GetTaskFromJobHistory:
$ref: '#/components/links/GetTaskFromJobHistory'
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such job exists.
tags:
- jobs
put:
summary: Update the job configuration.
operationId: updateJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
examples:
newJob:
$ref: '#/components/examples/newJob'
responses:
'200':
$ref: '#/components/responses/job'
'401':
$ref: '#/components/responses/unauth'
tags:
- jobs
post:
summary: Run the job.
operationId: runJob
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Array'
example:
- a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
- e258d248fda94c63753607f7c4494ee0fcbe92f1a76bfdac795c9d84101eb317
links:
GetTaskFromJob:
$ref: '#/components/links/GetTaskFromJob'
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such job exists.
tags:
- jobs
delete:
summary: Delete a job.
description: ''
operationId: deleteJob
responses:
'200':
description: Successfully deleted job.
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such job exists.
tags:
- jobs
/plugins:
description: All the plugins.
get:
summary: List of all plugins (name).
operationId: getPlugins
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
# - $ref: '#/components/parameters/sort'
# - $ref: '#/components/parameters/sortby'
- $ref: '#/components/parameters/expand'
responses:
'200':
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Array'
- type: array
items:
$ref: '#/components/schemas/Plugin'
examples:
expandIsFalse:
value:
- shell
- docker
expandIsTrue:
$ref: '#/components/examples/getPlugins'
'401':
$ref: '#/components/responses/unauth'
tags:
- plugins
'/plugins/{pluginName}':
summary: Get the information of an individual plugin.
parameters:
- in: path
name: pluginName
schema:
type: string
required: true
description: 'The name of the plugin.'
get:
summary: Get a plugin.
description: ''
operationId: getPlugin
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Plugin'
examples:
getPlugin:
$ref: '#/components/examples/getPlugin'
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such plugin exists.
tags:
- plugins
'/plugins/{pluginName}/inputs':
summary: Get the inputs for a given plugin.
parameters:
- in: path
name: pluginName
schema:
type: string
required: true
description: 'Name of the plugin.'
- in: query
name: node
schema:
type: string
description: The node to retrive the inputs for. If empty, it will return generalized inputs for use in a job task.
get:
summary: Get the plugin inputs.
operationId: getPluginInputs
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Input'
examples:
getInputs:
$ref: '#/components/examples/getInputs'
'401':
$ref: '#/components/responses/unauth'
'404':
description: No such plugin exists.
tags:
- plugins
components:
examples:
getNode:
value:
name: node1
id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
ip: 192.168.1.100
port: '22'
username: root
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
getNodes:
value:
- name: node1
id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
ip: 192.168.1.100
port: '22'
username: root
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
- name: node2
id: e258d248fda94c63753607f7c4494ee0fcbe92f1a76bfdac795c9d84101eb31
ip: 192.168.1.101
port: '22'
username: root
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
newNode:
value:
name: node1
ip: 192.168.1.100
port: '22'
username: root
password: root
newTask:
value:
plugin: shell
node: node1
details:
command: echo hello world
getTasks:
value:
- id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
state: 0
exit_code: 0
plugin: shell
node: node1
details:
command: echo hello && echo world
log:
- 'hello'
- 'world'
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
- id: e258d248fda94c63753607f7c4494ee0fcbe92f1a76bfdac795c9d84101eb317
state: 0
exit_code: 0
plugin: shell
node: node1
details:
command: echo hello && echo world
log:
- hello world
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-30T23:39:10.071485063-07:00'
getTask:
value:
id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
state: 0
exit_code: 0
plugin: shell
node: node1
details:
command: echo hello && echo world
log:
- 'hello'
- 'world'
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
newJob:
value:
name: update
nodes:
- node1
- node2
cron: '0 0 1 1 *'
tasks:
update:
plugin: shell
details:
command: apt-get update
upgrade:
plugin: shell
details:
command: apt-get upgrade -y
getNewJob:
value:
id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
name: update
nodes:
- node1
- node2
cron: '0 0 1 1 *'
tasks:
update:
plugin: shell
details:
command: apt-get update
upgrade:
plugin: shell
details:
command: apt-get upgrade -y
getJob:
value:
id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
name: update
nodes:
- node1
- node2
cron: '0 0 1 1 *'
tasks:
update:
plugin: shell
details:
command: apt-get update
upgrade:
plugin: shell
details:
command: apt-get upgrade -y
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
getJobs:
value:
- id: a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447
name: update
nodes:
- node1
- node2
cron: '0 0 1 1 *'
tasks:
update:
plugin: shell
details:
command: apt-get update
upgrade:
plugin: shell
details:
command: apt-get upgrade -y
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
- id: e258d248fda94c63753607f7c4494ee0fcbe92f1a76bfdac795c9d84101eb317
name: reboot
nodes:
- node1
- node2
cron: '0 0 1 1 *'
tasks:
update:
plugin: shell
details:
command: reboot
created_at: '2020-06-29T23:39:10.071485063-07:00'
updated_at: '2020-06-29T23:39:10.071485063-07:00'
getPlugin:
value:
plugin_path: internal/shell
plugin_properties:
name: shell
plugin_type: task
local_plugin: false
internal_plugin: true
description: Runs a shell command on a node.
getPlugins:
value:
- plugin_path: internal/shell
plugin_properties:
name: shell
plugin_type: task
local_plugin: false
internal_plugin: true
description: Runs a shell command on a node.
- plugin_path: /var/cache/covey/plugins/docker
plugin_properties:
name: docker
plugin_type: task
import_path: example.com/plugins/docker
local_plugin: false
internal_plugin: false
description: Runs docker commands on a node.
plugin_id: 00d151e7d392e68e2c756a6fc42640006ddc0a98d37dba3f90a7b73f63188bbd
getInputs:
value:
- name: command
label: Command
description: The command to run in the shell.
type: 0
required: true
- name: shell
label: Shell
description: The shell to run the command in.
type: 2
options:
- bash
- zsh
default: bash
links:
GetNodeByID:
operationId: getNode
parameters:
nodeId: '$response.body#/id'
GetNodeByName:
operationId: getNode
parameters:
nodeId: '$response.body#/name'
GetTask:
operationId: getTask
parameters:
taskId: '$response.body#/id'
GetJobByID:
operationId: getJob
parameters:
jobId: '$response.body#/id'
GetJobByName:
operationId: getJob
parameters:
jobId: '$response.body#/name'
GetTaskFromJobHistory:
operationId: getTask
parameters:
taskId: '$response.body#/task_history/1'
GetTaskFromJob:
operationId: getTask
parameters:
taskId: '$response.body#/1'
parameters:
offset:
in: query
name: offset
required: false
schema:
type: integer
minimum: 0
description: The number of items to skip.
limit:
in: query
name: limit
required: false
schema:
type: integer
minimum: 1
maximum: 50
default: 20
description: The numbers of items to return.
sort:
in: query
name: sort
required: false
schema:
type: string
enum:
- asc
- desc
default: asc
sortby:
in: query
name: sortby
required: false
schema:
type: string
default: id
nodes:
in: query
name: nodes
required: false
schema:
type: array
items:
type: string
description: The nodes to filter the tasks by.
jobs:
in: query
name: jobs
required: false
schema:
type: array
items:
type: string
description: The jobs to filter the tasks by.
expand:
in: query
name: expand
required: false
schema:
type: boolean
default: false
description: Whether or not to expand the returned items (instead of just the ID).
schemas:
Node:
type: object
properties:
id:
type: string
description: ID of the node.
readOnly: true
name:
type: string
format: hostname
description: Name of the node.
ip:
type: string
format: ip
description: IP address of the node.
port:
type: string
description: SSH port of the node.
default: '22'
username:
type: string
description: Username used to SSH into the node.
password:
type: string
format: password
description: Password used for initial SSH connection.
writeOnly: true
created_at:
type: string
format: 'date-time'
description: The creation time of the task.
readOnly: true
updated_at:
type: string
format: 'date-time'
description: The last time the task was updated.
readOnly: true
required:
- id
- name
- ip
- username
Task:
type: object
properties:
id:
type: string
description: The ID of the task.
readOnly: true
exit_code:
type: integer
description: >
The exit code from the task.
* `0-256`: Ordinary exit code
* `257`: Task Running
* `258`: Task Queued
readOnly: true
minimum: 0
maximum: 258
state:
type: integer
enum: [0, 1, 2, 3, 6, 10, 11]
description: >
The state of the task:
* `0`: Done
* `1`: Error
* `2`: Running
* `3`: Aborted
* `6`: Queued
* `10`: Other
* `11`: Internal Error
readOnly: true
plugin:
type: string
description: The plugin to use for the task.
node:
type: string
description: The node to run the task on.
details:
type: object
description: The argurments to provide to the plugin.
additionalProperties:
type: string
created_at:
type: string
format: 'date-time'
description: The creation time of the task.
readOnly: true
updated_at:
type: string
format: 'date-time'
description: The last time the task was updated.
readOnly: true
required:
- plugin
- node
- details
Job:
type: object
properties:
id:
type: string
description: The ID of the job.
readOnly: true
name:
type: string
description: The name of the job.
nodes:
type: array
description: The nodes to run the job on.
items:
type: string
cron:
type: string
format: crontab
description: A crontab schedule for the the job.
tasks:
type: object
description: The tasks to run.
additionalProperties:
type: object
properties:
plugin:
type: string
description: The plugin to run the task with.
details:
type: object
description: The arguments to provide to the plugin.
additionalProperties:
type: string
created_at:
type: string
format: 'date-time'
description: The creation time of the task.
readOnly: true
updated_at:
type: string
format: 'date-time'
description: The last time the task was updated.
readOnly: true
required:
- name
- nodes
- tasks
Array:
type: array
items:
type: string
Plugin:
type: object
properties:
plugin_path:
type: string
description: The path to the plugin zip file.
readOnly: true
plugin_properties:
type: object
readOnly: true
properties:
import_path:
type: string
description: The Go Module import path.
readOnly: true
plugin_type:
type: string
description: |
The type of the plugin:
- `task`
readOnly: true
name:
type: string
description: The name of the plugin.
readOnly: true
local_plugin:
type: boolean
description: Whether the plugin is localy developed or not.
readOnly: true
internal_plugin:
type: boolean
description: Whether the plugin is provided internally or not.
readOnly: true
description:
type: string
description: Describes the intended function of the plugin.
readOnly: true
plugin_id:
type: string
description: A hash based ID of the plugin, changes from version to version.
Input:
type: object
properties:
name:
type: string
description: The name attribute for that input.
readOnly: true
label:
type: string
description: The label attached to that input.
readOnly: true
description:
type: string
description: The tooltip for the input.
readOnly: true
type:
type: integer
enum: [ 0, 1, 2, 3, 4 ]
description: |
The type of input:
- `0`: Text
- `1`: Number
- `2`: List
- `3`: Multiple
- `4`: Boolean
readOnly: true
default:
type: string
description: The default input value.
readOnly: true
required:
type: boolean
description: Whether or not the input is required.
readOnly: true
options:
description: The options for a `List` or a `Multiple` input.
type: array
items:
type: string
responses:
unauth:
description: Access token is missing or invalid.
node:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Node'
examples:
getNode:
$ref: '#/components/examples/getNode'
links:
GetNodeByID:
$ref: '#/components/links/GetNodeByID'
GetNodeByName:
$ref: '#/components/links/GetNodeByName'
task:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
examples:
getNode:
$ref: '#/components/examples/getTask'
links: