Reactive Runtime Bundle Plugin

Introduction

A plugin that uses the sbt-native-packager to produce Reactive Runtime bundles.

The plugin will take any package that you have presently configured and wrap it in a bundle.

Usage

In addition to declaring the sbt-native-packager, declare the plugin (typically in a plugins.sbt):

addSbtPlugin("com.typesafe.sbt" % "sbt-bundle" % "0.1.0")

Declaring the native packager or any of its other plugins should be sufficient. For example, in your build.sbt file:

lazy val root = (project in file(".")).enablePlugins(SbtNativePackager)

Reactive Runtime Bundles

Reactive Runtime has its own bundle format in order for components to be described. In general there is a one-to-one correlation between a bundle and a component, but it is also possible to have multiple components per bundle. You may want to do this when there is a strong dependency between one component and another. For example, perhaps a Play 2.2 applications requires a specific version of Nginx to proxy it (not that this is a real situation, just an example).

Bundles provide Reactive Runtime with some basic knowledge about components; in particular, what is required in order to start a component. The following is an example of a bundle.conf (Typesafe configuration is used):

version = "1.0.0"
application = "angular-seed-play-1.0-SNAPSHOT"
components = {
  "angular-seed-play-1.0-SNAPSHOT" = {
    description      = "angular-seed-play"
    file-system-type = "universal"
    start-command    = ["bin/angular-seed-play"]
    endpoints        = {web = ["http://0.0.0.0:9000","http://0.0.0.0:9000"]}
  }
}

## Settings

The following settings are provided:

Name         | Description 
-------------|-------------
application  | A logical name that can be used to associate multiple bundles with each other.
bundleConf   | The bundle configuration file contents.
bundleType   | The type of configuration that this bundling relates to. By default Universal is used.
endpoints    | Provides a port mapping between an external facing endpoing and an internal one. The default is `Map("web" -> ("http://0.0.0.0:9000" -> "http://0.0.0.0:9000"))`.
startCommand | Command line args required to start the component. Paths are expressed relative to the component's bin folder. The default is to use the bash script in the bin folder.

© Typesafe Inc., 2014