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
|
===============
CDAP Broker API
===============
:Date: 2017-10-09
.. contents::
:depth: 3
..
Overview
========
Version information
-------------------
*Version* : 4.0.10
Paths
=====
GET /
-----
Description
~~~~~~~~~~~
shows some information about this service
Responses
~~~~~~~~~
+---------+--------------------------------------------+-------------------+
| HTTP | Description | Schema |
| Code | | |
+=========+============================================+===================+
| **200** | successful response | `info <#_info>`__ |
+---------+--------------------------------------------+-------------------+
GET /application
----------------
Description
~~~~~~~~~~~
get all applications registered with this broker
Responses
~~~~~~~~~
+---------+-------------------------------------------+---------------+
| HTTP | Description | Schema |
| Code | | |
+=========+===========================================+===============+
| **200** | successful response | `appname <#_a |
| | | ppname>`__ |
| | | (array) |
+---------+-------------------------------------------+---------------+
PUT /application/{appname}
--------------------------
Description
~~~~~~~~~~~
(This is a hacky way of supporting "oneOf" because Swagger does not
support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333.
This is the same endpoint as PUT /application/appname, except the PUT
body is different.)
Register a hydrator app for service and configuration discovery. This
will light up a metrics and health endpoint for this app. ``appname`` is
assumed to also be the key in consul.
Parameters
~~~~~~~~~~
+----------+---------------+---------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+===============+=================================+==================+
| **Path** | | **appname** | Name of the application. | string (text) |
| | | *required* | | |
+----------+---------------+---------------------------------+------------------+
| **Body** | | **putbody** | required put body | `hydratorappput |
| | | *required* | | <#_hydratorapppu |
| | | | t>`__ |
+----------+---------------+---------------------------------+------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------------+---------------+
| HTTP | Description | Schema |
| Code | | |
+=========+====================================================+===============+
| **200** | Successful response | `application |
| | | <#_applicatio |
| | | n>`__ |
+---------+----------------------------------------------------+---------------+
| **400** | put was performed but the appname was already | No Content |
| | registered with the broker, or Invalid PUT body | |
+---------+----------------------------------------------------+---------------+
Consumes
~~~~~~~~
- ``application/json``
Produces
~~~~~~~~
- ``application/json``
POST /application/delete
------------------------
Description
~~~~~~~~~~~
endpoint to delete multiple applications at once. Returns an array of
status codes, where statuscode[i] = response returned from
DELETE(application/i)
Parameters
~~~~~~~~~~
+----------+----------------+------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+================+==============================+==================+
| **Body** | | **postbody** | required post body | `multideleteput |
| | | *required* | | <#_multideletepu |
| | | | t>`__ |
+----------+----------------+------------------------------+------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------+-------------------+
| HTTP | Description | Schema |
| Code | | |
+=========+==============================================+===================+
| **200** | successful response | `returncode |
| | | <#_returncode>`__ |
| | | (array) |
+---------+----------------------------------------------+-------------------+
GET /application/{appname}
--------------------------
Description
~~~~~~~~~~~
Returns the representation of the application resource, including the
links for healthcheck and metrics.
Parameters
~~~~~~~~~~
+----------+---------------+--------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+===============+================================+==================+
| **Path** | | **appname** | Name of the application. | string (text) |
| | | *required* | | |
+----------+---------------+--------------------------------+------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------------+---------------+
| HTTP | Description | Schema |
| Code | | |
+=========+====================================================+===============+
| **200** | Successful response | `application |
| | | <#_applicatio |
| | | n>`__ |
+---------+----------------------------------------------------+---------------+
| **404** | no app with name 'appname' registered with this | No Content |
| | broker. | |
+---------+----------------------------------------------------+---------------+
PUT /application/{appname}
--------------------------
Description
~~~~~~~~~~~
Register an app for service and configuration discovery. This will light
up a metrics and health endpoint for this app. ``appname`` is assumed to
also be the key in consul.
Parameters
~~~~~~~~~~
+----------+---------------+--------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+===============+================================+==================+
| **Path** | | **appname** | Name of the application. | string (text) |
| | | *required* | | |
+----------+---------------+--------------------------------+------------------+
| **Body** | | **putbody** | required put body | `appput <#_apppu |
| | | *required* | | t>`__ |
+----------+---------------+--------------------------------+------------------+
Responses
~~~~~~~~~
+---------+--------------------------------------------------+---------------+
| HTTP | Description | Schema |
| Code | | |
+=========+==================================================+===============+
| **200** | Successful response | `Application |
| | | <#_applicatio |
| | | n>`__ |
+---------+--------------------------------------------------+---------------+
| **400** | put was performed but the appname was already | No Content |
| | registered with the broker, or Invalid PUT body | |
+---------+--------------------------------------------------+---------------+
Consumes
~~~~~~~~
- ``application/json``
Produces
~~~~~~~~
- ``application/json``
DELETE /application/{appname}
-----------------------------
Description
~~~~~~~~~~~
Remove an app for service and configuration discovery. This will remove
the metrics and health endpoints for this app.
Parameters
~~~~~~~~~~
+----------+---------------+--------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+===============+================================+==================+
| **Path** | | **appname** | Name of the application. | string (text) |
| | | *required* | | |
+----------+---------------+--------------------------------+------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------------+----------------+
| HTTP | Description | Schema |
| Code | | |
+=========+====================================================+================+
| **200** | Successful response | No Content |
+---------+----------------------------------------------------+----------------+
| **404** | no app with name 'appname' registered with this | No Content |
| | broker. | |
+---------+----------------------------------------------------+----------------+
GET /application/{appname}/healthcheck
--------------------------------------
Description
~~~~~~~~~~~
Perform a healthcheck on the running app appname.
Parameters
~~~~~~~~~~
+----------+---------------+--------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+===============+================================+==================+
| **Path** | | **appname** | Name of the application to get | string (text) |
| | | *required* | the healthcheck for. | |
+----------+---------------+--------------------------------+------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------------+----------------+
| HTTP | Description | Schema |
| Code | | |
+=========+====================================================+================+
| **200** | Successful response, healthcheck pass | No Content |
+---------+----------------------------------------------------+----------------+
| **404** | no app with name 'appname' registered with this | No Content |
| | broker, or the healthcheck has failed (though I | |
| | would like to disambiguiate from the first case, | |
| | CDAP returns a 404 for this). | |
+---------+----------------------------------------------------+----------------+
GET /application/{appname}/metrics
----------------------------------
Description
~~~~~~~~~~~
Get live (real-time) app specific metrics for the running app appname.
Metrics are customized per each app by the component developer
Parameters
~~~~~~~~~~
+----------+---------------+--------------------------------+------------------+
| Type | Name | Description | Schema |
+==========+===============+================================+==================+
| **Path** | | **appname** | Name of the application to get | string (text) |
| | | *required* | metrics for. | |
+----------+---------------+--------------------------------+------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------------+----------------+
| HTTP | Description | Schema |
| Code | | |
+=========+====================================================+================+
| **200** | Successful response | `MetricsObject |
| | | <#_metricsobje |
| | | ct>`__ |
+---------+----------------------------------------------------+----------------+
| **404** | no app with name 'appname' registered with this | No Content |
| | broker. | |
+---------+----------------------------------------------------+----------------+
PUT /application/{appname}/reconfigure
--------------------------------------
Description
~~~~~~~~~~~
Reconfigures the application.
Parameters
~~~~~~~~~~
+----------+---------------+----------------------------+--------------------+
| Type | Name | Description | Schema |
+==========+===============+============================+====================+
| **Path** | | **appname** | Name of the application. | string (text) |
| | | *required* | | |
+----------+---------------+----------------------------+--------------------+
| **Body** | | **putbody** | required put body | `reconfigput |
| | | *required* | | <#_reconfigput>`__ |
+----------+---------------+----------------------------+--------------------+
Responses
~~~~~~~~~
+---------+----------------------------------------------------+----------------+
| HTTP | Description | Schema |
| Code | | |
+=========+====================================================+================+
| **200** | Successful response | No Content |
+---------+----------------------------------------------------+----------------+
| **400** | Bad request. Can happen with 1) {appname} is not | No Content |
| | registered with the broker, 2) the required PUT | |
| | body is wrong, or 3) the smart interface was | |
| | chosen and none of the config keys match anything | |
| | in app\_config or app\_preferences | |
+---------+----------------------------------------------------+----------------+
Definitions
===========
Application
-----------
+---------------------+---------------------------------------------+------------------+
| Name | Description | Schema |
+=====================+=============================================+==================+
| | **appname** | application name | string |
| | *optional* | | |
+---------------------+---------------------------------------------+------------------+
| | **connectionurl** | input URL that you can POST data into (URL | string |
| | *optional* | of the CDAP stream) | |
+---------------------+---------------------------------------------+------------------+
| | **healthcheckurl**| fully qualified url to perform healthcheck | string |
| | *optional* | | |
+---------------------+---------------------------------------------+------------------+
| | **metricsurl** | fully qualified url to get metrics from | string |
| | *optional* | | |
+---------------------+---------------------------------------------+------------------+
| | **service | a list of HTTP services exposed by this | `service\_method |
| endpoints** | CDAP application | <#_service_metho |
| | *optional* | | d>`__ |
| | | (array) |
+---------------------+---------------------------------------------+------------------+
| | **url** | fully qualified url of the resource | string |
| | *optional* | | |
+---------------------+---------------------------------------------+------------------+
MetricsObject
-------------
key,value object where the key is 'appmetrics' and the value is an app
dependent json and specified by the component developer
+--------------------------------+-------------------------------------------+
| Name | Schema |
+================================+===========================================+
| | **appmetrics** | object |
| | *optional* | |
+--------------------------------+-------------------------------------------+
appname
-------
an application name
*Type* : string
appput
------
+-------------------------------+---------------------------------------------+--------------------+
| Name | Description | Schema |
+===============================+=============================================+====================+
| | **app\_config** | the application config JSON | object |
| | *optional* | | |
+-------------------------------+---------------------------------------------+--------------------+
| | **app\_preferences** | the application preferences JSON | object |
| | *optional* | | |
+-------------------------------+---------------------------------------------+--------------------+
| | **artifact\_name** | the name of the CDAP artifact to be added | string |
| | *optional* | | |
+-------------------------------+---------------------------------------------+--------------------+
| | **cdap\_application\_type** | denotes whether this is a program-flowlet | enum |
| | *optional* | style application or a hydrator pipeline. | (program-flowlet |
| | For program-flowlet style apps, this value | ) |
| | must be "program-flowlet" | |
+-------------------------------+---------------------------------------------+--------------------+
| | **jar\_url** | the URL that the JAR you’re deploying | string |
| | *optional* | resides | |
+-------------------------------+---------------------------------------------+--------------------+
| | **namespace** | the cdap namespace this is deployed into | string |
| | *optional* | | |
+-------------------------------+---------------------------------------------+--------------------+
| | **program\_preferences** | | `programpref |
| | *optional* | | <#_programpref>`__ |
| | | (array) |
+-------------------------------+---------------------------------------------+--------------------+
| | **programs** | | `programs |
| | *optional* | | <#_programs>`__ |
| | | (array) |
+-------------------------------+---------------------------------------------+--------------------+
| | **services** | | `service\_endpoint |
| | *optional* | | <#_service_endpoin |
| | | t>`__ (array) |
+-------------------------------+---------------------------------------------+--------------------+
| | **streamname** | name of the CDAP stream to ingest data into | string |
| | *optional* | this app. Should come from the developer | |
| | and Tosca model. | |
+-------------------------------+---------------------------------------------+--------------------+
hydratorappput
--------------
+-----------------------------------+---------------------------------------------+---------------+
| Name | Description | Schema |
+===================================+=============================================+===============+
| | **cdap\_application\_TYPE** | denotes whether this is a program-flowlet | enum |
| | style application or a hydrator pipeline. | (hydrator-pip |
| | *required* | For hydrator, this value must be | eline) |
| | "hydrator-pipeline" | |
+-----------------------------------+---------------------------------------------+---------------+
| | **dependencies** | represents a list of dependencies to be | `hydratordep |
| | *optional* | loaded for this pipeline. Not required. | <#_hydratorde |
| | | p>`__ (array) |
+-----------------------------------+---------------------------------------------+---------------+
| | **namespace** | the cdap namespace this is deployed into | string |
| | *required* | | |
+-----------------------------------+---------------------------------------------+---------------+
| | **pipeline\_config\_json\_url** | the URL of the config.json for this | string |
| | *required* | pipeline | |
+-----------------------------------+---------------------------------------------+---------------+
| | **streamname** | name of the CDAP stream to ingest data into | string |
| | *required* | this app. Should come from the developer | |
| | and Tosca model. | |
+-----------------------------------+---------------------------------------------+---------------+
hydratordep
-----------
represents a hydrator pipeline dependency. An equivalent to the
following CURLs are formed with the below four params shown in CAPS::
curl -v -w"\\n" -X POST
http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME
-H "Artifact-Extends:ARTIFACT\_EXTENDS\_HEADER" -H
“Artifact-Version:ARTIFACT\_VERSION\_HEADER” –data-binary @(DOWNLOADED
FROM ARTIFACT\_URL)","curl -v -w"\\n" -X PUT
http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties
-d (DOWNLOADED FROM UI\_PROPERTIES\_URL)"
+---------------------------------+---------------------------------------------+----------+
| Name | Description | Schema |
+=================================+=============================================+==========+
| | **artifact\_extends\_header** | the value of the header that gets passed in | string |
| | *required* | for artifact-extends, e.g., | |
| | "Artifact-Extends:system:cdap-data-pipeline | |
| | [4.0.1,5.0.0)" | |
+---------------------------------+---------------------------------------------+----------+
| | **artifact\_name** | the name of the artifact | string |
| | *required* | | |
+---------------------------------+---------------------------------------------+----------+
| | **artifact\_url** | the URL of the artifact JAR | string |
| | *required* | | |
+---------------------------------+---------------------------------------------+----------+
| | **artifact\_version\_header** | the value of the header that gets passed in | string |
| | *required* | for artifact-version, e.g., | |
| | "Artifact-Version:1.0.0-SNAPSHOT" | |
+---------------------------------+---------------------------------------------+----------+
| | **ui\_properties\_url** | the URL of the properties.json if the | string |
| | *optional* | custom artifact has UI properties. This is | |
| | optional. | |
+---------------------------------+---------------------------------------------+----------+
info
----
some broker information
+------------------+---------------------------------------------+-----------+
| Name | Description | Schema |
+==================+=============================================+===========+
| | **broker API | the API version of this running broker | string |
| version** | | |
| | *optional* | | |
+------------------+---------------------------------------------+-----------+
| | **cdap GUI | The GUI port of the CDAP cluster this | integer |
| port** | broker is managing. Mostly to help users of | |
| | *optional* | this API check their application in cdap. | |
| | Note, will return UNKNOWN\_CDAP\_VERSION if | |
| | it cannot be determined. | |
+------------------+---------------------------------------------+-----------+
| | **cdap | the version of the CDAP cluster this broker | string |
| cluster | is managing. Note, will return | |
| version** | UKNOWN\_CDAP\_VERSION if it cannot be | |
| | *optional* | determined. | |
+------------------+---------------------------------------------+-----------+
| | **managed cdap | the url of the CDAP cluster API this broker | string |
| url** | is managing | |
| | *optional* | | |
+------------------+---------------------------------------------+-----------+
| | **number | | integer |
| of applications | | |
| registered** | | |
| | *optional* | | |
+------------------+---------------------------------------------+-----------+
| | **uptime (s)** | | integer |
| | *optional* | | |
+------------------+---------------------------------------------+-----------+
multideleteput
--------------
+--------------------------------+----------------------------------+
| Name | Schema |
+================================+==================================+
| | **appnames** | `appname <#_appname>`__ (array) |
| | *optional* | |
+--------------------------------+----------------------------------+
programpref
-----------
the list of programs in this CDAP app
+--------------+---------------------------------------------+----------+
| Name | Description | Schema |
+==============+=============================================+==========+
| | **program\ | the name of the program | string |
| _id** | | |
| | *optional* | | |
+--------------+---------------------------------------------+----------+
| | **program_ | the preference JSON to set for this program | object |
| \pref** | | |
| | *optional* | | |
+--------------+---------------------------------------------+----------+
| | **program\ | must be one of flows, mapreduce, schedules, | string |
| _type** | spark, workflows, workers, or services | |
| | *optional* | | |
+--------------+---------------------------------------------+----------+
programs
--------
the list of programs in this CDAP app
+--------------+---------------------------------------------+-----------+
| Name | Description | Schema |
+==============+=============================================+===========+
| | **program\ | the name of the program | string |
| _id** | | |
| | *optional* | | |
+--------------+---------------------------------------------+-----------+
| | **program\ | must be one of flows, mapreduce, schedules, | string |
| _type** | spark, workflows, workers, or services | |
| | *optional* | | |
+--------------+---------------------------------------------+-----------+
reconfigput
-----------
+-----------------------------+-----------------------------+------------------+
| Name | Description | Schema |
+=============================+=============================+==================+
| | **config** | the config JSON | object |
| | *required* | | |
+-----------------------------+-----------------------------+------------------+
| | **reconfiguration\_type** | the type of reconfiguration | enum |
| | *required* | | (program-flowlet |
| | | -app-config, |
| | | program-flowlet- |
| | | app-preferences, |
| | | program-flowlet- |
| | | smart) |
+-----------------------------+-----------------------------+------------------+
returncode
----------
an httpreturncode
*Type* : integer
service\_endpoint
-----------------
descirbes a service endpoint, including the service name, the method
name, and the method type (GET, PUT, etc, most of the time will be GET)
+--------------------------+-----------------------------------------+---------+
| Name | Description | Schema |
+==========================+=========================================+=========+
| | **endpoint\_method** | GET, POST, PUT, etc | string |
| | *optional* | | |
+--------------------------+-----------------------------------------+---------+
| | **service\ _endpoint** | the name of the endpoint on the service | string |
| | *optional* | | |
+--------------------------+-----------------------------------------+---------+
| | **service\_name** | the name of the service | string |
| | *optional* | | |
+--------------------------+-----------------------------------------+---------+
service\_method
---------------
a URL and HTTP method exposed via a CDAP service
+--------------+---------------------------------------------+----------+
| Name | Description | Schema |
+==============+=============================================+==========+
| | **method** | HTTP method you can perform on the URL, | string |
| | *optional* | e.g., GET, PUT, etc | |
+--------------+---------------------------------------------+----------+
| | **url** | the fully qualified URL in CDAP for this | string |
| | *optional* | | |
+--------------+---------------------------------------------+----------+
|
