feature list in the docs
an initial list of features available in brooklyn
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/7197a229
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/7197a229
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/7197a229
Branch: refs/heads/master
Commit: 7197a229c20817020eef7b72b4d35d52f5a0b644
Parents: 1e6f8b4
Author: Alex Heneveld <[email protected]>
Authored: Mon Jan 19 13:06:27 2015 +0000
Committer: Alex Heneveld <[email protected]>
Committed: Mon Jan 19 22:57:24 2015 +0000
----------------------------------------------------------------------
docs/_includes/feature-image.html | 4 +
docs/_includes/feature-item-end.html | 14 ++++
docs/_includes/feature-item.html | 4 +
docs/style/css/_feature_list.scss | 54 +++++++++++++
docs/style/css/website.scss | 1 +
.../learnmore/features/blueprint-compose.png | Bin 0 -> 15299 bytes
.../features/blueprint-machine-specs.png | Bin 0 -> 16214 bytes
docs/website/learnmore/features/blueprinting.md | 24 ++++++
docs/website/learnmore/features/index.md | 18 +++++
.../learnmore/features/java-hierarchy.png | Bin 0 -> 106962 bytes
docs/website/learnmore/features/java.md | 41 ++++++++++
docs/website/learnmore/features/operations.md | 75 +++++++++++++++++++
docs/website/learnmore/features/ops-console.png | Bin 0 -> 491417 bytes
docs/website/learnmore/features/ops-rest.png | Bin 0 -> 62894 bytes
.../learnmore/features/policy-based-mgmt.md | 28 +++++++
docs/website/learnmore/index.md | 1 +
16 files changed, 264 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/_includes/feature-image.html
----------------------------------------------------------------------
diff --git a/docs/_includes/feature-image.html
b/docs/_includes/feature-image.html
new file mode 100644
index 0000000..89bedcd
--- /dev/null
+++ b/docs/_includes/feature-image.html
@@ -0,0 +1,4 @@
+
+<div class="feature-image">
+ <img src="{{ include.src }}"/>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/_includes/feature-item-end.html
----------------------------------------------------------------------
diff --git a/docs/_includes/feature-item-end.html
b/docs/_includes/feature-item-end.html
new file mode 100644
index 0000000..f208df5
--- /dev/null
+++ b/docs/_includes/feature-item-end.html
@@ -0,0 +1,14 @@
+
+{% if include.img %}
+{% comment %}
+ does not work to do: { % include feature-image.html src='{{ include.img }}'
% }
+ so we repeat that snippet :(
+{% endcomment %}
+
+<div class="feature-image">
+ <img src="{{ include.img }}"/>
+</div>
+
+{% endif %}
+
+</div></div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/_includes/feature-item.html
----------------------------------------------------------------------
diff --git a/docs/_includes/feature-item.html b/docs/_includes/feature-item.html
new file mode 100644
index 0000000..e91d6c2
--- /dev/null
+++ b/docs/_includes/feature-item.html
@@ -0,0 +1,4 @@
+
+<div class="feature-item">
+ <div class="feature-title">{{ include.title }}</div>
+ <div class="feature-body">
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/style/css/_feature_list.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_feature_list.scss
b/docs/style/css/_feature_list.scss
new file mode 100644
index 0000000..f21dc2a
--- /dev/null
+++ b/docs/style/css/_feature_list.scss
@@ -0,0 +1,54 @@
+
+#content_container .feature-list {
+ h3 {
+ border: 1px solid $gray_aa;
+ margin-top: 48px;
+ padding: 16px 8px 12px 8px;
+ margin-bottom: 0;
+ background-color: $white_ee;
+ border-top-right-radius: 8px;
+ border-top-left-radius: 8px;
+ }
+}
+
+#content_container .feature-item {
+ padding-bottom: 24px;
+ margin-bottom: 12px;
+ font-size: 90%;
+ p {
+ margin-top: 6px;
+ margin-bottom: 0;
+ }
+ p:first-child {
+ margin-top: 0px;
+ }
+ img {
+ max-width: 200px;
+ border: 1px solid #aaa;
+ border-radius: 2px;
+ }
+ div.feature-title {
+ width: 27%;
+ float: left;
+ font-weight: 500;
+ }
+ div.feature-body {
+ width: 70%;
+ margin-left: 30%;
+ }
+ div.feature-image {
+ text-align: center;
+ margin-top: 8px;
+ margin-bottom: 8px;
+ }
+
+
+ border: 1px solid $gray_aa;
+ margin-top: -1px;
+ margin-bottom: 0;
+ font-size: 90%;
+ padding: 8px;
+ padding-bottom: 12px;
+ background-color: $white_fa;
+
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/style/css/website.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/website.scss b/docs/style/css/website.scss
index e855ec6..0698d46 100644
--- a/docs/style/css/website.scss
+++ b/docs/style/css/website.scss
@@ -17,3 +17,4 @@ $style_dir: {{ site.path.style }};
@import 'archive_warning';
@import 'landing';
@import 'blueprint_tour';
+@import 'feature_list';
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/website/learnmore/features/blueprint-compose.png
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/features/blueprint-compose.png
b/docs/website/learnmore/features/blueprint-compose.png
new file mode 100644
index 0000000..b446c66
Binary files /dev/null and
b/docs/website/learnmore/features/blueprint-compose.png differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/website/learnmore/features/blueprint-machine-specs.png
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/features/blueprint-machine-specs.png
b/docs/website/learnmore/features/blueprint-machine-specs.png
new file mode 100644
index 0000000..140f056
Binary files /dev/null and
b/docs/website/learnmore/features/blueprint-machine-specs.png differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/website/learnmore/features/blueprinting.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/features/blueprinting.md
b/docs/website/learnmore/features/blueprinting.md
new file mode 100644
index 0000000..c79d98b
--- /dev/null
+++ b/docs/website/learnmore/features/blueprinting.md
@@ -0,0 +1,24 @@
+
+### Blueprinting
+
+
+{% include feature-item.html title="Composable blueprints" %}
+
+A YAML service spec can refer to other blueprints,
+either in the catalog or by URL,
+and can supply custom configuration.
+
+{% include feature-image.html src="blueprint-compose.png" %}
+{% include feature-item-end.html %}
+
+
+
+{% include feature-item.html title="Portable machines specs -- or
location-specific identifiers" img="blueprint-machine-specs.png" %}
+
+<p>
+Define machine specs using portable constraints,
+or, when you need to, use specific <code>imageId</code>, hardware profiles,
and more
+</p>
+
+{% include feature-item-end.html img="blueprint-machine-specs.png" %}
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/website/learnmore/features/index.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/features/index.md
b/docs/website/learnmore/features/index.md
new file mode 100644
index 0000000..fff6864
--- /dev/null
+++ b/docs/website/learnmore/features/index.md
@@ -0,0 +1,18 @@
+---
+layout: website-normal
+title: Features
+children:
+- { section: Blueprinting }
+- { section: Policy-based Management }
+- { section: Operations }
+- { section: Java }
+---
+
+<div class="feature-list">
+
+{% readj blueprinting.md %}
+{% readj policy-based-mgmt.md %}
+{% readj operations.md %}
+{% readj java.md %}
+
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/website/learnmore/features/java-hierarchy.png
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/features/java-hierarchy.png
b/docs/website/learnmore/features/java-hierarchy.png
new file mode 100644
index 0000000..b2bd40b
Binary files /dev/null and b/docs/website/learnmore/features/java-hierarchy.png
differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/docs/website/learnmore/features/java.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/features/java.md
b/docs/website/learnmore/features/java.md
new file mode 100644
index 0000000..6b31865
--- /dev/null
+++ b/docs/website/learnmore/features/java.md
@@ -0,0 +1,41 @@
+
+
+### Java
+
+
+{% include feature-item.html title="Discoverable configuration" %}
+
+Config keys, sensors, and effectors can be defined on the classes
+such that they are automatically discoverable at runtime.
+Type information, parameters, documentation, and default values
+are returned through the REST API and shown in the GUI.
+
+{% include feature-item-end.html %}
+
+
+
+{% include feature-item.html title="Type hierarchy" %}
+
+Use interfaces and mix-ins to share and inherit behavior in a strongly typed
way.
+
+{% include feature-item-end.html img="java-hierarchy.png" %}
+
+
+
+{% include feature-item.html title="Sensor feeds" %}
+
+Fluent builder-style API's are included for collecting sensor information
+from REST endpoints, SSH commands, JMX connectors, and more.
+
+{% include feature-item-end.html %}
+
+
+
+{% include feature-item.html title="Task libraries" %}
+
+Fluent builder-style task libraries are included for building activity
+chains which run in parallel or sequentially,
+executing SSH, REST, or arbitrary Java commands.
+Task status, result, hierarchies, and errors are exposed through the REST API
and in the GUI.
+
+{% include feature-item-end.html %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/7197a229/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/7197a229/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/7197a229/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/7197a229/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/7197a229/docs/website/learnmore/index.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/index.md b/docs/website/learnmore/index.md
index a2e1c6f..e3b84a4 100644
--- a/docs/website/learnmore/index.md
+++ b/docs/website/learnmore/index.md
@@ -3,6 +3,7 @@ layout: website-normal
title: Learn More
children:
- blueprint-tour.md
+- features/
- { path: theory.md, title_in_menu: Theory }
- { path: catalog/, title_in_menu: Browse Catalog }
---
