Terminology

...

Table of Contents

Mocks

These mocks (not final) give an idea of the flow users will go through in order to install a package from the Cask Market.

The user clicks the '+' button, they will see the list of groups from which they can choose and add a package. For example, 'Hydrator Plugins', or 'Example Applications' could both be groups.then selects a 'category' from the left sidebar to list 'packages' that can be installed.

Image Added

When the user chooses a package to install, more information is displayed, including one or more steps involved in installing the package. Each step is a wizard for creating some CDAP entity.

Image Added

Terminology

package - A collection of entities (artifacts, applications, datasets, streams) to add to CDAP. A package is identified by a name and version, and belongs to a groupcan be tagged with one or more categories. A package consists of an archive of resources (tarball) and a package spec.

package spec - A json file containing a list of actions to perform against CDAP. For example, a spec for the Purchase History example will include an action to add the Purchase History artifact, then an action to create an application from that artifact.

package archive - A tarball zip containing any resources needed to perform the actions in the package spec. For example, if the spec contains an action to add an artifact, the archive must contain the jar file to add.

APIs

All APIs are relative to a base path. For example, cask.co/marketplace/v1. In the initial version, there will only be GET APIs. 

List Groups

GET /groups
ex: GET /groups
[
  {
    "name": "examples",
    "label": "Examples",
    "description": "Example applications to get started with CDAP."
  },
  {
    "name": "hydrator-plugins",
    "label": "Hydrator Plugins",
    "description": "Collections of plugins to extend Hydrator functionality."
  },
  ...
]

Get Group Icon

GET /groups/<group>/icon
ex: GET /groups/examples/icon 
[binary image contents]

List Packages in a Group

...

category - A package can be tagged with one or more categories. A category corresponds to one of the tabs on the left bar of the mocks.

Architecture

There will be a set of marketplace APIs that the UI will use to get categories and packages. In the first version of the market, the APIs will simply be static content served from S3. This essentially amounts to placing packages in a pre-determined directory structure, and generating a file that lists all packages in the repository.

There will be an internal process to push the entire market repository to S3. If a user wishes to host their own marketplace, they can do so by sticking a server (apache httpd for example) on top of a local directory structure.

APIs

The APIs are simply a contract about the directory structure of the marketplace. All APIs are relative to a base path. For example, cask.co/marketplace/v1. The structure is expected to be:

GET
<base>/v1/packages.json
<base>/v1/packages/<package-name>/<version>/icon.png
<base>/v1/packages/<package-name>/<version>/license.txt
<base>/v1/packages/<package-name>/<version>/spec.json
<base>/v1/packages/<package-name>/<version>/spec.json.asc
<base>/v1/packages/<package-name>/<version>/archive.zip
<base>/v1/packages/<package-name>/<version>/archive.zip.asc

The packages.json and signature files could be generated from all the package spec.json files using a tool.

List all Packages

GET /v1/<cdap-version>/packages.json
ex: GET /v1/packages.json
[
  {
    "name": "PurchaseExample",
    "label": "Purchase History",
    "description": "Example Application demonstrating usage of flows, workflows, mapreduce, and services.",
    "author": "Cask",
    "org": "Cask Data Inc.",
    "version": "4.0.1",
    "categories": [ "examples" ],
    "cdapVersion": "[4.0.0,4.1.0)
  },
  {
    "name": "HelloWorld",
    "label": "Hello World",
    "description": "Simple application demonstrating usage of flows and services.",
    "author": "Cask",
    "org": "Cask Data Inc.",
  },  "version": "4...
]

Get Package Icon

GET /groups/<group>/packages/<package>/icon
ex: GET /groups/examples/packages/PurchaseExample/icon
[binary image contents]

List Package Versions

