@@ -96,12 +96,16 @@ To build the Deployment Manager, change to the `api` directory, which contains t
9696
9797?recency=n may be used to control how many versions of each package are listed, by default recency=1
9898````
99- GET /repository/packages
99+ GET /repository/packages?user.name=<username>
100100
101101Response Codes:
102102200 - OK
103+ 403 - Unauthorised user
103104500 - Server Error
104105
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+
105109Example response:
106110[
107111 {
@@ -118,24 +122,32 @@ Example response:
118122
119123### List packages currently deployed to the cluster
120124````
121- GET /packages
125+ GET /packages?user.name=<username>
122126
123127Response Codes:
124128200 - OK
129+ 403 - Unauthorised user
125130500 - Server Error
126131
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+
127135Example response:
128136["spark-batch-example-app-1.0.23"]
129137````
130138
131139### Get the status for _ package_
132140````
133- GET /packages/<package>/status
141+ GET /packages/<package>/status?user.name=<username>
134142
135143Response Codes:
136144200 - OK
145+ 403 - Unauthorised user
137146500 - Server Error
138147
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+
139151Example response:
140152{"status": "DEPLOYED", "information": "human readable error message or other information about this status"}
141153
@@ -148,12 +160,16 @@ UNDEPLOYING
148160
149161### Get full information for _ package_
150162````
151- GET /packages/<package>
163+ GET /packages/<package>?user.name=<username>
152164
153165Response Codes:
154166200 - OK
167+ 403 - Unauthorised user
155168500 - Server Error
156169
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+
157173Example response:
158174{
159175 "status": "DEPLOYED",
@@ -179,61 +195,80 @@ Example response:
179195
180196### Deploy _ package_ to the cluster
181197````
182- PUT /packages/<package>
198+ PUT /packages/<package>?user.name=<username>
183199
184200Response Codes:
185201202 - Accepted, poll /packages/<package>/status for status
202+ 403 - Unauthorised user
186203404 - Package not found in repository
187204409 - Package already deployed
188205500 - 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.
189209````
190210
191211### Undeploy _ package_ from the cluster
192212````
193- DELETE /packages/<package>
213+ DELETE /packages/<package>?user.name=<username>
194214
195215Response Codes:
196216202 - Accepted, poll /packages/<package>/status for status
197217403 - Unauthorised user
198218404 - Package not deployed
199219500 - 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.
200223````
201224
202225## Applications API
203226
204227### List all applications
205228````
206- GET /applications
229+ GET /applications?user.name=<username>
207230
208231Response Codes:
209232200 - OK
233+ 403 - Unauthorised user
210234500 - Server Error
211235
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+
212239Example response:
213240["spark-batch-example-app-instance"]
214241````
215242
216243### List applications that have been created from _ package_
217244````
218- GET /packages/<package>/applications
245+ GET /packages/<package>/applications?user.name=<username>
219246
220247Response Codes:
221248200 - OK
249+ 403 - Unauthorised user
222250500 - Server Error
223251
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+
224255Example response:
225256["spark-batch-example-app-instance"]
226257````
227258
228259### Get the status for _ application_
229260````
230- GET /applications/<application>/status
261+ GET /applications/<application>/status?user.name=<username>
231262
232263Response Codes:
233264200 - OK
265+ 403 - Unauthorised user
234266404 - Application not known
235267500 - Server Error
236268
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+
237272Example response:
238273{"status": "STARTED", "information": "human readible error message or other information about this status"}
239274
@@ -249,13 +284,17 @@ DESTROYING
249284
250285### Get run-time details for _ application_
251286````
252- GET /applications/<application>/detail
287+ GET /applications/<application>/detail?user.name=<username>
253288
254289Response Codes:
255290200 - OK
291+ 403 - Unauthorised user
256292404 - Application not known
257293500 - Server Error
258294
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+
259298{
260299 "yarn_applications": {
261300 "oozie-example": {
@@ -274,12 +313,16 @@ Response Codes:
274313
275314### Get the summary status for _ application_
276315````
277- GET /applications/<application>/summary
316+ GET /applications/<application>/summary?user.name=<username>
278317
279318Response Codes:
280319200 - OK
320+ 403 - Unauthorised user
281321404 - Application not known
282322500 - 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.
283326````
284327
285328### Summary status in case of oozie component
@@ -368,7 +411,7 @@ Response Codes:
368411500 - Server Error
369412
370413Query 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 .
372415````
373416
374417### Stop _ application_
@@ -382,18 +425,22 @@ Response Codes:
382425500 - Server Error
383426
384427Query 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 .
386429````
387430
388431### Get full information for _ application_
389432````
390- GET /applications/<application>
433+ GET /applications/<application>?user.name=<username>
391434
392435Response Codes:
393436200 - OK
437+ 403 - Unauthorised user
394438404 - Application not known
395439500 - Server Error
396440
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+
397444Example response:
398445{
399446 "status": "CREATED",
@@ -441,12 +488,13 @@ PUT /applications/<application>?user.name=<username>
441488Response Codes:
442489202 - Accepted, poll /applications/<application>/status for status
443490400 - Request body failed validation
491+ 403 - Unauthorised user
444492404 - Package not found
445493409 - Application already exists
446494500 - Server Error
447495
448496Query 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.
450498
451499Example body:
452500{
@@ -472,18 +520,22 @@ Response Codes:
472520500 - Server Error
473521
474522Query 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.
476524````
477525
478526## Environment Endpoints API
479527### List environment variables known to the deployment manager
480528````
481- GET /environment/endpoints
529+ GET /environment/endpoints?user.name=<username>
482530
483531Response Codes:
484532200 - OK
533+ 403 - Unauthorised user
485534500 - Server Error
486535
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+
487539Example response:
488540{"zookeeper_port": "2181", "cluster_root_user": "cloud-user", ... }
489541````
0 commit comments