forked from elastest/elastest-platform-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
1045 lines (1045 loc) · 27 KB
/
api.yaml
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
swagger: '2.0'
info:
description: REST API description of the ElasTest Platform Manager Module.
version: 0.1.2
title: EPM REST API
contact: {}
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: 'localhost:8180'
basePath: /v1
paths:
/tosca:
post:
tags:
- TOSCA
summary: Deploys a Tosca template.
description: The TOSCA template defines VDUs, Networks and the PoPs where to allocate the virtual resources
operationId: deployToscaTemplate
parameters:
- in: body
name: body
description: TOSCA formatted template
required: true
schema:
type: string
consumes:
- text/yaml
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/ResourceGroup'
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
schema:
type: string
'403':
description: Forbidden
schema:
type: string
'404':
description: Not Found
schema:
type: string
/resourceGroup:
get:
tags:
- ResourceGroup
summary: Returns all Resource Groups.
description: Returns all Resource Groups with all details.
operationId: getAllResourceGroups
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/ResourceGroup'
'401':
description: Unauthorized
'403':
description: Forbidden
post:
tags:
- ResourceGroup
summary: Creates a new Resource Group.
description: Creates a new Resource Group and allocates the defined resources in the defined PoPs.
operationId: createResourceGroup
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Defintion of a Resource Group which includes all VDUs, Network and respective PoPs
required: true
schema:
$ref: '#/definitions/ResourceGroup'
responses:
'200':
description: Resource Group creation OK
schema:
$ref: '#/definitions/ResourceGroup'
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'/resourceGroup/{id}':
get:
tags:
- ResourceGroup
summary: Returns a Resource Group.
description: Returns the Resource Group with the given ID. Returns all its details.
operationId: getResourceGroupById
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of ResourceGroup
required: true
type: string
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/ResourceGroup'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: ResourceGroup not found
delete:
tags:
- ResourceGroup
summary: Deletes a Resource Group.
description: Deletes the Resource Group that matches with a given ID.
operationId: deleteResourceGroup
produces:
- '*/*'
parameters:
- name: id
in: path
description: ID of ResourceGroup
required: true
type: string
responses:
'200':
description: ResourceGroup deleted successfully
schema:
type: string
'204':
description: No Content
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: ResourceGroup not found
schema:
type: string
patch:
tags:
- ResourceGroup
summary: Updates a ResourceGroup.
description: Updates an existing ResourceGroup.
operationId: updateResourceGroup
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of ResourceGroup
required: true
type: string
- in: body
name: body
description: ResourceGroup that needs to be updated.
required: true
schema:
$ref: '#/definitions/ResourceGroup'
responses:
'200':
description: ResourceGroup Update OK
schema:
$ref: '#/definitions/ResourceGroup'
'204':
description: No Content
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: ResourceGroup not found
schema:
type: string
/network:
get:
tags:
- Network
summary: Returns all existing networks.
description: Returns all networks with all details.
operationId: getAllNetworks
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/Network'
post:
tags:
- Network
summary: Creates a new network.
description: Creates a new network in the target cloud environment with the given CIDR.
operationId: createNetwork
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Defintion of a Network which has to be created on a certain PoP
required: true
schema:
$ref: '#/definitions/Network'
responses:
'200':
description: Network creation OK
schema:
$ref: '#/definitions/Network'
'201':
description: Created
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
schema:
type: string
'/network/{id}':
get:
tags:
- Network
summary: Returns a network.
description: Returns the network with the given ID. Returns all its details.
operationId: getNetworkById
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of Network
required: true
type: string
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/Network'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Network not found
schema:
type: string
delete:
tags:
- Network
summary: Deletes a network.
description: Deletes the network that matches with a given ID.
operationId: deleteNetwork
parameters:
- name: id
in: path
description: ID of Network
required: true
type: string
responses:
'200':
description: Network deleted successfully
schema:
type: string
'204':
description: No Content
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Network not found
schema:
type: string
patch:
tags:
- Network
summary: Updates a Network.
description: Updates an existing Network.
operationId: updateNetwork
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of Network
required: true
type: string
- in: body
name: body
description: Network that needs to be updated.
required: true
schema:
$ref: '#/definitions/Network'
responses:
'200':
description: Network Update OK
schema:
$ref: '#/definitions/Network'
'204':
description: No Content
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Network not found
schema:
type: string
/pop:
get:
tags:
- PoP
summary: Returns all PoPs.
description: Returns all PoPs with all its details.
operationId: getAllPoPs
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/PoP'
'401':
description: Unauthorized
'403':
description: Forbidden
post:
tags:
- PoP
summary: Registers a new PoP
description: Registers a new Point-of-Presence represented by a PoP
operationId: registerPoP
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Defintion of a PoP which defines a Point-of-Presence used to host resources
required: true
schema:
$ref: '#/definitions/PoP'
responses:
'200':
description: PoP registration OK
schema:
$ref: '#/definitions/PoP'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
schema:
type: string
'/pop/{id}':
get:
tags:
- PoP
summary: Returns a PoP.
description: Returns the PoP with the given ID. Returns all its details.
operationId: getPoPById
produces:
- application/json
parameters:
- name: id
in: path
description: ID of PoP
required: true
type: string
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/PoP'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: PoP not found.
schema:
type: string
delete:
tags:
- PoP
summary: Unregisters a PoP.
description: Unregisters the PoP that matches with a given ID.
operationId: unregisterPoP
produces:
- '*/*'
parameters:
- name: id
in: path
description: ID of PoP
required: true
type: string
responses:
'200':
description: PoP unregistered successfully
schema:
type: string
'204':
description: No Content
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: PoP not found
schema:
type: string
patch:
tags:
- PoP
summary: Updates a PoP.
description: Updates an already registered PoP.
operationId: updatePoP
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of PoP
required: true
type: string
- in: body
name: body
description: PoP object that needs to be updated.
required: true
schema:
$ref: '#/definitions/PoP'
responses:
'200':
description: PoP Update OK
schema:
$ref: '#/definitions/PoP'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: PoP not found
schema:
type: string
/vdu:
get:
tags:
- VDU
summary: Returns all VDUs.
description: Returns all VDUs with all its details.
operationId: getAllVdus
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/VDU'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- VDU
summary: Allocates resources in the target cloud.
description: 'Allocates resources defined as a VDU in the cloud to be deployed in the target cloud environment. It instantiates computing resources, deploys artifacts on them and manages the their lifecycle'
operationId: deployVdu
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Defintion of a VDU which defines resources that have to be deployed
required: true
schema:
$ref: '#/definitions/VDU'
responses:
'200':
description: VDU allocation OK
schema:
$ref: '#/definitions/VDU'
'201':
description: Created
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
schema:
type: string
'/vdu/{id}':
get:
tags:
- VDU
summary: Returns a VDU.
description: Returns the VDU with the given ID. Returns all its details.
operationId: getVduById
produces:
- application/json
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/VDU'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU not found.
schema:
type: string
delete:
tags:
- VDU
summary: Terminates a VDU.
description: Terminates the VDU that matches with a given ID.
operationId: deleteVdu
produces:
- '*/*'
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
responses:
'200':
description: VDU terminated successfully
schema:
type: string
'204':
description: No Content
'400':
description: Bad Request
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU not found
schema:
type: string
patch:
tags:
- VDU
summary: Updates a VDU.
description: Updates an already deployed VDU.
operationId: updateVdu
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
- in: body
name: body
description: VDU object that needs to be updated.
required: true
schema:
$ref: '#/definitions/VDU'
responses:
'200':
description: VDU Update OK
schema:
$ref: '#/definitions/VDU'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU not found
'/runtime/{id}/file':
get:
tags:
- Runtime
summary: Downloads a file from a VDU.
description: Download a file with the given filepath from the given VDU.
operationId: downloadFileFromInstance
consumes:
- application/json
produces:
- multipart/form-data
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
- in: body
name: fileDownloadBody
description: Contains details of the file to be downloaded from the given Instance
required: true
schema:
type: object
required:
- path
example:
path: /test
properties:
path:
type: string
example: /
responses:
'200':
description: Successful operation
schema:
type: file
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU/File not found.
schema:
type: string
post:
tags:
- Runtime
summary: Uploads a file to a VDU.
description: Uploads a given file to the given filepath to the given VDU.
operationId: uploadFileToInstanceByFile
consumes:
- multipart/form-data
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
- name: remotePath
in: formData
description: Absolute path where the file should go on the Instance
required: true
type: string
- name: file
in: formData
description: File which has to be uploaded to the Instance. Either this or the hostPath but not both can be provided.
required: true
type: file
responses:
'200':
description: Successful operation
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU/Path not found.
schema:
type: string
'/runtime/{id}/path':
post:
tags:
- Runtime
summary: Uploads a file to a VDU.
description: Uploads a given file from the host path to the given file path to the given VDU.
operationId: uploadFileToInstanceByPath
consumes:
- application/json
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
- in: body
name: fileUploadBody
description: Contains details of the file with the given path to upload to the Instance
required: true
schema:
type: object
required:
- remotePath
- hostPath
example:
remotePath: /test
hostPath: /test
properties:
remotePath:
type: string
example: /
hostPath:
type: string
example: /
responses:
'200':
description: Successful operation
'400':
description: Bad request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU/Path not found.
schema:
type: string
'/runtime/{id}/action/start':
put:
tags:
- Runtime
summary: Starts the given VDU.
description: Starts the VDU with the given ID.
operationId: startInstance
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
responses:
'200':
description: Successful operation
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU/File not found.
schema:
type: string
'/runtime/{id}/action/stop':
put:
tags:
- Runtime
summary: Stops the given VDU.
description: Stops the VDU with the given ID.
operationId: stopInstance
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
responses:
'200':
description: Successful operation
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU/File not found.
'/runtime/{id}/action/execute':
put:
tags:
- Runtime
summary: Executes given command on the given VDU.
description: Executes the given command on the VDU with the given ID.
operationId: executeOnInstance
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: ID of VDU
required: true
type: string
- in: body
name: commandExecutionBody
description: Contains command to be executed and a flag if for the completion of the execution should be awaited
required: true
schema:
type: object
required:
- command
- awaitCompletion
example:
command: ls /
awaitCompletion: true
properties:
command:
type: string
example: ls /
awaitCompletion:
type: boolean
example: true
responses:
'200':
description: Successful operation
schema:
type: string
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: VDU not found.
definitions:
Event:
type: object
required:
- description
- timestamp
properties:
description:
type: string
example: testEvent1
id:
type: string
example: 1234-abcd
timestamp:
type: string
format: string
description: An event contains certain life cycle information of the VDU at a specific time.
KeyValuePair:
type: object
required:
- key
- value
properties:
id:
type: string
example: 1234-abcd
key:
type: string
example: testKey1
value:
type: string
example: testValue1
description: This entity is a Key-Value pair for storing metadata contained in other entities
Network:
type: object
required:
- cidr
- name
- networkId
- poPName
properties:
cidr:
type: string
example: 192.168.1.1/24
id:
type: string
example: 1234-abcd
name:
type: string
example: testNetwork1
networkId:
type: string
example: 1234-abcd
poPName:
type: string
description: This entity defines the network connectivity and details where the VDUs are connected to.
PoP:
type: object
required:
- accessInfo
- interfaceEndpoint
- interfaceInfo
- name
properties:
accessInfo:
type: array
description: 'Authentication credentials for accessing the PoP. Examples may include those to support different authentication schemes, e.g. OAuth, Token, etc.'
items:
$ref: '#/definitions/KeyValuePair'
id:
type: string
example: 1234-abcd
description: Identifier of the PoP
interfaceEndpoint:
type: string
example: localhost
description: Information about the interface endpoint. An example is a URL.
interfaceInfo:
type: array
example: '[{"key":"type","value":"docker"}]'
description: 'Information about the interface(s) to the PoP, including PoP provider type, API version, and protocol type.'
items:
$ref: '#/definitions/KeyValuePair'
name:
type: string
example: testPoPName
description: Human-readable identifier of this PoP information element
description: This entity contains information about the Point-of-Presence (PoP)
VDU:
description: 'A Virtual Deployment Unit (VDU) describes the capabilities of virtualized computing (Containers, VMs) and networking resources.'
type: object
required:
- computeId
- imageName
- ip
- name
- netName
- poPName
properties:
computeId:
type: string
example: 1234-abcd
events:
type: array
items:
$ref: '#/definitions/Event'
id:
type: string
example: 1234-abcd
imageName:
type: string
example: testImage1
ip:
type: string
example: 172.0.0.1
metadata:
type: array
items: