remove the sandbox/ and release/ dirs from the build and update the README in the root
and delete the old brooklyn-install.sh in the root. (it is not maintained; it doesn't even refer to the apache downloads.) basically make the source build look nice when it's unpacked Project: http://git-wip-us.apache.org/repos/asf/brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn/commit/e69ea20a Tree: http://git-wip-us.apache.org/repos/asf/brooklyn/tree/e69ea20a Diff: http://git-wip-us.apache.org/repos/asf/brooklyn/diff/e69ea20a Branch: refs/heads/master Commit: e69ea20a475eddcb368253ba6322c29c10895736 Parents: 75413b0 Author: Alex Heneveld <[email protected]> Authored: Thu Sep 3 22:56:39 2015 +0100 Committer: Alex Heneveld <[email protected]> Committed: Thu Sep 3 23:15:04 2015 +0100 ---------------------------------------------------------------------- README.md | 88 ++++++++-------------------------------------------------- 1 file changed, 11 insertions(+), 77 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn/blob/e69ea20a/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index cfd1393..f068785 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,21 @@ -# [](http://brooklyn.incubator.apache.org/) +# [](http://brooklyn.incubator.apache.org/) -Apache Brooklyn is a library and control plane for deploying and managing distributed applications. +### Apache Brooklyn helps to model, deploy, and manage systems. -See [brooklyn.incubator.apache.org](https://brooklyn.incubator.apache.org/) for details and examples. +It supports blueprints in YAML or Java, and deploys them to many clouds and other target environments. +It monitors those deployments, maintains a live model, and runs autonomic policies to maintain their health. -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). +For more information see **[brooklyn.incubator.apache.org](https://brooklyn.incubator.apache.org/)**. -### Deployment -Brooklyn enables single-click deployment of complex applications, while tying-in with other great tools, and reusing and complementing existing workflows. +### To Build -Use Brooklyn to create an Application Blueprint, instructing Brooklyn how to wire together your applications and components, customizing and extending them as needed. Share the blueprint with others (optionally using Brooklyn's Web Service Catalog) to allow them to single-click deploy your application onto the infrastructure of their choice. +The code can be built with a: -Brooklyn features: + mvn clean install -* out-of-the-box support for many common software components. -* 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. +This creates a build in `usage/dist/target/brooklyn-dist`. Run with `bin/brooklyn launch`. -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. - -### Management - -Brooklyn enables [autonomic management](http://en.wikipedia.org/wiki/Autonomic_computing) of applications. (i.e. many small, local, distributed control loops). - -Management policies can be attached to every component part in an application, and to logical groupings of components (clusters, fabrics). Policies can implement both technical and non-technical (business) requirements. - -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](https://brooklyn.incubator.apache.org/v/latest/start/running.html) will step you through downloading and installing Brooklyn and running the examples. -* Alternatively, [download the latest release](https://github.com/apache/incubator-brooklyn/tarball/master) (tgz). -* Fork or clone the repo: `git clone git://github.com/apache/incubator-brooklyn.git` then `cd incubator-brooklyn; mvn clean install; cd usage/dist/target/brooklyn-dist; ./brooklyn/bin/brooklyn launch`. - -## Community - - -* 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 [@ApacheBrooklyn](http://twitter.com/ApacheBrooklyn) and [@BrooklynCentral](http://twitter.com/brooklyncentral) on Twitter. - - -## Bug Tracker - -Have a bug or a feature request? [Please open a new issue](https://issues.apache.org/jira/browse/BROOKLYN/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel). - -## Contributing - -Your input will be welcomed. - -See the [full guide to contributing](https://brooklyn.incubator.apache.org/community/how-to-contribute-docs.html) on brooklyn.incubator.apache.org. - -Thanks! - ----- -Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. -See the [NOTICE](NOTICE) file distributed with this work for additional information -regarding copyright ownership and the [incubation disclaimer](DISCLAIMER) file regarding project status, -as Apache Brooklyn is currently undergoing Incubation at the Apache Software Foundation. - -The ASF licenses this file to you 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](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. +The **[developer guide](https://brooklyn.incubator.apache.org/v/latest/guide/dev/)** +has more information about the source code.