GET /groups/<group>/packages/<package>/versions
ex: GET /groups/examples/packages/PurchaseExample/versions
[
  {    
    "name": "PurchaseExample",
    "label": "Purchase History",
    "description": "Example Application demonstrating usage of flows, workflows, mapreduce, and services.",
    "author": "Cask",
    "org": "Cask Data Inc."
    "version": "4.0.1",
    "created": 1234567899,
    "changelog": [
      "fixed a small parsing bug"
    ]
  },
  {    
    "name": "PurchaseExample",
    "label": "Purchase History",
    "0.0",
    "categories": [ "examples" ],
    "cdapVersion": "[4.0.0,4.1.0)"
  },
  ...
]

This list is not expected to change often. It can be cached by the UI if needed. The 'cdapVersion' specifies which versions of cdap the package is compatible with. If none is given, it is compatible with all versions.

Get Package Archive

GET /v1/packages/<package-name>/<version>/archive.zip
ex: GET /v1/packages/PurchaseExample/4.0.1/archive.zip
[ binary archive contents] 

Get Package Archive Signature

GET /v1/packages/<package-name>/<version>/archive.zip.asc
ex: GET /v1/packages/PurchaseExample/4.0.1/archive.zip.asc
[ archive signature ] 

Get Package Spec

GET /v1/packages/<package-name>/<version>/spec.json
ex: GET /v1/packages/PurchaseExample/4.0.0/spec.json
{
  "specVersion": "1.0",
  "name": "PurchaseExample",
  "label": "Purchase History",
  "description": "Example Application demonstrating usage of flows, workflows, mapreduce, and services.",

   "author": "Cask",
    "org": "Cask Data Inc.",
    "version": "4.0.0",
    "created": 12345678901234567899,
 
  "changelogcdapVersion": "[4.0.0,4.1.0)",
  "changelog": "fixed a small parsing bug"updated,
APIs to work with CDAP 4.0.0"
"categories": [ "examples" ],
  "actions": [
   ] {
       }"type": "create_artifact",
  ...
]

Get Package Archive

GET /groups/<group>/packages/<package>/versions/<version>/archive.tgz
ex: GET /groups/examples/packages/PurchaseExample/versions/4.0.1/archive.tgz
[ binary archive contents] 

Get Package Archive Signature

GET /groups/<group>/packages/<package>/versions/<version>/archive.tgz.asc
ex: GET /groups/examples/packages/PurchaseExample/versions/4.0.1/archive.tgz.asc
[ archive signature ] 

Get Package Spec

GET /groups/<group>/packages/<package>/versions/<version>/spec
ex: GET /groups/examples/packages/PurchaseExample/versions/4.0.1/spec
{
  "metadata": {    "arguments": [
        {
          "name": "name",
          "spec-versionvalue": "1.0",PurchaseHistoryExample"
    },   "name": "PurchaseExample" },
  "label": "Purchase History",      "description": "Example Application demonstrating usage of flows, workflows, mapreduce, and services.",
  "author{
          "name": "Caskversion",
    "org": "Cask Data Inc.",   "versionvalue": "4.0.1",
   "created": 1234567899,   "changelog": [ },
    "fixed a small parsing bug"{
  ],   "actions     "name": ["scope",
    {       "typevalue": "create_artifactuser",
       "arguments": [ },
        {
          "widget-typename": "constantjar",
          "namevalue": "name",PurchaseHistoryExample-4.0.1.jar"
        }
 "value": "PurchaseHistoryExample"    ]
    },
        {
  
       "widget-type": "constantcreate_app",
      "arguments": [
  "name": "version",
          "value": "4.0.1"
        },
        {
          "widget-typename": "constantname",
          "namedefault": "scopePurchaseHistory",
        }
 "value": "user"    ]
    },
  ]
     {
          "widget-type": "constant",
          "name": "jar",
          "value": "PurchaseHistoryExample-4.0.1.jar"
        }
      ]
    },
    {
      "type": "create_app",
      "arguments": [
        {
          "widget-type": "textbox",
          "name": "name",
          "default": "PurchaseHistory"
        }
      ]
    }
  ],
  "dependencies": {
    "cdap": {
      "minVersion": "4.0.0",
      "maxVersion": "4.1.0"
    }
  }
}

Get Package Spec Signature

