Cluster Broccoli is a RESTful web service + UI to manage Nomad jobs through a self service application. Jobs are defined based on templates, allowing for a selectable amount of customization.
If you want to give your end users the possibility to create new instances of live demos of your product, while allowing them to customize it (e.g. using an embedded database or an external one, number of cores, …) - Cluster Broccoli is for you.
Cluster Broccoli is meant to be setup by your IT. Some technical knowledge is required to setup the infrastructure and define the templates. End users can be internal (QA, data scientists) or external (customers, potential customers).
Cluster Broccoli comes with a minimalistic web user interface. It allows you to create, destroy, start and stop your instances based on a set of predefined templates. Please consult the documenation for a detailed description of the Web UI.
Cluster Broccoli provides a RESTful HTTP API. You can control it using curl, writing your own command line wrapper or connect from your microservices. Please consult the documentation for a detailed description of the HTTP API.
- Nomad (HTTP API v1)
- Java (for running the Play application)
- Nomad (HTTP API v1)
- Consul (HTTP API v1)
- Cluster Broccoli Nomad Job + Docker Image (for running the Play application)
Using the Production Docker Image
If you only need an image to run the Broccoli distribution, go with the JRE based production-ready image.
docker run -p 9000:9000 frosner/cluster-broccoli \ -Dbroccoli.nomad.url=<your-nomad-url> \ -Dbroccoli.consul.url=<your-consul-url>
Using the Development Docker Image
If you only intend to develop Broccoli and want to quickly get started with the source code, you can use the development image. It comes with the required tools for building and running Broccoli in development mode.
Building from Source
- Download or clone the source code
- Navigate into the project directory
In order to configure Cluster Broccoli, you can add key value pairs to your configuration. The following configuration properties are supported.
||Address of your nomad server||
||Address of your consul server||
||Lookup method used for consul. Options:
||Directory where your templates are located||
||Directory where your instances are located||