add executor_image commandline param; run executor as root; arrange p…

…ackages; add docs and licence

LICENSE

@@ -0,0 +1,208 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice. The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2015 Airbnb
+Copyright 2015 Mesosphere
+
+This file has been modified from its original form by Mesosphere, 
+Inc. (“Mesosphere”). All modifications made to this file by 
+Mesosphere (the “Modifications”) are © 2015 Mesosphere. The 
+Modifications are licensed to you under the Apache License, Version 
+2.0.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

NOTICE

@@ -0,0 +1,13 @@
+Copyright 2015, Huawei, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1 +1,53 @@
-CloudFoundry Diego auction using mesos
+## CloudFoundry-Mesos
+
+CloudFoundry-Mesos replaces the auctioning process of CloudFoundry Diego with Mesos, and make the Diego auctioneer as a Mesos framework. This project starts as a PoC and is currently under development. The idea is to let CloudFoundry be able to share the same Mesos cluster with other frameworks to get better resource utilization and possibly improve the scalability.
+
+## Implementation
+
+* __Create Mesos scheduler and executor__. The scheduler provides two strategies, `binpack` which tries to put CloudFoundry apps into as few cells as possible, and `spread` which is the opposite. Both the strategies base on the RAM usage and the implementation is simply for demo purpose. The executor uses `rep` API to launch and monitor Diego `Tasks` and `LRPs`.
+* __Pack Diego `cell` into Docker image__ to minimize the Mesos Slave host system dependency and be able to create a cell on the fly. Due to `Garden-Linux` requirements, the Docker Container is started privileged, uses host network. It also maps two directories for storing data and logs. The executor is packed into this image as well.
+
+    It is considered to make Mesos __[Garden](https://github.com/cloudfoundry-incubator/garden) aware__ so Mesos will see the detail resource usage of each container and there will be container in container stuff.
+
+* __Create a new `auctionrunner`__ that collects the `auctions` and hands them to the Mesos scheduler.
+* __Patch `auctioneer`__ by replace the `auctionrunner` package.
+* __Patch `rep`__ so the `/state` API would return not only `LRPs` but the `Tasks` as well (no longer needed in latest version).
+
+
+## Fetures on Mesos
+
+* __On-demand resource allocation__. CloudFoundry Diego cells are created automatically up to the Mesos cluster size and removed if not needed.
+* __Resource sharing__. So the same Mesos cluster can run multiple frameworks for jobs such as Hadoop, Spark, Redis, etc.
+* __Scheduling algorithm customization__.
+* __Mesos scales to 10,000s of nodes__. This may help increase the CloudFoundry cluster size.
+
+
+## Usage
+
+To get up and running with CloudFoundry-Mesos, please follow the [Getting Started Guid](./docs/getting-started.md).
+
+If you are not familiar with CloudFoundry or Mesos, the following documents would help:
+* http://docs.cloudfoundry.org/
+* https://github.com/cloudfoundry/cf-release/blob/master/README.md
+* https://github.com/cloudfoundry-incubator/diego-release/blob/develop/README.md
+* http://bosh.io/docs
+* http://mesos.apache.org/documentation/latest/
+
+
+## Future Work
+
+* Garden as Mesos Containerizer
+    * Garden in Docker may not be the right way
+    * Granular resource monitoring
+    * Requires Garden pre-installed in each Mesos slave
+    * Probably requires to patch Diego `rep` and `executor`
+* BTRFS=>AUFS transition in latest Garden Linux
+    * AUFS requires kernel support
+* Improve Error Handling
+* Scheduling strategy and constrains and more
+* Multiple RootFS support
+* Test for performance and scalability
+* Windows support?
+* Put other Cloud Foundry components on Mesos?
+    * Scale other CF components (router for example)
+

docs/getting-started.md

@@ -0,0 +1,91 @@
+## Cloudfoundry-Mesos
+
+This guide applies to the HEAD of the source tree and currently tested only with the following environment:
+* `OpenStack Kilo` as IaaS
+* `Ubuntu 14.04` with `Docker 1.8.2` installed as Mesos host
+* `Mesos 0.25.0` with Docker containerizer enabled
+* `CloudFoundry v219`, `Diego v0.1434.0` and `Garden Linux v0.307.0` 
+
+
+## Deploy CloudFoundry Diego
+
+Cloudfoundry-Diego currently tested only with `CloudFoundry v219`, `Diego v0.1434.0` and `Garden Linux v0.307.0`. Please refer to [the Diego release document](https://github.com/cloudfoundry-incubator/diego-release) to deploy the specified version.
+
+CloudFoundry has two run-time environment, `DEA` and `Diego`, by default the app will be deployed to DEA which is not supported by CloudFoundry-Mesos. Please set the Cloud Controller property `default_to_diego_backend` to `true` in the manifest file when deploying CloudFoundry.
+
+
+## Deploy Mesos
+
+Cloudfoundry-Diego works with Mesos 0.25.0, the host OS should be `Ubuntu 14.04` (Other distributions not tested) with `Docker 1.8.2` or later installed.
+
+Please follow the [Mesos](http://mesos.apache.org/gettingstarted/) and/or [MESOSPHERE](https://mesosphere.com/downloads/) documents to install and start a Mesos cluster.
+
+
+## Patch and Build `auctioneer`
+
+Get Diego release code and make sure you can compile `auctioneer` without a problem
+``` BASH
+$ git clone https://github.com/cloudfoundry-incubator/diego-release.git
+$ cd diego-release
+$ git checkout v0.1434.0
+$ ./scripts/update
+$ export GOPATH=$(pwd)
+$ cd src/github.com/cloudfoundry-incubator/auctioneer/cmd/auctioneer/
+$ go build
+
+```
+Patch `auctioneer` to use Mesos's `auctionrunner` package
+``` BASH
+$ sed -i 's|"github.com/cloudfoundry-incubator/auction/auctionrunner"|"github.com/mesos/cloudfoundry-mesos/scheduler/auctionrunner"|g' main.go
+```
+Get all the dependencies and rebuild the auctioneer
+``` BASH
+$ go get ./...
+$ go build
+```
+
+
+## Build the Executor
+
+Build the Mesos executor binary is easy
+``` BASH
+$ cd ../../../../mesos/cloudfoundry-mesos/executor/
+$ go build
+```
+In order to create Diego cells dynamically, this project packs the executor binary together with all the Diego cell jobs in to a big Docker image. Starting this container will config and start Diego cell jobs (consul, metron, rep and garden) and launch the Mesos executor. Note that in order for Diego's `Garden-Linux` to work, the cell container should be running with `host` network and in `privileged` mode.
+
+The docker images is current manually created in pushed to Docker hub at `jianhuiz/diego-cell:219-1434-307`. You can pull the image and do the customize on top of it. The creation of the image include compile and package CloudFoundry/Diego/Garden binaries and patch the startup scripts. We will automate the image creation and publish the details later.
+
+## Replace the `auctioneer`
+
+Find the IP of Diego `brain` VM by running `bosh vms`, this is by default where the `auctioneer` runs. SSH into that host and stop the Diego auctioneer job.
+``` BASH
+$ sudo monit stop auctioneer
+```
+Replace the auctioneer binary file `/var/vcap/packages/auctioneer/bin/auctioneer` with the newly compiled one and patch the auctioneer starting script `/var/vcap/jobs/auctioneer/bin/auctioneer_ctl` with the following new parameters added to the auctioneer start command line:
+```BASH
+      -address 192.168.2.12 \
+      -master=zk://192.168.0.15:2181/mesos \
+      -auction_strategy=binpack \
+      -consul_server=192.168.1.113 \
+      -etcd_url=http://192.168.1.109:4001 \
+```
+Where `-address` is the host IP where the auctioneer runs; `-master` is the Mesos master address; `-auction_strategy` is teh scheduling strategy when doing the auctioning; `-consul_server` and `-etcd_url` will be passed to the dynamically created Diego cell to join the CloudFoundry Cosnul server and access the ETCD storage (Note that there are two ETCDs and this is the ETCD of CloudFoundry, not that of Diego). Please replace those parameter values according to your environment.
+
+Then start the new auctioneer and make sure it's up and running.
+```BASH
+$ sudo monit start auctioneer
+$ sudo monit status | grep -A14 auctioneer
+```
+
+
+## Push CloudFoundry apps
+
+If you have already set `default_to_diego_backend: true` when deploying CloudFoundry, just run `cf push` to deploy and run a CloudFoundry app with Diego runtime. Otherwise please install [Diego cli plugin](https://github.com/cloudfoundry-incubator/diego-cli-plugin) and [specify diego backend](https://github.com/cloudfoundry-incubator/diego-design-notes/blob/master/migrating-to-diego.md#starting-a-new-application-on-diego) when pushing apps.
+
+For test purpose, you can just use the [hello world app](https://github.com/jianhuiz/cf-apps/tree/master/hello). Don't forget to modify the `manifest.yml` accordingly.
+
+Check the app status using `cf app <your-app>` and see the framework and running tasks in Mesos portal. You can also use `cf scale` to change the app instance count and see Mesos tasks created or removed.
+
+
+