GET /groups/<group>/packages/<package>/versions/<version>/spec.asc
ex: GET /groups/examples/packages/PurchaseExample/versions/4.0.1/spec.asc
[ spec signature ]

Security

Since people will be able to download code from the marketplace, it is especially important that there is protection against malicious code. We can make use of PGP in order to sign both the package archive and the package spec that are downloadable from the marketplace. The Market UI will have to be configured to use a GPG key (for the public CDAP marketplace, we could re-use the GPG key used for CDAP rpms and debians or create another one). It can then use that public key along with the signature APIs to verify that the spec and archive were signed by the owner of the package.

Package Spec

The package spec contains some metadata about the spec itself, and a list of actions to perform on the CDAP instance. It is a JSON file of the following structure:

{
  "metadata": {
    "spec-version": "1.0"
  },
  "actions": [
    actionspec1,
    actionspec2,
    ...
  ]
}

The actions in the spec will correspond to steps in the UI wizard for installing the package.

Action Spec

Each action will contain a type, a list of arguments, and dependencies. Each type of action will require different arguments. In the first version, the following types will be supported: create_artifact, create_app, create_stream, create_dataset, create_hydrator_draft.

{
  "type": "create_artifact" | "create_app" | "create_stream" | "create_dataset" | "create_hydrator_draft",
  "arguments": [
    {
      "name": [argument name],
      "value": [argument value],
      "canModify": true | false
    }
  ]
}

Some arguments can be modified by users in the resulting wizard. For example, the name of an application may be a field that the user should be able to edit.

create_artifact

Results in a call to http://docs.cdap.io/cdap/current/en/reference-manual/http-restful-api/artifact.html#add-an-artifact

...

yes

...

}

Get Package Spec Signature

GET /v1/packages/<package-name>/<version>/spec.asc
ex: GET /v1/packages/PurchaseExample/4.0.0/spec.asc
[ spec signature ]

Get Package Icon

GET /v1/packages/<package-name>/<version>/icon.png
ex: GET /v1/packages/PurchaseExample/4.0.0/icon.png
[ icon bytes ]

Get Package License

GET /v1/packages/<package-name>/<version>/license.txt
ex: GET /v1/packages/PurchaseExample/4.0.0/license.txt
Copyright © 2014-2016 Cask Data, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
...

Security

Since people will be able to download code from the marketplace, it is especially important that there is protection against malicious code. We can make use of PGP in order to sign both the package archive and the package spec that are downloadable from the marketplace. The Market UI will have to be configured to use a GPG key (for the public CDAP marketplace, we could re-use the GPG key used for CDAP rpms and debians or create another one). It can then use that public key along with the signature APIs to verify that the spec and archive were signed by the owner of the package. There will also be a setting that lets people turn off signature checking in case its not needed for internally hosted repositories.

Package Spec

The package spec contains some metadata about the spec itself, and a list of steps to perform on the CDAP instance. It is a JSON file of the following structure:

{
  "specVersion": "1.0"
  "name": "<name>",
  "version": "<version>",
  "label": "<label>",
  "description": "<description>",
  "org": "<org>",
  "categories": [ <categories> ],
  "cdapVersion": "<compatible-versions>",
  "changelog": "<changes>",
  "actions": [
    actionspec1,
    actionspec2,
    ...
  ]
}

The actions in the spec will correspond to steps in the UI wizard for installing the package.

Action Spec

Each action will contain a type, a list of arguments, and dependencies. Each type of action will require different arguments. In the first version, the following types will be supported: create_artifact, create_app, create_stream, create_dataset.

{
  "type": "create_artifact" | "create_app" | "create_stream" | "create_dataset" | "load_datapack" | "install_package"
  "arguments": [
    {
      "name": [argument name],
      "value": [argument value],
      "canModify": true | false (defaults to false)
    }
  ]
}

Some arguments can be modified by users in the resulting wizard. For example, the name of an application may be a field that the user should be able to edit.

create_artifact

Results in a call to http://docs.cdap.io/cdap/current/en/reference-manual/http-restful-api/artifact.html#add-an-artifact

create_app

