http://git-wip-us.apache.org/repos/asf/hadoop/blob/c07469f9/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services-api/src/main/resources/definition/YARN-Simplified-V1-API-Layer-For-Services.yaml
--
diff --git
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services-api/src/main/resources/definition/YARN-Simplified-V1-API-Layer-For-Services.yaml
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services-api/src/main/resources/definition/YARN-Simplified-V1-API-Layer-For-Services.yaml
index 88f74ef..17f8c95 100644
---
a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services-api/src/main/resources/definition/YARN-Simplified-V1-API-Layer-For-Services.yaml
+++
b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services-api/src/main/resources/definition/YARN-Simplified-V1-API-Layer-For-Services.yaml
@@ -22,7 +22,7 @@ info:
Bringing a new service on YARN today is not a simple experience. The APIs
of existing frameworks are either too low level (native YARN), require writing
new code (for frameworks with programmatic APIs) or writing a complex spec (for
declarative frameworks). In addition to building critical building blocks
inside YARN (as part of other efforts at
link:https://issues.apache.org/jira/browse/YARN-4692[YARN-4692]), there is a
need for simplifying the user facing story for building services. Experience of
projects like Apache Slider running real-life services like HBase, Storm,
Accumulo, Solr etc, gives us some very good insights on how simplified APIs for
services should look like.
-To this end, we should look at a new simple-services API layer backed by
REST interfaces. This API can be used to create and manage the lifecycle of
YARN services. Services here can range from simple single-component apps to
complex multi-component assemblies needing orchestration.
+To this end, we should look at a new simple-services API layer backed by
REST interfaces. This API can be used to create and manage the lifecycle of
YARN services. Services here can range from simple single-component service to
complex multi-component assemblies needing orchestration.
We should also look at making this a unified REST based entry point for
other important features like resource-profile management
(link:https://issues.apache.org/jira/browse/YARN-3926[YARN-3926]),
package-definitions' lifecycle-management and service-discovery
(link:https://issues.apache.org/jira/browse/YARN-913[YARN-913]/link:https://issues.apache.org/jira/browse/YARN-4757[YARN-4757]).
We also need to flesh out its relation to our present much lower level REST
APIs (link:https://issues.apache.org/jira/browse/YARN-1695[YARN-1695]) in YARN
for application-submission and management.
@@ -41,177 +41,177 @@ schemes:
- http
- https
# will be prefixed to all paths
-basePath: /services/v1/
+basePath: /ws/v1/
consumes:
- application/json
produces:
- application/json
paths:
- /applications:
+ /services:
get:
- summary: List of applications/services running in the cluster
- description: Get a list of all currently running applications (response
includes a minimal projection of the application info). For more details do a
GET on a specific application name.
+ summary: List of services running in the cluster
+ description: Get a list of all currently running services (response
includes a minimal projection of the service info). For more details do a GET
on a specific service name.
responses:
200:
- description: An array of applications
+ description: An array of services
schema:
type: array
items:
- $ref: '#/definitions/Application'
+ $ref: '#/definitions/Service'
default:
description: Unexpected error
schema:
-$ref: '#/definitions/ApplicationStatus'
+$ref: '#/definitions/ServiceStatus'
post:
- summary: Create an application/service
- description: Create an application. The request JSON is an Application
object with details required for creation. If the request is successful it
returns 202 Accepted. A success of this API only confirms success in submission
of the application creation request. There is no guarantee that the application
will actually reach a RUNNING state. Resource availability and several other
factors determines if the application will be deployed in the cluster. It is
expected that clients would subsequently call the GET API to get details of the
application and determine its state.
+ summary: Create a service
+ description: Create a service. The request JSON is a service object with
details required for creation. If the request is successful it returns 202
Accepted. A success of this API only