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
|
---
swagger: '2.0'
info:
version: "4.1.0"
title: "deployment-handler API"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
description: |
High-level API for deploying/undeploying composed DCAE services using Cloudify Manager.
tags:
- name: "info"
description: "version and links"
- name: "dcae-deployments"
description: "operations on dcae-deployments"
- name: "policy"
description: "policy update API consumed by policy-handler and debug API to find policies on components"
paths:
/:
get:
tags:
- "info"
description: Returns version information and links to API operations
produces:
- "application/json"
responses:
200:
description: Success
schema:
title: DispatcherInfo
type: object
properties:
apiVersion:
type: string
description: |
version of API supported by this server
serverVersion:
type: string
description: |
version of software running on this server
links:
type: object
description: |
Links to API resources
properties:
info:
type: string
description: |
path for the server information endpoint
events:
type: string
description: |
path for the events endpoint
/dcae-deployments:
get:
tags:
- "dcae-deployments"
description: |
List service deployments known to the orchestrator, optionally restricted to a single service type
parameters:
- name: serviceTypeId
description: |
Service type identifier for the type whose deployments are to be listed
type: string
in: query
required: false
responses:
200:
description: |
Success. (Note that if no matching deployments are found, the request is still a success; the
deployments array is empty in that case.)
schema:
$ref: "#/definitions/DCAEDeploymentsListResponse"
500:
description: |
Problem on the server side. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
502:
description: |
Error reported to the dispatcher by a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
504:
description: |
Error communicating with a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
/dcae-deployments/{deploymentId}:
put:
tags:
- "dcae-deployments"
description: |
Request deployment of a DCAE service
consumes:
- application/json
produces:
- application/json
parameters:
- name: deploymentId
description: |
Unique deployment identifier assigned by the API client.
in: path
type: string
required: true
- name: body
in: body
schema:
$ref: "#/definitions/DCAEDeploymentRequest"
required: true
responses:
202:
description: |
Success: The content that was posted is valid, the dispatcher has
found the needed blueprint, created an instance of the topology in the orchestrator,
and started an installation workflow.
schema:
$ref: "#/definitions/DCAEDeploymentResponse"
400:
description: |
Bad request: See the message in the response for details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
409:
description: |
A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation.
schema:
$ref: "#/definitions/DCAEErrorResponse"
415:
description: |
Bad request: The Content-Type header does not indicate that the content is
'application/json'
schema:
$ref: "#/definitions/DCAEErrorResponse"
500:
description: |
Problem on the server side. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
502:
description: |
Error reported to the dispatcher by a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
504:
description: |
Error communicating with a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
delete:
tags:
- "dcae-deployments"
description: |
Uninstall the DCAE service and remove all associated data from the orchestrator.
parameters:
- name: deploymentId
description: |
Deployment identifier for the service to be uninstalled.
in: path
type: string
required: true
responses:
202:
description: |
Success: The dispatcher has initiated the uninstall operation.
schema:
$ref: "#/definitions/DCAEDeploymentResponse"
400:
description: |
Bad request: See the message in the response for details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
500:
description: |
Problem on the server side. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
502:
description: |
Error reported to the dispatcher by a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
504:
description: |
Error communicating with a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
/dcae-deployments/{deploymentId}/operation/{operationId}:
get:
tags:
- "dcae-deployments"
description: |
Get status of a deployment operation
parameters:
- name: deploymentId
in: path
type: string
required: true
- name: operationId
in: path
type: string
required: true
responses:
200:
description: Status information retrieved successfully
schema:
$ref: "#/definitions/DCAEOperationStatusResponse"
404:
description: The operation information does not exist (possibly because the service has been uninstalled and deleted).
schema:
$ref: "#/definitions/DCAEErrorResponse"
500:
description: |
Problem on the server side. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
502:
description: |
Error reported to the dispatcher by a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
504:
description: |
Error communicating with a downstream system. See the message
in the response for more details.
schema:
$ref: "#/definitions/DCAEErrorResponse"
/policy:
post:
tags:
- "policy"
description: policy update API consumed by policy-handler
consumes:
- application/json
produces:
- application/json
parameters:
- name: body
in: body
schema:
$ref: "#/definitions/DCAEPolicyRequest"
required: true
responses:
200:
description: deployment-handler always responds with ok to /policy before processing the request
/policy/components:
get:
tags:
- "policy"
description: debug API to find policies on components
produces:
- application/json
responses:
200:
description: deployment-handler found components with or without policies in cloudify
definitions:
DCAEDeploymentRequest:
description: |
Request for deploying a DCAE service.
type:
object
required: [serviceTypeId]
properties:
serviceTypeId:
description: |
The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.
type: string
inputs:
description: |
Object containing inputs needed by the service blueprint to create an instance of the service.
Content of the object depends on the service being deployed.
type: object
DCAEDeploymentResponse:
description: |
Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}
type: object
required: [requestId, links]
properties:
requestId:
type: string
description: |
Unique identifier for the request
links:
description: |
Links that the API client can access.
type: object
properties:
self:
type: string
description: |
Link used to retrieve information about the service being deployed
status:
type: string
description:
Link used to retrieve information about the status of the installation workflow
DCAEOperationStatusResponse:
description: |
Response body for a request for status of an installation or uninstallation operation.
type: object
required: [requestId, operationType, status]
properties:
requestId:
type: string
description: |
A unique identifier assigned to the request. Useful for tracing a request through logs.
operationType:
description: |
Type of operation being reported on. ("install" or "uninstall")
type: string
status:
description: |
Status of the installation or uninstallation operation. Possible values are "processing",
"succeeded", and "failed"
type: string
error:
description: |
If status is "failed", this field will be present and contain additional information about the reason the operation failed.
type: string
links:
description: |
If the operation succeeded, links that the client can follow to take further action. Note that a successful "uninstall" operation removes the DCAE service instance completely, so there are no possible further actions, and no links.
type: object
properties:
self:
type: string
description: |
Link used to retrieve information about the service.
uninstall:
type: string
description:
Link used to trigger an "uninstall" operation for the service. (Use the DELETE method.)
DCAEErrorResponse:
description: |
Object reporting an error.
type:
object
required: [status]
properties:
status:
description: HTTP status code for the response
type: integer
message:
description: Human-readable description of the reason for the error
type: string
DCAEDeploymentsListResponse:
description: |
Object providing a list of deployments
type: object
required: [requestId, deployments]
properties:
requestId:
type: string
description: |
Unique identifier for the request
deployments:
type: array
items:
type: object
properties:
href:
type: string
description: |
URL for the service deployment
DCAEPolicyBody:
description: policy_body - the whole object received from policy-engine
type: object
required:
- policyName
- policyVersion
- config
properties:
policyName:
description: unique policy name that contains the version and extension
type: string
policyVersion:
description: stringified int that is autoincremented by policy-engine
type: string
config:
description: the policy-config - the config data provided by policy owner
type: object
DCAEPolicy:
description: policy object
type: object
required:
- policy_id
- policy_body
properties:
policy_id:
description: unique identifier of policy regardless of its version
type: string
policy_body:
$ref: "#/definitions/DCAEPolicyBody"
DCAEPolicyRequest:
description: request to update policies on DCAE components.
type: object
required:
- latest_policies
properties:
latest_policies:
description: "dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values"
type: object
additionalProperties:
$ref: "#/definitions/DCAEPolicy"
|