Results in a call to http://docs.cdap.io/cdap/current/en/reference-manual/http-restful-api/lifecycle.html#create-an-application

create_stream

Results in a call to http://docs.cdap.io/cdap/current/en/reference-manual/http-restful-api/stream.html#creating-a-stream

...

create_dataset

...

create_dataset

Results in a call to Results in a call to http://docs.cdap.io/cdap/current/en/reference-manual/http-restful-api/dataset.html#creating-a-dataset

...

load_

...

datapack

Loads a datapack into some dataset or stream.

install_package

Installs another package from the marketplace.

Dependencies

Packages will only be able to specify dependencies on the CDAP version, as well as dependencies on the existence of specific CDAP entities. For example, the core-plugins-1.5.0 package requires that there exist system artifacts cdap-data-pipeline-4.0.0 and cdap-data-streams-4.0.0 in the CDAP instance.

...

Failures

Since a package spec can contain multiple actions, what happens if some actions succeed and then one action fails? We will not attempt rollback or anything like that. Instead, all the wizards that execute the actions must be idempotent. For example, if told to add an artifact and the artifact already exists, the step can simply be skipped.

Hosting a Custom Marketplace

To host a custom marketplace, users can run an apache httpd server on top of a local directory structure. To make this easier, we could create a github repository of all the public packages hosted by Cask. The repository will follow the directory structure documented here, and have a script at the top level that builds the zip, signs the zips and specs, and generates the packages.json file. 

Example Use Cases

Scenario 1: Add a draft of a SFDC Lead Dump Hydrator pipeline

When the user clicks on the '+' button, the UI makes a call to get all the packages it can install:

GET /v1/packages.json
[
  ...,
  {
    "name": "sfdc-lead-dump",
      "label": "SFDC Lead Dump",
    "namedescription": "spark-plugins"Reads SFDC data from a CDAP Stream, filters invalid records, and dumps the data to a "minVersion": "1.5.0",
  CDAP Table.",
     "maxVersionauthor": "1.6.0Cask",
    "org":  }"Cask Data Inc.",
      ...
    ]"version": "1.0.0",
    "streamscategories": [       { "name": "smsTexts" }
    ],
    "datasets": [
      { "name": "spamTexts" }
    ]
  }
}

Failures

Since a package spec can contain multiple actions, what happens if some actions succeed and then one action fails? Since the CDAP APIs backing these actions are idempotent, we can ask the user if they want to retry.

Architecture

There will be a set of marketplace APIs that the UI will use to get groups, packages, package versions, icons, and package tarballs. There will be a market server that powers these APIs.  The server will use a set of internal storage interfaces that define how to read the information required by the APIs. We can start with a storage implementation that simply reads from local files, and perhaps another storage implementation that reads from cloud storage like S3.

Image Removed

The market server will be stateless, so a load balancer can be placed in front of it to ensure that it is highly available and to ensure that it can handle a high volume of requests

Image Removed

File Store

The first implementation of the storage layer can simply be a store that looks at a filesystem for files containing the relevant information. The File Store will expect a specific directory structure:

<base dir>/<group>/icon.jpg
<base dir>/<group>/meta.json
<base dir>/<group>/<package>/<version>/spec.json
<base dir>/<group>/<package>/<version>/icon.jpg
<base dir>/<group>/<package>/<version>/archive.tgz
 
ex:
/opt/cdap/marketplace/examples/icon.jpg
/opt/cdap/marketplace/examples/meta.json
/opt/cdap/marketplace/examples/PurchaseExample/4.0.1/archive.tgz
/opt/cdap/marketplace/examples/PurchaseExample/4.0.1/spec.json
/opt/cdap/marketplace/examples/PurchaseExample/4.0.1/icon.jpg
/opt/cdap/marketplace/examples/PurchaseExample/4.0.0/archive.tgz
/opt/cdap/marketplace/examples/PurchaseExample/4.0.0/spec.json
/opt/cdap/marketplace/examples/PurchaseExample/4.0.0/icon.jpg

On start up, the server will scan the base directory, load relevant information into memory, and simply serve data based on the contents of the files. This would also let ops teams manage the marketplace through use of 'group' packages and 'cask package' packages. 

