Using ConductR with sbt

§Using ConductR with sbt

To use ConductR with sbt, add the sbt-conductr plugin to your project/plugins.sbt:

addSbtPlugin("com.lightbend.conductr" % "sbt-conductr" % "2.1.9")

sbt-conductr adds several commands to the activator console:

  • install to introspect your projects and then load and run them within the sandbox
  • generateInstallationScript to produce an installation script to deploy your Lagom system that you can then tailor
  • bundle:dist to produce individual ConductR packages for your services
  • configuration:dist to produce individual custom ConductR configuration for your services
  • Commands from the conductr-cli

We will use most of these commands in the next sections.

§Run it all

The simplest thing that you can do in order to deploy your entire Lagom system is to run a local ConductR cluster and then run the install command.

To start a ConductR cluster locally you should use the ConductR sandbox which is a docker image based on Ubuntu that includes ConductR. With this docker image you can easily spin up multiple ConductR nodes on your local machine. The sandbox run command will pick up and run this ConductR docker image. In order to use this command we need to specify the ConductR version. Note that this version is the version of ConductR itself and not the version of the sbt-conductr plugin. Please visit again the ConductR Developer page to pick up the latest ConductR version from the section Quick Configuration.

First, start the activator console from the terminal:

$ activator

Now start the local ConductR cluster with the sandbox run command:

> sandbox run <CONDUCTR_VERSION>

You can then install your entire Lagom system in one go:

> install

The install command will introspect your project and its sub-projects and then package, load and run everything in ConductR at once - including Cassandra. The local sandbox is expected to be running and it will first be restarted to ensure that it is in a clean state.

We expect that you will use the install command early on, but graduate to ConductR’s lower-level commands as you evolve your services through their development lifecyle.

The remainder of this document describes the lower level ConductR commands.

§Packaging your services

Packaging your Lagom services so that you can deliver them to ConductR is straightforward. To do this then use the bundle:dist command from within the activator console:

> bundle:dist
[info] Bundle has been created: /my-service/myservice-impl/target/bundle/
[success] Total time: 4 s, completed 05/03/2016 2:43:07 PM

The above creates what is known as a “bundle”. A bundle is the unit of deployment with ConductR, and its filename is fingerprinted with a hash value representing the contents of the entire zip file. ConductR does this so that you can be assured that this particular bundle will always be what you knew it to be when it was generated. If its contents change then its filename will also change. ConductR also verifies that the hash provided matches the actual contents at the point that you load it. When managing your Lagom services you can therefore roll releases forward and backward with surety.

§Loading and running your services during development

With the ConductR sandbox running you can load the bundle that you previously generated:

> project my-service-impl
> conduct load <press the tab key here>

When starting the activator console you are in the context of the root project. However, the bundles are created for your sub projects, i.e. your service implementations. Therefore, it is necessary to first switch with project my-service-impl to the sub project. Replace my-service-impl with the name of your sub project.

Finally, to run the bundle on ConductR use:

> conduct run my-service-impl
Bundle run request sent.
Bundle 9849508f27cdd39742f8e455795538b6 waiting to reach expected scale 1
Bundle 9849508f27cdd39742f8e455795538b6 has scale 0, expected 1
Bundle 9849508f27cdd39742f8e455795538b6 expected scale 1 is met
Stop bundle with: conduct stop --ip 9849508
Print ConductR info with: conduct info --ip
[success] Total time: 4 s, completed 05/03/2016 2:43:07 PM

Now, the Lagom service should run in your local ConductR cluster. The IP address of your cluster is the Docker host IP address. To pick up the IP address check out the previous console output of the conduct run command. The default port of a Lagom service on ConductR is 9000, e.g. considering the ConductR IP address is then the running service is available at

You can also check the state of your cluster with:

> conduct info

The conduct command allows you to manage the full lifecycle of a bundle. You can also use conduct stop my-service-impl and conduct unload my-service-impl to stop and unload your Lagom services. In addition you can use conduct logs my-service-impl to view the consolidated logging of bundles throughout the cluster. This is particularly useful during development.

To stop the ConductR sandbox use:

> sandbox stop

§Loading and running your services outside of development

The sandbox is useful to validate that the packaging of your service is correct. However, at some point you want to load and run your bundle on a real ConductR cluster. While it is beyond the scope of this document to describe how to set up such a cluster (please refer to the ConductR installation guide for that), you generally interact with a real cluster through the ConductR CLI. You have already downloaded the CLI as part of the sandbox. The CLI commands are identical to their activator console counterparts. Type conduct --help for more information on what commands are available.

§Running Cassandra

If your Lagom service uses Cassandra for persistence then you can generate what is known as a “bundle configuration” for Cassandra. First switch to your root project and then generate the bundle configuration:

> project /
> cassandra-configuration:dist
[info] Bundle has been created: /my-project/target/configuration-bundle/
[success] Total time: 4 s, completed 05/03/2016 2:43:07 PM

You can then load the Cassandra bundle with your Cassandra bundle configuration on to ConductR. Note that in this case cassandra represents the bundle and the cassandra-configuration-<hash>.zip file is the bundle configuration. The previous command prints out the bundle configuration zip file on the console. Copy this file to load Cassandra with your project specific configuration:

> conduct load cassandra /my-project/target/configuration-bundle/

The tab completion of conduct load only works for bundles of the project. The Cassandra bundle is an external bundle hosted on bintray. Therefore tab completion doesn’t work in this case.

To run the cassandra bundle execute:

> conduct run cassandra

If the Cassandra bundle has been started on ConductR after the Lagom service itself then it will take a couple of seconds until the Lagom service connects to Cassandra.

For convenience we recommend that you start with one Cassandra cluster per root sbt project, which of course can contain many Lagom projects (and therefore services). Bounded contexts are always maintained via separate key-spaces, and so having one Cassandra cluster is viable for supporting many microservices. The actual number of Cassandra clusters required will be the Lagom amount i.e. “just the right amount” for your system. For more information on configuring Cassandra for ConductR please visit the bundle’s website.

Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.