Repository: brooklyn Updated Branches: refs/heads/0.5.0 [created] af2087cbd
Added What:Brooklyn, removed Versioning, simplified licence, & other small tweaks. Project: http://git-wip-us.apache.org/repos/asf/brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn/commit/f8aa13c7 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn/tree/f8aa13c7 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn/diff/f8aa13c7 Branch: refs/heads/0.5.0 Commit: f8aa13c7160898ad4b79fba4b7da3b5480eb0080 Parents: 829fb7c Author: David Toy <d...@vidtoy.co.uk> Authored: Thu Apr 18 14:35:14 2013 +0100 Committer: David Toy <d...@vidtoy.co.uk> Committed: Mon Apr 22 12:52:47 2013 +0100 ---------------------------------------------------------------------- README.md | 72 ++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 42 insertions(+), 30 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn/blob/f8aa13c7/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e5691b5..6072351 100644 --- a/README.md +++ b/README.md @@ -4,41 +4,62 @@ Brooklyn is a library and control plane for deploying and managing distributed a See [brooklyncentral.github.com](http://brooklyncentral.github.com) for details and examples. -## Quick Start +Brooklyn's main emphasis is managing live applications (e.g auto-scaling, exception handling, auto recovery from failure, and working across multiple clouds). Brooklyn considers deployment part of management, like the opening move in a game of chess. (Distributed-application-management-chess, no less). -Three quick start options are available: +### Deployment -* Follow the [getting started guide](http://brooklyncentral.github.io/use/guide/quickstart/index.html) -* [Download the latest release](https://github.com/brooklyncentral/brooklyn/tarball/master). -* Clone the repo: `git clone git://github.com/brooklyncentral/brooklyn.git`. +Brooklyn enables single-click deployment of complex applications. -## Versioning -For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Brooklyn will be maintained under the [Semantic Versioning guidelines](http://semver.org/). +Brooklyn features: -Releases will be numbered with the following format: +* out-of-the-box support for many common software entities. +* integration with jclouds, allowing deployment to the majority of public and private clouds, in addition to pools of fixed IP machines. +* integration with Apache Whirr (and thereby Chef and Puppet), allowing deployment of well-known services such as Hadoop and elasticsearch (and you can still use POBS, plain-old-bash-scripts). +* integration with PaaS's such as OpenShift, allowing use of PaaSes alongside self-built clusters, for maximum flexibility. -`<major>.<minor>.<patch>` +Brooklyn works with and ties into other tools, adding the concepts of manageable clusters and fabrics. -And constructed with the following guidelines: +In DevOps fashion, Brooklyn allows applications and roll-outs to be version controlled, tested programatically, and reused across locations and contexts. Develop on localhost, then reuse the same application descriptor to deploy to QA, and then to your production environment. -* Breaking backward compatibility bumps the major (and resets the minor and patch) -* New additions without breaking backward compatibility bumps the minor (and resets the patch) -* Bug fixes and misc changes bumps the patch +### Management -Milestones (`<major>.<minor>.<patch>-M<milestone>`) and Release Candidates (`<major>.<minor>.<patch>-rc.<candidate>`) are used in the release process. +Brooklyn enables [autonomic management](http://en.wikipedia.org/wiki/Autonomic_computing) of applications. (i.e. many small, local, distributed control loops). -## Bug Tracker +Management policies can be attached to every component part in an application, and to logic groupings of components (clusters, fabrics). Policies can implement both technical and non-technical (business) requirements. -Have a bug or a feature request? [Please open a new issue](https://github.com/brooklyncentral/brooklyn/issues). +At runtime, policies have access to all aspects of the deployment, including deployment topology (hierarchical) and locations (machines, PaaSes, and jurisdictions), as well as scripts, instrumentation, and operational goals and constraints. This means that once the application is launched, the policies are all set to keep the application running optimally, based on whatever optimally means in that context. + +These deployment patterns and management policies are expressed as Java (or Groovy) classes, open-sourced here and giving you full control over what you want to happen. More importantly, however, this code can be shared, improved, and extended. + +### Use As a Library + +Import Brooklyn into your application to natively use its distributed management smarts. e.g. [Cloudera's Certification Cluster Builder Tool](http://www.cloudsoftcorp.com/blog/creating-a-cloudera-certification-cluster-with-cloudsofts-brooklyn/). + +### Use As a Control Plane + +Alternatively, use Brooklyn as an integrated-stand-alone management node for your application or bespoke platform. + +## Quick Start + +Three quick start options are available: + +* The [getting started guide](http://brooklyncentral.github.io/use/guide/quickstart/index.html) will step you through downloading and installing Brooklyn and running the examples. +* Alternatively, [download the latest release](https://github.com/brooklyncentral/brooklyn/tarball/master) (tgz), +* or, fork or clone the repo: `git clone git://github.com/brooklyncentral/brooklyn.git` then `mvn clean install`. ## Community -Keep track of development and community news. -* Follow [@brooklyncentral on Twitter](http://twitter.com/brooklyncentral). -* Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/brooklyn-dev) +* Have a question that's not a feature request or bug report? Ask on the mailing lists: [brooklyn-users](http://groups.google.com/group/brooklyn-users) or [brooklyn-dev](http://groups.google.com/group/brooklyn-dev) * Chat with us over IRC. On the `irc.freenode.net` server, in the `#brooklyncentral` channel. +* Follow [@brooklyncentral on Twitter](http://twitter.com/brooklyncentral). + + +## Bug Tracker + +Have a bug or a feature request? [Please open a new issue](https://github.com/brooklyncentral/brooklyn/issues). + ## Contributing @@ -53,16 +74,7 @@ Thanks! Copyright 2013 Cloudsoft Corporation, ltd. -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this work except in compliance with the License. -You may obtain a copy of the License in the LICENSE file, or at: - - [apache.org/licenses/LICENSE-2.0](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. +Licensed under the Apache License, Version 2.0: +You may obtain a copy of the License in the LICENSE file, or at: [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0). brooklyn is a registered trademark of Cloudsoft Corporation.
