Skip to content

Agile-IoT/agile-paas-deployer

BranchesTags

Repository files navigation

unified-paas

Unified PaaS Library

Maintainer: Román SG

The Unified PaaS Library provides a uniform API to manage applications on PaaS providers.

Depending on the supported provider, it accepts deploying applications by:

  • uploading a binary or source code artifact (e.g., a zip containing the code of a NodeJS app or a WAR);
  • specifying the GIT URL of the code to deploy;
  • specifying the name of a Docker image.

Usage in AGILE

To run agile-paas-deployer as an AGILE container, include the following in your agile-stack Dockerfile: https://github.com/Agile-IoT/agile-stack/commit/bdf106750e32e4135ed1b6b7f380d688a35f2201

Usage

  1. Compile project

    $ mvn install

  2. Start server

    $ cd service; bin/runserver.sh

  3. Deploy an application

    $ curl http://localhost:8002/api/heroku/applications -X POST
    -F file=@""
    -F model='{"name":"samplewar"}'
    -H"Content-Type: multipart/form-data"
    -H'X-PaaS-Credentials:{"api-key":""}'

API Overview

Each supported PaaS is a resource on /api. For example, Heroku is on /api/heroku.

Each invocation to the API must contain the credentials in the X-PaaS-Credentials header, in json format. See below for specific instructions per provider.

These are the supported operations:

GET /api

Return a list of the supported subpaths.

$ curl localhost:8002/api
{
  "openshift.com":{
    "name":"OpenShift Online",
    "url":"https://openshift.redhat.com",
    "versions":["v2","v3"],
    "defaultVersion":"v2"
  },
  "pivotal":{
    ...
  }
  ...
}

GET /api/{paas}

Return a description of the provider.

$ curl localhost:8002/api/heroku
{"name":"Heroku","url":"https://api.heroku.com/","versions":["v3"],"defaultVersion":"v3"}

POST /api/{paas}/applications

Creates an application and deploy its artifact. The request is a multipart request with two fields:

  • model: contains information about the application, modelled by the ApplicationToCreate class (see below). The name of the application is here, and is used to refer to the application in the rest of operations.
  • file: the bytes of the artifact, in case we are uploading an artifact.

Examples:

Heroku

$ curl http://localhost:8080/api/heroku/applications -X POST -F file=@"<FILE>" \
-F model='{"name":"<APP_NAME>"}' \
-H"Content-Type: multipart/form-data"

CloudFoundry

$ curl http://localhost:8080/api/pivotal/applications -X POST -F file=@"<FILE>" \
-F model='{"name":"<APP_NAME>", "properties": { "buildpack_url": "https://github.com/cloudfoundry/nodejs-buildpack.git#v1.3.4" }'} \
-H"Content-Type: multipart/form-data"

OpenWhisk

Currently, only single-file nodeJS deployments are supported.

$ curl http://localhost:8080/api/openwhisk/applications -X POST \ 
-F file=@"library/src/test/resources/demo-function.js" \
-F model='{"name":"function", "programmingLanguage":"Node.JS"}' \
-H"Content-Type: multipart/form-data"

GET /api/{paas}/applications/{name}

Returns the status of an application. See Application class.

TODO: example

DELETE /api/{paas}/applications/{name}

Removes an application

TODO: example

PUT /api/{paas}/applications/{name}/start

Starts an application

TODO: example

PUT /api/{paas}/applications/{name}/stop

Stops an application

TODO: example

PUT /api/{paas}/applications/{name}/scale/{updown}

Scales up/down an application adding or removing an instance. Updown have value up or down

TODO: example

PUT /api/{paas}/applications/{name}/scale/{type}/{value}")

Scales the resource 'type' an application by setting 'value' units.

Supported types:

  • instances
  • memory
  • disk

(TO BE COMPLETED)

TODO: example

Credentials

Each invocation to the API must contain the credentials in the X-PaaS-Credentials header in the request. The credentials are serialized in json format, optionally encoded in base64. The fields to be filled in the json for each provider are shown below.

