bamboo

README

Bamboo

Bamboo is a web daemon that automatically configures HAProxy for web services deployed on Apache Mesos and Marathon.

It features:

• User interface for configuring HAProxy ACL rules for each Marathon application
• Rest API for configuring proxy ACL rules
• Auto configure HAProxy configuration file based your template; you can provision your own template in production to enable SSL and HAProxy stats interface, or configuring different load balance strategy
• Optionally handles health check endpoint if Marathon app is configured with Healthchecks
• Daemon itself is stateless; enables horizontal replication and scalability
• Developed in Golang, deployment on HAProxy instance has no additional dependency
• Optionally integrates with StatsD to monitor configuration reload event

Compatibility

Bamboo v0.1.1 supports Marathon 0.6 and Mesos 0.19.x

Bamboo v0.2.2 supports Marathon 0.7 (with http_callback enabled) and Mesos 0.20.x. Since v0.2.2, Bamboo supports both DNS and non-DNS proxy ACL rules.

Releases and changelog

Since Marathon API and behaviour may change over time, espeically in this early days. You should expect we aim to catch up those changes, improve design and adding new features. We aim to maintain backwards compatibility when possible. Releases and changelog are maintained in the releases page. Please read them when upgrading.

Deployment Guide

You can deploy Bamboo with HAProxy on each Mesos slave. Each web service being allocated on Mesos Slave can discover services via localhost or domain you assigned by ACL rules. Alternatively, you can deploy Bamboo and HAProxy on separate instances, which means you need to loadbalance HAProxy cluster.

User Interface

UI is useful to manage and visualize current state of proxy rules. Of course, you can configure HAProxy template to load balance Bamboo.

StatsD Monitoring

Configuration and Template

Bamboo binary accepts -config option to specify application configuration JSON file location. Type -help to get current available options.

Example configuration and HAProxy template can be found under config/production.example.json and config/haproxy_template.cfg This section tries to explain usage in code comment style:

{
  // Marathon instance configuration
  "Marathon": {
    // Marathon service HTTP endpoint
    "Endpoint": "http://localhost:8080"
  },

  "Bamboo": {

    // Bamboo's HTTP address can be accessed by Marathon
    // This is used for Marathon HTTP callback; must be reachable by Marathon
    "Host": "http://localhost:8000",

    // Proxy setting information is stored in Zookeeper
    // Bamboo will create this path if it does not already exist
    "Zookeeper": {
      // Use the same ZK setting if you run on the same ZK cluster
      "Host": "zk01.example.com:2812,zk02.example.com:2812",
      "Path": "/marathon-haproxy/state",
      "ReportingDelay": 5
    }
  }
  
  
  // Make sure using absolute path on production
  "HAProxy": {
    "TemplatePath": "/var/bamboo/haproxy_template.cfg",
    "OutputPath": "/etc/haproxy/haproxy.cfg",
    "ReloadCommand": "read PIDS < /var/run/haproxy.pid; haproxy -f /etc/haproxy/haproxy.cfg -p /var/run/haproxy.pid -sf $PIDS && while ps -p $PIDS; do sleep 0.2; done"
  },
  
  // Enable or disable StatsD event tracking
  "StatsD": {
    "Enabled": false,
    // StatsD or Graphite server host
    "Host": "localhost:8125",
    // StatsD namespace prefix
    // If you have multiple Bamboo instances, you might want to label each node
    // by bamboo-server.production.n1.
    "Prefix": "bamboo-server.production."
  }
}

Environment Variables

Configuration in the production.json file can be overridden with environment variables below. This is generally useful when you are building a Docker image for Bamboo and HAProxy. If they are not specified then the values from the configuration file will be used.

Environment Variable	Corresponds To
MARATHON_ENDPOINT	Marathon.Endpoint
BAMBOO_ENDPOINT	Bamboo.Endpoint
BAMBOO_ZK_HOST	Bamboo.Zookeeper.Host
BAMBOO_ZK_PATH	Bamboo.Zookeeper.Path
HAPROXY_TEMPLATE_PATH	HAProxy.TemplatePath
HAPROXY_OUTPUT_PATH	HAProxy.OutputPath
HAPROXY_RELOAD_CMD	HAProxy.ReloadCommand

REST APIs

GET /api/state

Shows the data structure used for rendering template

curl -i http://localhost:8000/api/state

POST /api/services

Creates a service configuration for a Marathon application ID

curl -i -X POST -d '{"id":"/app-1","acl":"hdr(host) -i app-1.example.com"}' http://localhost:8000/api/services

PUT /api/services/:id

Updates an existing service configuraiton for a Marathon application. :id is URI encoded Marathon application ID

curl -i -X PUT -d '{"id":"/app-1", "acl":"path_beg -i /group/app-1"}' http://localhost:8000/api/services/%2Fapp-1

DELETE /api/services/:id

Deletes an existing service configuration. :id is URI encoded Marathon application ID

curl -i -X DELETE http://localhost:8000/api/services/%2Fapp-1

GET /status

Bamboo webapp's healthcheck point

curl -i http://localhost:8000/status

Deployment

We recommend installing binary with deb or rpm package. The repository includes examples of a Jenkins build script and a deb packages build script. Read comments in the script to customize your build distribution workflow.

In short, install fpm and run the following command:

go build bamboo.go
./builder/build.sh

A deb package will be generated in ./builder directory. You can copy to a server or publish to your own apt repository.

The example deb package deploys:

• Upstart job bamboo-server, e.g. upstart assumes /var/bamboo/production.json is configured correctly.
• Application directory is under /opt/bamboo/
• Configuration and logs is under /var/bamboo/
• Log file is rotated automatically

As a Docker container

There is a Dockerfile that will allow Bamboo to be built and run from within a Docker container.

Building the image

The Docker image can be built and added to your local repository with the following command from within the project root directory:

docker build -t bamboo .

Running Bamboo as a Docker container

Once the image has been built, running as a container is straightforward - you do however still need to provide the configuration to the image as environment variables. Docker allows two options for this - using the -e option or by putting them in a file and using the --env-file option. For this example we will use the former and we will map through ports 8000 and 80 to the docker host (obviously the hosts configured here will need to be reachable from this container):

docker run -t -i --rm -p 8000:8000 -p 80:80 \
    -e MARATHON_ENDPOINT=http://marathon:8080 \
    -e BAMBOO_ENDPOINT=http://bamboo:8000 \
    -e BAMBOO_ZK_HOST=zk:2181 \
    -e BAMBOO_ZK_PATH=/bamboo \
    -e BIND=":8000"
    -e CONFIG_PATH="config/production.example.json"
    bamboo

Bamboo is started by supervisord in this Docker image. The default Supervisord configuration redirects stderr/stdout logs to the terminal. If you wish to turn the debug information off in production, you can use an alternative configuration.

Development and Contribution

We use godep managing Go package dependencies; Goconvey for unit testing; CommonJS and SASS for frontend development and build distribution.

• Golang 1.3
• Node.js 0.10.x+

Golang:

# Pakcage manager
go get github.com/tools/godep
go get -t github.com/smartystreets/goconvey

cd $GOPATH/github.com/QubitProducts/bamboo
godep restore

# Build your binary
go build

# Run test
goconvey

Node.js UI dependencies:

# Global 
npm install -g grunt-cli napa browserify node-static foreman karma-cli
# Local
npm install && napa

# Start a foreman configured with Procfile for building SASS and JavaScript 
nf start

License

Bamboo is released under Apache License 2.0