forked from thecodeteam/polly
-
Notifications
You must be signed in to change notification settings - Fork 0
/
polly.apib
389 lines (323 loc) · 10.6 KB
/
polly.apib
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
FORMAT: 1A
HOST: http://pollyhost.org:7978/
# Polly
Polly is an API allowing administrators and container schedulers to centrally optimize and govern consumption of storage.
Polly implements a centralized storage scheduling service that integrates with popular container schedulers of different application platforms for containerized workloads.
It is an open source framework that supports use of external storage, with scheduled containerized workloads, at scale.
It can be used to centralize the control of creating, mapping, snapshotting and deleting persistent data volumes on a multitude of storage platforms.
## Managed Volumes Collection [/admin/volumes]
### List All Managed Volumes [GET]
+ Response 200 (application/json)
[
{
"id": "vol-000",
"name": "mesos-casandra",
"iops": 135,
"networkName", "vlan15",
"size": 10240,
"status": "online",
"type": "nas",
"availabilityZone": "east",
"fields": {
"priority": 2,
"owner": "[email protected]"
}
"volumeid": "pollyvol-005",
"serviceName": "ec2-00",
"schedulers": [
"kubernetes1",
"mesos14"
],
"labels": {
"admin-applied-label1": "blue",
"admin-applied-label2": "aisle-17"
}
}
]
### Create a New Managed Volume [POST]
You may create a volume using this action. It takes a JSON
object containing a specification.
+ Body
{
"service": "ec2-00",
"name": "mysql-vol",
"volumeType": "nas",
"size": 10240,
"iops": 135,
"availabilityZone": "east",
"schedulers": [
"mesos-15"
],
"labels": {
"pollyadminappliedlabel1": "foo"
},
"fields": {
"storageadminappliedlabel1": "bar"
}
}
+ Response 200 (application/json)
+ Headers
Location: /admin/volumes/ec2-00-vol-005
+ Body
{
"availabilityZone": "east",
"iops": 1200,
"name": "mysql-vol",
"size": 10240,
"id": "vol-000",
"type": "nas",
"volumeid": "ec2-00-vol-005",
"serviceName": "ec2-00",
"schedulers": [
"mesos-15"
],
"labels": {
"pollyadminappliedlabel1": "foo"
}
"fields": {
"storageadminappliedlabel1": "bar"
}
}
## Volume [/admin/volumes/{volumeID}]
### Delete a Managed Volume [DELETE]
You may delete a volume managed by Polly using this action.
+ Response 200 (application/json/)
[
{
"id": "vol-000",
"name": "mesos-casandra",
"iops": 135,
"networkName", "vlan15",
"size": 10240,
"status": "online",
"type": "nas",
"availabilityZone": "east",
"fields": {
"priority": 2,
"owner": "[email protected]"
}
"volumeid": "pollyvol-005",
"serviceName": "ec2-00",
"schedulers": [
"kubernetes1",
"mesos14"
],
"labels": {
"admin-applied-label1": "blue",
"admin-applied-label2": "aisle-17"
}
}
]
### List information about a specified managed volume [GET]
+ Response 200 (application/json)
{
"availabilityZone":"west",
"iops":1200,
"name":"postgreSQL-vol",
"size":10240,
"id":"vol-006",
"type":"nas",
"volumeid":"mock-vol-006",
"serviceName":"mock",
"schedulers":["kubernetes-1"]
}
## Version [/admin/version]
### List version of Polly server [GET]
+ Response 200 (application/json)
{
"versionPollyAdminAPI":"v0.1.0",
"versionPollySchedulerAPI":"v0.1.0",
"versionPollyBuild":"0.1.0-dev+44+dirty"
}
## Volumes Collection [/admin/volumesall]
### List All Volumes, managed and unmanaged [GET]
+ Response 200 (application/json)
[
{
"availabilityZone":"zone-000",
"name":"Volume 0",
"size":10240,
"id":"vol-000",
"type":"gold",
"volumeid":"mock-vol-000",
"serviceName":"mock"
},
{
"availabilityZone":"zone-001",
"name":"Volume 1",
"size":40960,
"id":"vol-001",
"type":"gold",
"volumeid":"mock-vol-001",
"serviceName":"mock"
},
{
"availabilityZone":"zone-002",
"name":"Volume 2",
"size":163840,
"id":"vol-002",
"type":"gold",
"volumeid":"mock-vol-002",
"serviceName":"mock"
},
{
"availabilityZone":"east",
"iops":135,
"name":"mysql-vol",
"size":10240,
"id":"vol-005",
"type":"nas",
"volumeid":"mock-vol-005",
"serviceName":"mock",
"schedulers":
[
"mesos-15"
]
},
{
"availabilityZone":"west",
"iops":1200,
"name":"postgreSQL-vol",
"size":10240,
"id":"vol-006",
"type":"nas",
"volumeid":"mock-vol-006",
"serviceName":"mock",
"schedulers":
[
"kubernetes-1"
]
},
{
"availabilityZone":"zone-000",
"name":"Volume 0",
"size":10240,
"id":"vol-000",
"type":"gold",
"volumeid":"mock2-vol-000",
"serviceName":"mock2"
},
{
"availabilityZone":"zone-001",
"name":"Volume 1",
"size":40960,
"id":"vol-001",
"type":"gold",
"volumeid":"mock2-vol-001",
"serviceName":"mock2"
},
{
"availabilityZone":"zone-002",
"name":"Volume 2",
"size":163840,
"id":"vol-002",
"type":"gold",
"volumeid":"mock2-vol-002",
"serviceName":"mock2"
}
]
## Volume Association [/admin/volumeoffer]
### Associate a specified Volume with a container scheduler [POST]
You may associate a volume with a container scheduler using this action. It takes a JSON
object containing a specification for the volume and scheduler name.
+ Body
{
"volumeID": "mock-vol-000",
"schedulers":
[
"mesos-99"
]
}
+ Response 200 (application/json)
+ Body
{
"availabilityZone":"zone-000",
"name":"Volume 0",
"size":10240,
"id":"vol-000",
"type":"gold",
"volumeid":"mock-vol-000",
"serviceName":"mock",
"schedulers":[
"mesos-99"
]
}
## Volume Disassociation [/admin/volumeofferrevoke]
### Disassociate a specified Volume with a container scheduler [POST]
You may disassociate a volume with a container scheduler using this action. It takes a JSON
object containing a specification for the volume and scheduler name.
+ Body
{
"volumeID": "mock-vol-000",
"schedulers":
[
"mesos-99"
]
}
+ Response 200 (application/json)
+ Body
{
"availabilityZone":"zone-000",
"name":"Volume 0",
"size":10240,
"id":"vol-000",
"type":"gold",
"volumeid":"mock-vol-000",
"serviceName":"mock",
}
## Volume Label Application [/admin/volumelabel]
### Apply an administrator chosen key-value label to a specified Volume [POST]
You may associate key-value labels with a volume using this action. It takes a JSON
object containing a specification for the volume and one or more key value labels.
+ Body
{
"volumeID": "mock-vol-000",
"labels":
{
"color": "magenta",
"location": "area51"
}
}
+ Response 200 (application/json)
+ Body
{
"availabilityZone":"zone-000",
"name":"Volume 0",
"size":10240,
"id":"vol-000",
"type":"gold",
"volumeid":"mock-vol-000",
"serviceName":"mock",
"labels":
{
"color":"magenta",
"location":"area51"
}
}
## Volume Label Removal [/admin/volumelabelremove]
### Remove label(s) from a Managed Volume [POST]
You may remove labels from a managed volume using this action. It takes a JSON
object containing a specification for the volume, and the key of labels to be removed.
+ Body
{
"volumeID": "mock-vol-000",
"schedulers":
[
"location"
]
}
+ Response 200 (application/json)
+ Body
{
"availabilityZone":"zone-000",
"name":"Volume 0",
"size":10240,
"id":"vol-000",
"type":"gold",
"volumeid":"mock-vol-000",
"serviceName":"mock",
"labels":
{
"color":"magenta"
}
}