Heroku

  • api-key

CloudFoundry

  • api
  • user
  • password
  • org
  • space

Pivotal, BlueMix

  • user
  • password
  • org
  • space

OpenShift3

  • user
  • password

OpenWhisk

  • api
  • user
  • password

Integration tests

Integration tests are run in integration-test profile. Each integration test have a group according to the PaaS provider being tested. By default, the profile only run tests in dummy group (the dummy provider is a fake provider). The provider to test can be changed passing an integration.groups parameter to the mvn command.

Ex: mvn verify -P integration-test -Dintegration.groups=openshift2,cloudfoundry

Configuration

  • Set values in /library/src/test/resources/tests.config.properties
  • Start instance of service: cd service && bin/runserver.sh

Integration Tests

  • Execute tests: mvn clean verify -P integration-test [-Dintegration.groups=...]

Java Client Libraries

Java client libraries used in the project:

Cloud Foundry

Description
The cf-java-client project is a Java language binding for interacting with a Cloud Foundry instance (including PaaS providers like Pivotal, Bluemix etc.).
Features
Feature Supported? Comments
Application deployment ✅ Tested with Java and PHP apps
Start / Stop / Remove ✅ ➖
Scaling capabilities ✅ Can scale number of instances, disk and RAM
Services management ✅ Tested with ClearDB from Pivotal
Environment variables management ✅ Read & Write

| Limitations / Comments | | ------------- || | ➖ |

Description
The new version of the cf-java-client project is based on Java 8 and [Project Reactor](https://projectreactor.io/) (a second-generation Reactive library for building non-blocking applications on the JVM based on the Reactive Streams Specification).
Features
-Not implemented-

Heroku

Description
[Heroku JAR](https://github.com/heroku/heroku.jar): The Heroku JAR is a java artifact that provides a simple wrapper for the Heroku REST API. The Heroku REST API allows Heroku users to manage their accounts, applications, addons, and other aspects related to Heroku.
[heroku-maven-plugin](https://github.com/heroku/heroku-maven-plugin): This plugin is used to deploy Java applications directly to Heroku without pushing to a Git repository. This is can be useful when deploying from a CI server, deploying pre-built Jar or War files.
Features
Feature Supported? Comments
Application deployment ✅ Tested with Java
Start / Stop / Remove ✅ ➖
Scaling capabilities ✅ Can scale number of instances
Services management ✅ Tested with ClearDB from Pivotal
Environment variables management ✅ Read & Write

| Limitations / Comments | | ------------- || | ➖ |

OpenShift

Description
Java client for the OpenShift REST API. This client is used by JBoss Tools for OpenShift 2.x.
Features
Feature Supported? Comments
Application deployment ✅ ❗ Only from GIT
Start / Stop / Remove ✅ ➖
Scaling capabilities ✅ Can scale number of instances
Services management ✅ Tested with MySQL from Openshift Online
Environment variables management ❌ ➖

| Limitations / Comments | | ------------- || | ➖ |

  • 🆕 Openshift v3 (new version for the version 3 architecture of OpenShift based on Kubernetes: OpenShift Enterprise, local Openshift installations ...)
Description
-Not implemented-
Features
➖
Client Version used License Comments
Cloud Foundry 1.1.3 Apache License v2 ➖
🆕 Cloud Foundry ➖ Apache License v2 ➖
Heroku 0.16 / 0.5.7** ➖ / MIT License** ➖
Openshift v2 2.7.0.Final Eclipse Public License v1.0 ➖
🆕 Openshift v3 ➖ ➖ ➖

About

No description, website, or topics provided.

Resources

Readme

License

EPL-2.0, Unknown licenses found

Licenses found

EPL-2.0
LICENSE
Unknown
LICENSE-header.txt
Activity
Custom properties

Stars

0 stars

Watchers

9 watching

Forks

0 forks
Report repository

Releases

5 tags

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages