cluster-broccoli travis-ci docker

Self service for Nomad based on templates.

Cluster Broccoli

Build Status codecov Docker Pulls Gitter

Description

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).

Usage

Web UI

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.

image

HTTP API

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.

Installation

Requirements

Minimal Setup

  • Nomad (HTTP API v1)
  • Java (for running the Play application)

Recommended Setup

  • 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

  1. Download or clone the source code
  2. Navigate into the project directory
  3. activator dist

Configuration

In order to configure Cluster Broccoli, you can add key value pairs to your configuration. The following configuration properties are supported.

Property Description Default
broccoli.nomad.url Address of your nomad server http://localhost:4646
broccoli.consul.url Address of your consul server http://localhost:8500
broccoli.consul.lookup Lookup method used for consul. Options: ip or dns (recommended). ip
broccoli.templatesDir Directory where your templates are located templates
broccoli.instancesFile Directory where your instances are located instances

Related Repositories

cluster-broccoli

cluster-broccoli

Self service for Nomad based on templates. ...


Top Contributors

FRosner Husterknupp pliguori

Releases

-   0.4.1 zip tar
-   0.4.0 zip tar
-   0.3.1 zip tar
-   0.3.0 zip tar
-   0.2.0 zip tar
-   0.1.2 zip tar
-   0.1.1 zip tar
-   0.1.0 zip tar