@@ -96,12 +96,16 @@ To build the Deployment Manager, change to the `api` directory, which contains t
96
96
97
97
?recency=n may be used to control how many versions of each package are listed, by default recency=1
98
98
````
99
- GET /repository/packages
99
+ GET /repository/packages?user.name=<username>
100
100
101
101
Response Codes:
102
102
200 - OK
103
+ 403 - Unauthorised user
103
104
500 - Server Error
104
105
106
+ Query Parameters:
107
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
108
+
105
109
Example response:
106
110
[
107
111
{
@@ -118,24 +122,32 @@ Example response:
118
122
119
123
### List packages currently deployed to the cluster
120
124
````
121
- GET /packages
125
+ GET /packages?user.name=<username>
122
126
123
127
Response Codes:
124
128
200 - OK
129
+ 403 - Unauthorised user
125
130
500 - Server Error
126
131
132
+ Query Parameters:
133
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
134
+
127
135
Example response:
128
136
["spark-batch-example-app-1.0.23"]
129
137
````
130
138
131
139
### Get the status for _ package_
132
140
````
133
- GET /packages/<package>/status
141
+ GET /packages/<package>/status?user.name=<username>
134
142
135
143
Response Codes:
136
144
200 - OK
145
+ 403 - Unauthorised user
137
146
500 - Server Error
138
147
148
+ Query Parameters:
149
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
150
+
139
151
Example response:
140
152
{"status": "DEPLOYED", "information": "human readable error message or other information about this status"}
141
153
@@ -148,12 +160,16 @@ UNDEPLOYING
148
160
149
161
### Get full information for _ package_
150
162
````
151
- GET /packages/<package>
163
+ GET /packages/<package>?user.name=<username>
152
164
153
165
Response Codes:
154
166
200 - OK
167
+ 403 - Unauthorised user
155
168
500 - Server Error
156
169
170
+ Query Parameters:
171
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
172
+
157
173
Example response:
158
174
{
159
175
"status": "DEPLOYED",
@@ -179,61 +195,80 @@ Example response:
179
195
180
196
### Deploy _ package_ to the cluster
181
197
````
182
- PUT /packages/<package>
198
+ PUT /packages/<package>?user.name=<username>
183
199
184
200
Response Codes:
185
201
202 - Accepted, poll /packages/<package>/status for status
202
+ 403 - Unauthorised user
186
203
404 - Package not found in repository
187
204
409 - Package already deployed
188
205
500 - Server Error
206
+
207
+ Query Parameters:
208
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
189
209
````
190
210
191
211
### Undeploy _ package_ from the cluster
192
212
````
193
- DELETE /packages/<package>
213
+ DELETE /packages/<package>?user.name=<username>
194
214
195
215
Response Codes:
196
216
202 - Accepted, poll /packages/<package>/status for status
197
217
403 - Unauthorised user
198
218
404 - Package not deployed
199
219
500 - Server Error
220
+
221
+ Query Parameters:
222
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
200
223
````
201
224
202
225
## Applications API
203
226
204
227
### List all applications
205
228
````
206
- GET /applications
229
+ GET /applications?user.name=<username>
207
230
208
231
Response Codes:
209
232
200 - OK
233
+ 403 - Unauthorised user
210
234
500 - Server Error
211
235
236
+ Query Parameters:
237
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
238
+
212
239
Example response:
213
240
["spark-batch-example-app-instance"]
214
241
````
215
242
216
243
### List applications that have been created from _ package_
217
244
````
218
- GET /packages/<package>/applications
245
+ GET /packages/<package>/applications?user.name=<username>
219
246
220
247
Response Codes:
221
248
200 - OK
249
+ 403 - Unauthorised user
222
250
500 - Server Error
223
251
252
+ Query Parameters:
253
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
254
+
224
255
Example response:
225
256
["spark-batch-example-app-instance"]
226
257
````
227
258
228
259
### Get the status for _ application_
229
260
````
230
- GET /applications/<application>/status
261
+ GET /applications/<application>/status?user.name=<username>
231
262
232
263
Response Codes:
233
264
200 - OK
265
+ 403 - Unauthorised user
234
266
404 - Application not known
235
267
500 - Server Error
236
268
269
+ Query Parameters:
270
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
271
+
237
272
Example response:
238
273
{"status": "STARTED", "information": "human readible error message or other information about this status"}
239
274
@@ -249,13 +284,17 @@ DESTROYING
249
284
250
285
### Get run-time details for _ application_
251
286
````
252
- GET /applications/<application>/detail
287
+ GET /applications/<application>/detail?user.name=<username>
253
288
254
289
Response Codes:
255
290
200 - OK
291
+ 403 - Unauthorised user
256
292
404 - Application not known
257
293
500 - Server Error
258
294
295
+ Query Parameters:
296
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
297
+
259
298
{
260
299
"yarn_applications": {
261
300
"oozie-example": {
@@ -274,12 +313,16 @@ Response Codes:
274
313
275
314
### Get the summary status for _ application_
276
315
````
277
- GET /applications/<application>/summary
316
+ GET /applications/<application>/summary?user.name=<username>
278
317
279
318
Response Codes:
280
319
200 - OK
320
+ 403 - Unauthorised user
281
321
404 - Application not known
282
322
500 - Server Error
323
+
324
+ Query Parameters:
325
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
283
326
````
284
327
285
328
### Summary status in case of oozie component
@@ -368,7 +411,7 @@ Response Codes:
368
411
500 - Server Error
369
412
370
413
Query Parameters:
371
- user - User with permisson to perform this action on the application should be passed .
414
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml .
372
415
````
373
416
374
417
### Stop _ application_
@@ -382,18 +425,22 @@ Response Codes:
382
425
500 - Server Error
383
426
384
427
Query Parameters:
385
- user - User with permisson to perform this action on the application should be passed .
428
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml .
386
429
````
387
430
388
431
### Get full information for _ application_
389
432
````
390
- GET /applications/<application>
433
+ GET /applications/<application>?user.name=<username>
391
434
392
435
Response Codes:
393
436
200 - OK
437
+ 403 - Unauthorised user
394
438
404 - Application not known
395
439
500 - Server Error
396
440
441
+ Query Parameters:
442
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
443
+
397
444
Example response:
398
445
{
399
446
"status": "CREATED",
@@ -441,12 +488,13 @@ PUT /applications/<application>?user.name=<username>
441
488
Response Codes:
442
489
202 - Accepted, poll /applications/<application>/status for status
443
490
400 - Request body failed validation
491
+ 403 - Unauthorised user
444
492
404 - Package not found
445
493
409 - Application already exists
446
494
500 - Server Error
447
495
448
496
Query Parameters:
449
- user - User creating this application should be passed.
497
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
450
498
451
499
Example body:
452
500
{
@@ -472,18 +520,22 @@ Response Codes:
472
520
500 - Server Error
473
521
474
522
Query Parameters:
475
- user - User with permisson to perform this action on the application should be passed.
523
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
476
524
````
477
525
478
526
## Environment Endpoints API
479
527
### List environment variables known to the deployment manager
480
528
````
481
- GET /environment/endpoints
529
+ GET /environment/endpoints?user.name=<username>
482
530
483
531
Response Codes:
484
532
200 - OK
533
+ 403 - Unauthorised user
485
534
500 - Server Error
486
535
536
+ Query Parameters:
537
+ user.name - User name to run this command as. Should have permissions to perform the action as defined in authorizer_rules.yaml.
538
+
487
539
Example response:
488
540
{"zookeeper_port": "2181", "cluster_root_user": "cloud-user", ... }
489
541
````
0 commit comments