Repository: incubator-brooklyn Updated Branches: refs/heads/0.7.0-M2-incubating-docs 15afabd91 -> ac204e2ec
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/features/operations.md ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/features/operations.md b/docs/website/learnmore/features/operations.md new file mode 100644 index 0000000..0f152ee --- /dev/null +++ b/docs/website/learnmore/features/operations.md @@ -0,0 +1,75 @@ + +### Operations + + +{% include feature-item.html title="Brooklyn console" %} + +Brooklyn runs with a GUI console giving easy access to the +management hierarchy, sensors, and activities. + +{% include feature-item-end.html img="ops-console.png" %} + + + + + +{% include feature-item.html title="High availability" %} + +Run standby nodes which can optionally automatically promote to master +in the event of master failure. Hot standby nodes can provide additional +read-only access to entity information. +{% include feature-item-end.html %} + + + +{% include feature-item.html title="State persistence" %} + +Blueprint, catalog, topology and sensor information can be +automatically persisted to any file system or object store to +stop Brooklyn and restart resuming where you left off. +{% include feature-item-end.html %} + + + +{% include feature-item.html title="REST API" %} + +<p> +The console is pure JS-REST, and all the data shown in the GUI +is available through a straightforward REST/JSON API. +</p> + +<p> +In many cases, the REST API is simply the GUI endpoint without the +leading <code>#</code>. For instance the data for +<code>#/v1/applications/</code> is available at <code>/v1/applications/</code>. +And in all cases, Swagger doc is available in the product. +</p> +{% include feature-item-end.html img="ops-rest.png" %} + + + +{% include feature-item.html title="Groovy console" %} + +With the right permissions, Groovy scripts can be sent via +the GUI or via REST, allowing open-heart surgery on your systems. +(Use with care!) +{% include feature-item-end.html %} + + + +{% include feature-item.html title="Versioning" %} + +Blueprints in the catalog can be versioned on-the-fly. +Running entities are attached to the version against which +they were launched to preserve integrity, until manual +version updates are performed. +{% include feature-item-end.html %} + + +{% include feature-item.html title="Deep task information" %} +The console shows task flows in real-time, +including the `stdin` and `stdout` for shell commands, +making it simpler to debug those pesky failures. +{% include feature-item-end.html %} + + http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/features/ops-console.png ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/features/ops-console.png b/docs/website/learnmore/features/ops-console.png new file mode 100644 index 0000000..60a07b9 Binary files /dev/null and b/docs/website/learnmore/features/ops-console.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/features/ops-rest.png ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/features/ops-rest.png b/docs/website/learnmore/features/ops-rest.png new file mode 100644 index 0000000..c251b5f Binary files /dev/null and b/docs/website/learnmore/features/ops-rest.png differ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/features/policy-based-mgmt.md ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/features/policy-based-mgmt.md b/docs/website/learnmore/features/policy-based-mgmt.md new file mode 100644 index 0000000..5483e84 --- /dev/null +++ b/docs/website/learnmore/features/policy-based-mgmt.md @@ -0,0 +1,28 @@ +### Policy-Based Management + + +{% include feature-item.html title="Live metrics" %} + +Collect live metrics for use in policies, +either from metric stores or directly using REST, JMX, SSH, and more. + +{% include feature-item-end.html %} + + + +{% include feature-item.html title="Management policies" %} +<p> +Choose from built-in policies including auto-scaling, failover, and follow-the-sun, +or create new policies to perform custom runtime management. +</p> + +<p> +Use config keys to customize the policies to suit your systems, right in the YAML blueprint. +</p> +{% include feature-item-end.html %} + + +{% include feature-item.html title="Dynamic reconfiguration" %} +Reconfigure policies, suspend them, or add new ones on-the-fly +through the REST API. +{% include feature-item-end.html %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/index.md ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/index.md b/docs/website/learnmore/index.md index 8035e07..e3b84a4 100644 --- a/docs/website/learnmore/index.md +++ b/docs/website/learnmore/index.md @@ -2,27 +2,28 @@ layout: website-normal title: Learn More children: -# - yaml-explained.md +- blueprint-tour.md +- features/ - { path: theory.md, title_in_menu: Theory } -- catalog/ +- { path: catalog/, title_in_menu: Browse Catalog } --- <!-- TODO have a list of resources here? or start w yaml explained? -What's a blueprint (image showing yaml with hovers for detail) -Intro video (2m video) -Features list (cf http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2FwhatsNew%2Fplatform_whatsnew.html -- though maybe with smaller screenshots at left and bigger text for summary!) -Supported software, clouds, and policies -The Theory -(based on existing top-level content; -introduction, core entities, glossary (maybe)) -News -infoq - http://www.infoq.com/news/2014/06/clocker -Adam Davis: The case for application-driven cloud computing (Gluecon keynote) http://www.cloudsoftcorp.com/blog/2014/06/adam-davis-case-application-driven-cloud-computing/ -[showing video at min 14] -FAQ (in time) - +Got a minute? blueprint-tour +Got two minutes? watch the video +Four minutes? read the features list + cf http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2FwhatsNew%2Fplatform_whatsnew.html -- though maybe with smaller screenshots at left and bigger text for summary!) +More time? + Browse the catalog of Supported software, clouds, and policies + Read on the Theory behing brooklyn + Read the Brooklyn News + infoq - http://www.infoq.com/news/2014/06/clocker + Adam Davis: The case for application-driven cloud computing (Gluecon keynote) http://www.cloudsoftcorp.com/blog/2014/06/adam-davis-case-application-driven-cloud-computing/ + [showing video at min 14] + twitter feed + selected blog posts --> {% include list-children.html %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/theory.md ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/theory.md b/docs/website/learnmore/theory.md index f1c3899..eddb2f8 100644 --- a/docs/website/learnmore/theory.md +++ b/docs/website/learnmore/theory.md @@ -1,6 +1,11 @@ --- layout: website-normal title: The Theory behind Brooklyn +children: +- { section: "Why Brooklyn?" } +- { section: Blueprints } +- { section: Benefits } +- { section: Standards } --- <div class="jumobotron" markdown="1"> @@ -44,7 +49,7 @@ some clustered services requiring an odd number of instances to prevent voting deadlocks. -## How Brooklyn can help +## How Brooklyn Can Help In this context the advantage of Brooklyn becomes apparent: a single tool is able to manage provisioning and application deployment, monitor an application's @@ -86,7 +91,7 @@ the devops process. In some ways, Brooklyn is to run-time what Maven is to build-time. -### Blueprints turn into deployments +### Blueprints Turn into Deployments Brooklyn knows about Chef, Salt, and similar tools, and APT and Yum and plain old shell scripts, for deploying application components. Blueprints @@ -117,7 +122,8 @@ managing complex software to be codified as part of the software development process. -### Agile and flexible + +### <a id="benefits"></a> Agile and Flexible Brooklyn is a product built from the ground up for application agility. This includes portability across non-cloud, cloud, and PaaS targets; devops-style @@ -148,7 +154,7 @@ lessons: - Brooklyn's focus on blueprinting and modeling as code and APIs serves these principles. -### Autonomic computing +### Autonomic Computing Another major influence on the design of Brooklyn are the ideas of autonomic computing and promise theory. It is not necessary to have a thorough @@ -164,12 +170,14 @@ Salt apply promise theory to files and processes on machines; Brooklyn can leverage all of these tools, complementing it with an application-oriented model. -### Standards compliant +### Standards -Finally we note some emerging standards in this area. OASIS CAMP (Cloud -Application Management for Platforms) and TOSCA (Topology and Orchestration -Specification for Cloud Applications) both define YAML application models -similar to Brooklyn's. CAMP focuses on the REST API for interacting with such a +Finally we note some emerging standards in this area. OASIS CAMP +(<a href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=camp#technical";>Cloud Application Management for Platforms</a>) +and TOSCA +(<a href="https://www.oasis-open.org/committees/tosca/";>Topology and Orchestration Specification for Cloud Applications</a>) +both define YAML application models similar to Brooklyn's. +CAMP focuses on the REST API for interacting with such a management layer, and TOSCA focuses on declarative support for more sophisticated orchestration. Currently Brooklyn uses a YAML which complies with CAMP's syntax and exposes many of the CAMP REST API endpoints. We would like to http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/learnmore/yaml-explained.md ---------------------------------------------------------------------- diff --git a/docs/website/learnmore/yaml-explained.md b/docs/website/learnmore/yaml-explained.md deleted file mode 100644 index 6ada16c..0000000 --- a/docs/website/learnmore/yaml-explained.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: website-normal -title: YAML Explained ---- - -<div class="jumobotron" markdown="1"> - -TODO http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/meta/sitemap.md ---------------------------------------------------------------------- diff --git a/docs/website/meta/sitemap.md b/docs/website/meta/sitemap.md index efff2b2..7411976 100644 --- a/docs/website/meta/sitemap.md +++ b/docs/website/meta/sitemap.md @@ -3,17 +3,23 @@ layout: website-normal title: Site Map --- -<!-- TODO this is very much work in progress --> +<div class="sitemap"> -Site map is: +<div class="search_right"> +<form method="get" id="simple_google" class="searchform" action="http://www.google.com/search";> + <input type="text" class="searchinput" name="brooklyn-search" placeholder="Google site search: type & hit enter"> + <input type="hidden" name="q" value=""> + </form> +</div> +{% assign visited = "" | split: "|" %} +{% assign site_items = "" | split: "|" %} +<ul> {% for item in site.data.menu %} - * {{ item['title_in_menu'] }} / {{ item.data['title'] }} - {{ item.data }}<br/> - {% for item2 in item['menu'] %} - * {{ item2['title_in_menu'] }} / {{ item2['path'] }} / {{ item2['link'] }}<br/> - {% for item3 in item2['menu'] %} - * {{ item3['title_in_menu'] }} / {{ item3['path'] }} / {{ item3['breadcrumbs'] }}<br/> - {% endfor %} - {% endfor %} + {% push site_items item %} + {% include sitemap-item.html %} {% endfor %} +</ul> + +</div> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ac204e2e/docs/website/meta/versions.md ---------------------------------------------------------------------- diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md index a66e9ef..b295040 100644 --- a/docs/website/meta/versions.md +++ b/docs/website/meta/versions.md @@ -18,9 +18,9 @@ This documentation was generated {{ site.time | date_to_string }}. Apache versions: -* **[0.7.0-SNAPSHOT](/v/0.7.0-SNAPSHOT/)**: bleeding-edge (not voted on or endorsed by Apache!) +* **[0.7.0-M2-incubating](/v/0.7.0-M2-incubating/)**: YAML, persistence, Chef, Windows, Docker. The first Apache release! (Dec 2014) -* **[0.7.0-M2](/v/0.7.0-M2/)**: YAML, persistence, Chef, Windows, Docker. The first Apache release! (Dec 2014) +* **[0.7.0-SNAPSHOT](/v/0.7.0-SNAPSHOT/)**: bleeding-edge (not voted on or endorsed by Apache!) The versions below were made prior to joining the Apache Incubator, @@ -28,6 +28,8 @@ therefore **they are not endorsed by Apache** and are not hosted by Apache or th You can obtain the source code by [inspecting the branches of the pre-Apache GitHub repository](https://github.com/brooklyncentral/brooklyn/branches/stale) and binary releases by [querying Maven Central for io.brooklyn:brooklyn.dist](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.brooklyn%22%20AND%20a%3A%22brooklyn-dist%22). +* **[0.7.0-M1](/v/0.7.0-M1/)**: YAML, Chef, catalog, persistence (Apr 2014) + * **[0.6.0](/v/0.6.0/)**: use of spec objects, chef and windows support, more clouds (Nov 2013) * **[0.5.0](/v/0.5.0/)**: includes new JS GUI and REST API, rebind/persistence support, cleaner model and naming conventions, more entities (May 2013) @@ -37,8 +39,8 @@ and binary releases by [querying Maven Central for io.brooklyn:brooklyn.dist](ht Note: To prevent accidentally referring to out-of-date information, a banner is displayed when accessing content from specific versions in the archive. You may -<a href="#" onclick="set_user_versions_all();">disable all warnings</a> or -<a href="#" onclick="clear_user_versions();">re-enable all warnings</a>. +<a href="javascript:void(0);" onclick="set_user_versions_all();">disable all warnings</a> or +<a href="javascript:void(0);" onclick="clear_user_versions();">re-enable all warnings</a>. ### Versioning
