From 4c9573875f9535e47af5c3a867b16ce77c020302 Mon Sep 17 00:00:00 2001 From: Jing Dong Date: Sat, 18 Apr 2015 22:08:02 +0100 Subject: [PATCH] Update documentation --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3451b4a..6032992 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,16 @@ It features: ### Compatibility -Bamboo v0.1.1 supports Marathon 0.6 and Mesos 0.19.x +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 -Bamboo 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. Since v0.2.2, Bamboo 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). ### 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](https://github.com/QubitProducts/bamboo/releases). Please read them when upgrading. +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 @@ -151,27 +154,27 @@ curl -i http://localhost:8000/api/state #### POST /api/services -Creates a service configuration for a Marathon application ID +Creates a service configuration for a Marathon Application ID ```bash -curl -i -X POST -d '{"id":"/app-1","acl":"hdr(host) -i app-1.example.com"}' http://localhost:8000/api/services +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 service configuraiton for a Marathon application. `:id` is URI encoded Marathon application ID +Updates an existing service configuration for a Marathon application. `:id` is Marathon Application ID ```bash -curl -i -X PUT -d '{"id":"/app-1", "acl":"path_beg -i /group/app-1"}' http://localhost:8000/api/services/%252Fapp-1 +curl -i -X PUT -d '{"id":"/ExampleAppGroup/app1", "acl":"path_beg -i /group/app-1"}' http://localhost:8000/api/services//ExampleAppGroup/app1 ``` #### DELETE /api/services/:id -Deletes an existing service configuration. `:id` is URI encoded Marathon application ID +Deletes an existing service configuration. `:id` Marathon Application ID ```bash -curl -i -X DELETE http://localhost:8000/api/services/%252Fapp-1 +curl -i -X DELETE http://localhost:8000/api/services//ExampleAppGroup/app1 ``` #### GET /status