Overview
The purpose of this page is to illustrate the plan for ApplicationTemplate and Application consolidation. This work is being tracked in
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
...
Code Block |
---|
public interface ApplicationContext<T extends Config> { T getConfig(); } public interface Application<T extends Config> { void configure(ApplicationConfigurer configurer, ApplicationContext<T> context); } public abstract class AbstractApplication<T> implements Application<T extends Config> { ... protected final ApplicationContext<T> getContext() { return context; } } public class MyApp extends AbstractApplication<MyApp.MyConfig> { public static class MyConfig extends Config { @Nullable private String stream; @Nullable private String table; private MyFlowConfig flowOptions; private MyConfig() { this.stream = "A"; this.table = "X"; } } public void configure() { // ApplicationContext now has a method to get a custom config object whose fields will // be injected using the values given in the RESTful API MyConfig config = getContext().getConfig(); addStream(new Stream(config.stream)); createDataset(config.table, Table.class); addFlow(new MyFlow(config.stream, config.table, config.flowOptions)); } } |
Story Details
Deploying an Application
Users will still be able to deploy an app in one call. Suppose a user wants to deploy their application contained in myapp-1.0.0.jar. They make the same RESTful call they would today:
...
Code Block |
---|
PUT /namespaces/default/apps/myapp2 -H "Content-Type: application/json" -d '{ "artifact": { "name": "myapp", "version": "1.0.0" }, "config": { "stream": "B", "table": "X" } }' |
Deploying an Artifact, then an Application
Users can also deploy an artifact without creating an application.
...
Code Block |
---|
PUT /namespaces/default/apps/myapp3 -H "Content-Type: application/json" -d '{ "artifact": { "name": "my-app", "version": "1.0.1" }, "config": {"stream": "C", "table": "X"} }' |
Updating an Application
Users will also be able to update their applications to use a different version of an artifact.
Code Block |
---|
PUT /namespaces/default/apps/myapp/properties -H "Content-Type: application/json" -d '{ "artifact": { "name":"myapp", "version":"1.0.1" }, "config": { "stream": "A", "table": "X" } }' |
System Artifacts
System artifacts are special artifacts that can be accessed in other namespaces. They cannot be deployed through the RESTful API. Instead, they are placed in a directory on the CDAP master host. When CDAP starts up, the directory will be scanned and those artifacts will be added to the system. Example uses for system artifacts are the ETLBatch and ETLRealtime applications that we want to include out of the box. When a user wants to create an application from a system artifact, they make the same RESTful call as before, except adding the namespace to the artifact section of the call:
...
Code Block |
---|
PUT /namespaces/default/apps/somePipeline -H "Content-Type: application/json" -d '{ "artifact": { "namespace": "system", "name":"ETLBatch", "version":"3.1.0" }, "config": { ... } }' |
RESTful API changes
Application APIs
Type | Path | Body | Headers | Description |
---|---|---|---|---|
GET | /v3/namespaces/<namespace-id>/apps?label=<label> | for example, to get all "ETLBatch" applications | ||
POST | /v3/namespaces/<namespace-id>/apps | application jar contents | Application-Config: <json of config> | same as deploy api today, except allows passing config as a header |
PUT | /v3/namespaces/<namespace-id>/apps/<app-name> | application jar contents | Application-Config: <json of config> | same as deploy api today, except allows passing config as a header |
PUT | /v3/namespaces/<namespace-id>/apps/<app-name> | { 'artifact': 'name-version', 'config': { ... } } | Content-Type: application/json | create an application from an existing artifact. Note: Edits existing API, different behavior based on content-type |
PUT | /v3/namespaces/<namespace-id>/apps/<app-name>/properties | { 'artifact': 'name-version', 'config': { ... } } | update an existing application. No programs can be running |
Artifact APIs
Type | Path | Body | Headers | Description | ||
---|---|---|---|---|---|---|
GET | /v3/namespaces/<namespace-id>/artifacts | |||||
GET | /v3/namespaces/<namespace-id>/artifacts/<artifact-name> | Get data about all artifact versions | ||||
POST | /v3/namespaces/<namespace-id>/artifacts/<artifact-name> | jar contents | Artifact-Version: <version> | Add a new artifact. Version header only needed if Bundle-Version is not in jar Manifest. If both present, header wins. | ||
GET | /v3/namespaces/<namespace-id>/artifacts/<artifact-name>/versions/<version> | Get details about the artifact, such as what plugins and applications are in the artifact and properties they support | ||||
PUT | /v3/namespaces/<namespace-id>/artifacts/<artifact-name>/versions/<version>/plugins | list of plugins contained in the jar | This is required for 3rd party jars, such as the mysql jdbc connector. It is the equivalent of the .json file we have in 3.0 | |||
GET | /v3/namespaces/<namespace-id>/extensions |
| ||||
GET | /v3/namespaces/<namespace-id>/extensions/<plugin-type> | |||||
GET | /v3/namespaces/<namespace-id>/extensions/<plugin-type>/plugins/<plugin-name> | config properties can be nested now. For example:
|
Template APIs (will be removed)
Type | Path | Replaced By |
---|---|---|
GET | /v3/templates | |
GET | /v3/templates/<template-name> | |
GET | /v3/templates/<template-name>/extensions/<plugin-type> | /v3/namespaces/<namespace-id>/extensions/<plugin-type> |
GET | /v3/templates/<template-name>/extensions/<plugin-type>/plugins/<plugin-name> | /v3/namespaces/<namespace-id>/extensions/<plugin-type>/plugins/<plugin-name> |
PUT | /v3/namespaces/<namespace-id>/templates/<template-id> | |
GET | /v3/namespaces/<namespace-id>/adapters | |
GET | /v3/namespaces/<namespace-id>/adapters/<adapter-name> | |
POST | /v3/namespaces/<namespace-id>/adapters/<adapter-name>/start | |
POST | /v3/namespaces/<namespace-id>/adapters/<adapter-name>/stop | |
GET | /v3/namespaces/<namespace-id>/adapters/<adapter-name>/status | |
GET | /v3/namespaces/<namespace-id>/adapters/<adapter-name>/runs | |
GET | /v3/namespaces/<namespace-id>/adapters/<adapter-name>/runs/<run-id> | |
DELETE | /v3/namespaces/<namespace-id>/adapters/<adapter-name> |