Note: with such little logic in the server, why bother having a server at all? Why not just stick an Apache server in front of files or serve directly from S3? The assumption is that we will need to add more complicated functionality in the future, such as APIs to add groups and packages, ability to search for packages by various fields, etc.

Example Use Cases

Scenario 1: Add a draft of a SFDC Lead Dump Hydrator pipeline

The marketplace has a group called 'Hydrator Pipelines'

When the user clicks on the '+' button, the UI makes a call:

GET /groups
[
  {"hydrator-pipelines" ]
  },
  ...
]

Among that list is version 1.0.1 of the 'SFDC Lead Dump' package, which the user clicks on. The UI makes a call to get the license for that package:

GET /v1/packages/sfdc-lead-dump/1.0.0/license.txt
[ apache2 license ]

The user accepts the conditions, and the UI makes a call to get the spec for that package:

GET /v1/packages/sfdc-lead-dump/1.0.0/spec.json
{
  "name": "sfdc-lead-dump",
  "label": "SFDC Lead Dump",
  "description": "Reads SFDC data from a CDAP Stream, filters invalid records, and dumps the data to a CDAP Table.",
  "author": "Cask",
  "org": "Cask Data Inc.",
  "version": "1.0.1",
  "created": 1234567899,
  "changelog": "",
  "actions": [
    {
      "type": "create_artifact",
      "arguments": [
        {
          "name": "scope",
          "value": "user"
        },
        {
          "name": "examplesname",
    "label": "Examples",     "descriptionvalue": "Examplesfdc-plugins"
applications to get started with CDAP."   },
        {
          "name": "hydrator-pipelinesversion",
    "label": "Hydrator Pipelines",     "descriptionvalue": "Templates of various Hydrator pipelines.""1.0.0"
        },
     ...
]

to display all the different types of things the user can add. Among that list is 'Hydrator Pipelines', which the user clicks on. The UI makes another call to list the packages in the 'Hydrator Pipelines' group:

GET /groups/hydrator-plugins/packages
[
  ...,
  {   {
          "name": "config",
          "namevalue": "sfdc-lead-dump",
    "label": "SFDC Lead Dump",plugins.json" // file in the archive
       "description": "Reads SFDC data from a CDAP Stream, filters invalid records, and dumps the data to a CDAP Table.", },
        {
          "authorname": "Caskjar",
          "orgvalue": "Cask Data Inc.sfdc-plugins.jar" // file },in the archive
 ...
]

Among that list is the 'SFDC Lead Dump' package, which the user clicks on. The UI makes a call to get all versions of that package:

GET /groups/hydrator-plugins/packages/sfdc-lead-dump/versions
[
  {       }
    "name": "sfdc-lead-dump",
 ]
   "label": "SFDC Lead Dump", },
    {
      "descriptiontype": "create_app"Reads,
SFDC data from a CDAP Stream, filters invalid records, and dumps the data to a CDAP Table.", "arguments": [
        {
    "author": "Cask",     "orgname": "Cask Data Inc.artifact",
    "version": "1.0.1",     "createdvalue": 1234567899,{
    "changelog": [       "fixed a small parsing bug"scope": "system",
       ],     "dependenciesname": {"cdap-data-pipeline",
      "cdap": {         "minVersionversion": "4.0.0",
          "maxVersion": "4.1.0"}
        },
        {
}    },   ... ]

It defaults to the most recent version that is compatible with the version of CDAP that is running. The user decides to install the package, so the UI makes a call to get the package spec:

GET /groups/hydrator-plugins/packages/sfdc-lead-dump/versions/1.0.1/spec
{   "name": "sfdc-lead-dumpname",
  "label":         "value": "SFDC Lead Dump",
          "descriptioncanModify": true
  "Reads SFDC data from a CDAP Stream},
     filters  invalid records,{
and dumps the data to a CDAP Table.",   "authorname": "Caskconfig",
  "org": "Cask Data Inc.",        "versionvalue": "1sfdc.0.1",
  "created": 1234567899,json" // file in the archive
  "changelog": [     "fixed}
a small parsing bug"   ],
  "actions": [ }
   {
      "type": "create_artifact",
      "arguments": [
        {
          "name": "scope",
          "value": "user]
}

The UI also gets the spec signature to validate the spec:

GET /v1/packages/sfdc-lead-dump/1.0.1/spec.json.asc

The UI also fetches the package archive and signature. It validates the package, and unzips the archive to a local temporary directory so that it can use its resources to create the plugins artifact and create the hydrator draft

GET /v1/packages/sfdc-lead-dump/1.0.1/archive.zip
GET /v1/packages/sfdc-lead-dump/1.0.1/archive.zip.asc

Based on the package spec, the UI can setup the relevant wizards and make the relevant CDAP calls to first create the plugin artifact, and next create the Hydrator pipeline.

Scenario 7: Add MySQL jdbc driver as a Hydrator plugin.

When the user clicks on the '+' button, the UI makes a call to list all packages that can be added to CDAP:

GET /v1/packages.json
[
  ...,
  {
    "name": "mysql-jdbc-driver",
          "canModify"label": false"MySQL JDBC Driver",
    "description": "JDBC },Driver for MySQL databases.",
     {"author": "MySQL",
    "org": "Oracle",
    "nameversion": "name5.1.39",
    "categories": [     "value": "sfdc"hydrator-plugins", ]
  },
  ...
]

Among the list is the MySQL JDBC Driver, which the user clicks on. The UI makes a call to get the license for that package:

GET /v1/packages/mysql-jdbc-driver/5.1.39/license.txt
[ "canModify": false
        },
        {
  gpl license ]

The user accepts the conditions, and the UI makes a call to get the spec for that package:

GET /v1/packages/mysql-jdbc-driver/5.1.39/spec.json
{    
   "name": "versionmysql-jdbc-driver",
  "label": "MySQL JDBC   Driver",
  "valuedescription": "1.0.0JDBC Driver for MySQL databases.",
  "author": "MySQL",
  "org": "Oracle",
  "canModifyversion": false"5.1.39",
  "categories": [ "hydrator-plugins" ]
  }"created": 1234567899,
  "actions": [
    {
          "nametype": "parentscreate_artifact",
  
       "valuearguments": "system:cdap-data-pipeline[4.0.0,4.1.0)",
        {
 "canModify": false         }
      ]
    }"name": "scope",
    {       "typevalue": "create_hydrator_draft",user"
       "arguments": [ },
        {
          "name": "artifactname",
          "value": { "mysql-connector-java"
        },
    "scope": "system",    {
          "name": "cdap-data-pipelineversion",
            "versionvalue": "45.01.039"

         },
          "canModify":
false         },
        {
          "name": "nameexternalArchive",
          "value": "SFDC Lead Dump",https://dev.mysql.com/downloads/file/?id=462849"
          "canModify": true
        },
        {
          "name": "configexternalArchiveSignature",
          "value": "https: { [hydrator config here] },//dev.mysql.com/downloads/gpg/?file=mysql-connector-java-5.1.39.zip.gz"
        },
        {
           "canModify": false"name": "externalArchiveJar",
          "value": "mysql-connector-java-5.1.39-bin.jar"
        },
      ]
    }
  ]
}

Scenario 7: Add MySQL jdbc driver as a Hydrator plugin.

...

  {
          "name": "config",
          "value": "mysql-connector-java-5.1.39.json" // file in the archive containing parents and plugins
        }
      ]
    }
  ]
}

The UI also makes a call to get the spec signature to make sure it is valid:

GET /v1/packages/mysql-jdbc-driver/versions/5.1.39/spec.asc

The UI then makes calls to get the archive and its signature to validate the archive, and unzip it in a local directory. It uses the jar and json config file contained in the archive to make a request to add the artifact to cdap.

GET /v1/packages/mysql-jdbc-driver/5.1.39/archive.zip.asc
GET /v1/packages/mysql-jdbc-driver/5.1.39/archive.zip