Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/QubitProducts/bamboo
HAProxy auto configuration and auto service discovery for Mesos Marathon
https://github.com/QubitProducts/bamboo
ceh infra
Last synced: 5 days ago
JSON representation
HAProxy auto configuration and auto service discovery for Mesos Marathon
- Host: GitHub
- URL: https://github.com/QubitProducts/bamboo
- Owner: QubitProducts
- License: apache-2.0
- Created: 2014-08-26T09:50:54.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-28T17:30:57.000Z (about 7 years ago)
- Last Synced: 2024-11-02T00:35:26.147Z (7 days ago)
- Topics: ceh, infra
- Language: Go
- Homepage:
- Size: 3.51 MB
- Stars: 793
- Watchers: 72
- Forks: 214
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - QubitProducts/bamboo - HAProxy auto configuration and auto service discovery for Mesos Marathon (others)
README
# Bamboo [](http://godoc.org/github.com/QubitProducts/bamboo) [](https://travis-ci.org/QubitProducts/bamboo) [](https://coveralls.io/github/QubitProducts/bamboo?branch=coverage)
Bamboo is a web daemon that automatically configures
HAProxy for web services deployed on [Apache Mesos](http://mesos.apache.org) and [Marathon](https://mesosphere.github.io/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](https://mesosphere.github.io/marathon/docs/health-checks.html)
* 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
v0.1.1 supports Marathon 0.6 and Mesos 0.19.x
v0.2.2 supports both DNS and non-DNS proxy ACL rules
v0.2.8 supports both HTTP & TCP via custom Marathon enviroment variables (read below for details)
v0.2.9 supports Marathon 0.7.* (with [http_callback
enabled](https://mesosphere.github.io/marathon/docs/rest-api.html#event-subscriptions)) and Mesos 0.21.x
v0.2.11 improves API, deprecate previous API endpoint
### Marathon Compatibility
Marathon >= 1.5.0 Deprecated event registration method; Make sure configure Bamboo with `"UseEventStream": true`
### Releases and changelog
Since Marathon API and behaviour may change over time, especially 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](https://github.com/QubitProducts/bamboo/releases). 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](config/production.example.json) and [config/haproxy_template.cfg](config/haproxy_template.cfg)
This section tries to explain usage in code comment style:
```JavaScript
{
// Marathon instance configuration
"Marathon": {
// Marathon service HTTP endpoints
"Endpoint": "http://marathon1:8080,http://marathon2:8080,http://marathon3:8080",
// Use the Marathon HTTP event streaming feature (Bamboo 0.2.16, Marathon v0.9.0)
// Required set to true if Marathon version is >= 1.5.0
"UseEventStream": true
},
"Bamboo": {
// Bamboo's HTTP address can be accessed by Marathon
// This is used for Marathon HTTP callback, and each instance of Bamboo
// must be provided a unique Endpoint directly addressable by Marathon
// (e.g., the IP address of each server)
"Endpoint": "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": "haproxy -f /etc/haproxy/haproxy.cfg -p /var/run/haproxy.pid -D -sf $(cat /var/run/haproxy.pid)",
// A command that will validate the config before running reload command.
// '{{.}}' will be expanded to a temporary path that contains the config contents
"ReloadValidationCommand": "haproxy -c -f {{.}}",
// A command that will always be run after ReloadCommand, even if the reload fails
"ReloadCleanupCommand": "exit 0"
},
// 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."
}
}
```
### Customize HAProxy Template with Marathon App Environment Variables
Marathon app env variables are available to be called in the template.
The default template shipped with Bamboo is aware of `BAMBOO_TCP_PORT`. When this variable is specified in Marathon app creation, the application will be configured with TCP mode. For example:
```JavaScript
{
"id": "FileServer",
"cmd": "python -m SimpleHTTPServer $PORT0",
"cpus": 0.1,
"mem": 90,
"ports": [0],
"instances": 2,
"env": {
"BAMBOO_TCP_PORT": "1080",
"MY_CUSTOM_ENV": "hello"
}
}
```
In this example, both `BAMBOO_TCP_PORT` and `MY_CUSTOM_ENV` can be accessed in HAProxy template. This enables flexible template customization depending on your preferences.
#### Default Haproxy Template ACL
The default acl rule in the `haproxy_template.cfg` uses the full
marathon app id, which may include slash-separated groups.
```
# This is the default proxy criteria
acl {{ $app.EscapedId }}-aclrule path_beg -i {{ $app.Id }}
```
For example if your app is named "/mygroup/appname", your default acl
will be `path_beg -i /mygroup/appname`. This can always be changed
using the bamboo web UI.
There is also a DNS friendly version of your marathon app Id which can
be used instead of the slash-separated one. `MesosDnsId` includes the
groups as hyphenated suffixes. For example, if your appname is
"/another/group/app" then the `MesosDnsId` will be "app-group-another".
You can edit the `haproxy_template.cfg` and use the DNS friendly name
for your default ACL instead.
```
acl {{ $app.EscapedId }}-aclrule hdr_dom(host) -i {{ $app.MesosDnsId }}
```
### 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
`MARATHON_USER` | Marathon.User
`MARATHON_PASSWORD` | Marathon.Password
`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
`BAMBOO_DOCKER_AUTO_HOST` | Sets `BAMBOO_ENDPOINT=$HOST` when Bamboo container starts. Can be any value.
`STATSD_ENABLED` | StatsD.Enabled
`STATSD_PREFIX` | StatsD.Prefix
`STATSD_HOST` | StatsD.Host
## REST APIs
#### GET /api/state
Shows the data structure used for rendering template
```bash
curl -i http://localhost:8000/api/state
```
#### GET /api/services
Shows all service configurations
```bash
curl -i http://localhost:8000/api/services
```
Example result:
```json
{
"/authentication-service": {
"Id": "/authentication-service",
"Acl": "path_beg -i /authentication-service"
},
"/payment-service": {
"Id": "/payment-service",
"Acl": "path_beg -i /payment-service"
}
}
```
#### POST /api/services
Creates a service configuration for a Marathon Application ID
```bash
curl -i -X POST -d '{"id":"/ExampleAppGroup/app1","acl":"hdr(host) -i app-1.example.com"}' http://localhost:8000/api/services
```
#### PUT /api/services/:id
Updates an existing or creates a new service configuration for a Marathon application. `:id` is the Marathon Application ID
```bash
curl -i -X PUT -d '{"id":"/ExampleAppGroup/app1", "acl":"path_beg -i /group/app-1"}' http://localhost:8000/api/services//ExampleAppGroup/app1
```
**Note**: Create semantics are available since version 0.2.11.
#### DELETE /api/services/:id
Deletes an existing service configuration. `:id` Marathon Application ID
```bash
curl -i -X DELETE http://localhost:8000/api/services//ExampleAppGroup/app1
```
#### 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 an example deb package build script called [builder/build.sh](./builder/build.sh) which generates a deb package in `./output`. For this install [fpm](https://github.com/jordansissel/fpm) and run:
```
go build bamboo.go
./builder/build.sh
```
Moreover, there is
- a [Jenkins build script](builder/ci-jenkins.sh) to run `build.sh` from a Jenkins job
- and a [Docker build container](builder/build.sh) which will generate the deb package in the volume mounted output directory:
```
docker build -f Dockerfile-deb -t bamboo-build .
docker run -it -v $(pwd)/output:/output bamboo-build
```
Independently how you build the deb package, you can copy it to a server or publish to your own apt repository.
The example deb package deploys:
* Upstart job [`bamboo-server`](https://github.com/QubitProducts/bamboo/blob/master/builder/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
In case you're not using upstart, a template init.d service is provided in [`init.d-bamboo-server`](https://github.com/QubitProducts/bamboo/blob/master/builder/init.d-bamboo-server). Install it with
```
sudo cp builder/init.d-bamboo-server /etc/init.d/bamboo-server
sudo chown root:root /etc/init.d/bamboo-server
sudo chmod 755 /etc/init.d/bamboo-server
sudo update-rc.d "bamboo-server" defaults
```
You can then start the server with ```sudo service bamboo-server start```. Other commands: status, restart, stop
### 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. Bamboo use Marathon event bus to get app info, so make sure set `--event_subscriber http_callback` or env `MARATHON_EVENT_SUBSCRIBER=http_callback` before start marathon instance.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://marathon1:8080,http://marathon2:8080,http://marathon3:8080 \
-e BAMBOO_ENDPOINT=http://bamboo:8000 \
-e BAMBOO_ZK_HOST=zk01.example.com:2181,zk02.example.com:2181 \
-e BAMBOO_ZK_PATH=/bamboo \
-e BIND=":8000" \
-e CONFIG_PATH="config/production.example.json" \
-e BAMBOO_DOCKER_AUTO_HOST=true \
bamboo
````
Bamboo is started by supervisord in this Docker image. The [default Supervisord configuration](https://github.com/QubitProducts/bamboo/blob/master/builder/supervisord.conf) redirects stderr/stdout logs to the terminal. If you wish to turn the debug information off in production, you can use an [alternative configuration](https://github.com/QubitProducts/bamboo/blob/master/builder/supervisord.conf.prod).
## Development and Contribution
We use [godep](https://github.com/tools/godep) managing Go package dependencies; Goconvey for unit testing; CommonJS and SASS for frontend development and build distribution.
* Golang 1.7
* Node.js 0.10.x+
Golang:
```bash
# Pakcage manager
go get github.com/tools/godep
# Testing Toolkit
go get -t github.com/smartystreets/goconvey
cd $GOPATH/src/github.com/QubitProducts/bamboo
# Build your binary
go build
# Run test (requires a local zookeeper running)
goconvey
```
Node.js UI dependencies:
```bash
# 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