You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2015/01/20 17:12:19 UTC
[01/13] incubator-brooklyn git commit: docs - getting started - more
on policies
Repository: incubator-brooklyn
Updated Branches:
refs/heads/master 677762b2c -> 3d4191ca1
docs - getting started - more on policies
and some capitalization fixes
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/fa257f62
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/fa257f62
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/fa257f62
Branch: refs/heads/master
Commit: fa257f6290b744feff4d6cb4d6ac403809d882b0
Parents: 7197a22
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 15:56:55 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Jan 19 22:57:24 2015 +0000
----------------------------------------------------------------------
docs/guide/start/policies.md | 19 +++++++++++++++++--
docs/website/learnmore/theory.md | 2 +-
2 files changed, 18 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fa257f62/docs/guide/start/policies.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/policies.md b/docs/guide/start/policies.md
index 00fdde5..31b6e27 100644
--- a/docs/guide/start/policies.md
+++ b/docs/guide/start/policies.md
@@ -25,12 +25,27 @@ Sitting idle, this cluster will only contain one server, but you can use a tool
As load is added, Brooklyn requests a new cloud machine, creates a new app server, and adds it to the cluster. As load is removed, servers are removed from the cluster, and the infrastructure is handed back to the cloud.
+
+### Under the Covers
+
+The `AutoScalerPolicy` here is configured to respond to the sensor
+reporting requests per second per node, invoking the default `resize` effector.
+By clicking on the policy, you can configure it to respond to a much lower threshhold
+or set long stabilization delays (the period before it scales out or back).
+
+An even simpler test is to manually suspend the policy, by clicking "Suspend" in the policies list.
+You can then switch to the "Effectors" tab and manually trigger a `resize`.
+On resize, new nodes are created and configured,
+and in this case a policy on the nginx node reconfigures nginx whenever the set of active
+targets changes.
+
+
### Next
This guide has given a quick overview to writing blueprints for applications, deploying applications, and
managing them. Next, learn more about any of:
-* [Writing blueprints with YAML](../yaml/)
-* [Writing blueprints with Java](../java/)
+* [Writing Blueprints with YAML](../yaml/)
+* [Writing Blueprints with Java](../java/)
* [Operating Brooklyn](../ops/)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/fa257f62/docs/website/learnmore/theory.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/theory.md b/docs/website/learnmore/theory.md
index 5f8d97f..4f0e6a8 100644
--- a/docs/website/learnmore/theory.md
+++ b/docs/website/learnmore/theory.md
@@ -91,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
[10/13] incubator-brooklyn git commit: configure htmlproof (now as
ruby script) to give useful info, and fix broken links
Posted by he...@apache.org.
configure htmlproof (now as ruby script) to give useful info, and fix broken links
all internal broken links fixed!
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/48c63265
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/48c63265
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/48c63265
Branch: refs/heads/master
Commit: 48c6326560c76f564e0d004512b697bfd2e4b8a0
Parents: 3add5d2
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Jan 20 14:59:56 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Jan 20 14:59:56 2015 +0000
----------------------------------------------------------------------
docs/_build/build.sh | 25 ++++++++++---------
docs/_build/htmlproof-brooklyn.sh | 19 ++++++++++++++
docs/_includes/sitemap-item.html | 2 +-
docs/_layouts/base.html | 6 ++---
...ooklyn-flow-websequencediagrams.com-w400.png | Bin 0 -> 58518 bytes
.../brooklyn-flow-websequencediagrams.com.png | Bin 0 -> 106928 bytes
docs/guide/concepts/execution.md | 4 +--
.../concepts/lifecycle-managementcontext.md | 2 +-
docs/guide/dev/code/index.md | 9 ++++---
docs/guide/dev/env/ide/index.md | 3 +--
docs/guide/dev/env/maven-build.md | 8 ++----
docs/guide/dev/index.md | 2 +-
docs/guide/dev/tips/index.md | 4 +--
docs/guide/java/defining-and-deploying.md | 16 ++++++------
docs/guide/misc/download.md | 10 +++++---
docs/guide/ops/brooklyn_properties.md | 2 ++
...ooklyn-flow-websequencediagrams.com-w400.png | Bin 58518 -> 0 bytes
.../brooklyn-flow-websequencediagrams.com.png | Bin 106928 -> 0 bytes
docs/guide/yaml/setting-locations.md | 2 ++
docs/website/community/links.md | 22 ----------------
docs/website/developers/links.md | 22 ++++++++++++++++
docs/website/index.md | 3 +--
docs/website/meta/versions.md | 6 +++--
23 files changed, 96 insertions(+), 71 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index cca232e..51fa197 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -32,7 +32,8 @@ function help() {
echo "* --quick-javadoc : to do a quick javadoc build (for testing)"
echo "* --serve : serve files from _site after building (for testing)"
echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../incubator-brooklyn-site-public)"
- echo "* --skip-test : skip the HTML Proof run on _site"
+ echo "* --skip-htmlproof : skip the HTML Proof run on _site"
+ echo "* --quick-htmlproof : do a fast HTML Proof run on _site (not checking external links)"
echo ""
}
@@ -141,10 +142,14 @@ function parse_arguments() {
INSTALL_AFTERWARDS=true
shift
;;
- "--skip-test")
+ "--skip-htmlproof")
SKIP_TEST=true
shift
;;
+ "--quick-htmlproof")
+ QUICK_TEST=true
+ shift
+ ;;
*)
echo "ERROR: invalid argument '"$1"'"
exit 1
@@ -160,16 +165,12 @@ function test_site() {
fi
echo "Running htmlproof on _site"
mkdir -p target
- LOG="target/htmlproof.log"
- # TODO for now exclude all javadoc; in time it would be nice to police that also
- # (but not sure this is properly working yet)
- htmlproof _site \
- --href_ignore "https?://127.*" \
- --href_ignore "https?://github.com/apache/incubator-brooklyn/edit/.*" \
- --href_ignore "/" \
- --alt_ignore ".*" \
- --file_ignore ".*/javadoc/.*" \
- 2>&1 | tee $LOG
+ LOG="_build/target/htmlproof.log"
+ HTMLPROOF_OPTS=""
+ if [ "$QUICK_TEST" == "true" ]; then
+ HTMLPROOF_OPTS="$HTMLPROOF_OPTS --disable_external"
+ fi
+ _build/htmlproof-brooklyn.sh $HTMLPROOF_OPTS 2>&1 | tee $LOG
}
function make_jekyll() {
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/_build/htmlproof-brooklyn.sh
----------------------------------------------------------------------
diff --git a/docs/_build/htmlproof-brooklyn.sh b/docs/_build/htmlproof-brooklyn.sh
new file mode 100755
index 0000000..ae07065
--- /dev/null
+++ b/docs/_build/htmlproof-brooklyn.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby_executable_hooks
+
+# supports --disable_external
+
+require 'html/proofer'
+
+HTML::Proofer.new("./_site", {
+ :href_ignore => [
+ /https?:\/\/127.*/,
+ /https?:\/\/github.com\/apache\/incubator-brooklyn\/edit.*/,
+ ],
+ :alt_ignore => [/.*/],
+ # don't scan javadoc files (too many errors)
+ # or autogen catalog items (their style files are wrong in some modes; reinstate when cleaner)
+ :disable_external => (ARGV.include? "--disable_external"),
+ :file_ignore => [ /.*\/(javadoc|apidoc|learnmore\/catalog)\/.*/ ]
+ # bug - must do above - see https://github.com/gjtorikian/html-proofer/issues/145
+# :file_ignore => [ /.*\/javadoc\/.*/, /.*\/learnmore\/catalog\/.*/ ]
+ }).run
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/_includes/sitemap-item.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sitemap-item.html b/docs/_includes/sitemap-item.html
index eebc513..e2034f5 100644
--- a/docs/_includes/sitemap-item.html
+++ b/docs/_includes/sitemap-item.html
@@ -11,7 +11,7 @@
{% endunless %}
{% endunless %}
-<a id="{{ item_path }}"></a>
+<a id="{{ item_path }}" name="{{ item_path }}" href="javascript:void(0);"></a>
<li>
{% if visited contains item_path %}
{{ item['title'] }} <a href="#{{ item_path }}"><span class="octicon octicon-link-external flip"></span></a>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/_layouts/base.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 6c51578..b803569 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -145,9 +145,9 @@ TODO insert the warning html at generation-time (jekyll) rather than runtime (JS
msg += "<p>Is this deliberate?</p>";
}
msg += "<center><p class='warning_banner_buttons'>";
- msg += "<a href = '#' onclick=\"set_user_version('"+thisversion+"');\">Yes, hide this warning</a>";
- msg += "<a href = '{{ site.page.guide }}'>No, take me to the latest version guide</a>";
- msg += "<a href = '{{ site.page.website }}/meta/versions.html'>Show all versions</a>";
+ msg += "<a href = 'javascript:void(0);' onclick=\"set_user_version('"+thisversion+"');\">Yes, hide this warning</a>";
+ msg += "<a href = '{{ site.path.guide }}'>No, take me to the latest version guide</a>";
+ msg += "<a href = '{{ site.path.website }}/meta/versions.html'>Show all versions</a>";
msg += "</p></center>"
$('#page_notes').html(msg);
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/concepts/brooklyn-flow-websequencediagrams.com-w400.png
----------------------------------------------------------------------
diff --git a/docs/guide/concepts/brooklyn-flow-websequencediagrams.com-w400.png b/docs/guide/concepts/brooklyn-flow-websequencediagrams.com-w400.png
new file mode 100644
index 0000000..c2b48ba
Binary files /dev/null and b/docs/guide/concepts/brooklyn-flow-websequencediagrams.com-w400.png differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/concepts/brooklyn-flow-websequencediagrams.com.png
----------------------------------------------------------------------
diff --git a/docs/guide/concepts/brooklyn-flow-websequencediagrams.com.png b/docs/guide/concepts/brooklyn-flow-websequencediagrams.com.png
new file mode 100644
index 0000000..78eb5c8
Binary files /dev/null and b/docs/guide/concepts/brooklyn-flow-websequencediagrams.com.png differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/concepts/execution.md
----------------------------------------------------------------------
diff --git a/docs/guide/concepts/execution.md b/docs/guide/concepts/execution.md
index f58f738..7b81fd0 100644
--- a/docs/guide/concepts/execution.md
+++ b/docs/guide/concepts/execution.md
@@ -1,8 +1,6 @@
---
title: Execution
layout: website-normal
-toc: ../guide_toc.json
-categories: [use, guide, defining-applications]
---
All processing, whether an effector invocation or a policy cycle, are tracked as ***tasks***. This allows several important capabilities:
@@ -31,6 +29,6 @@ For example, a ``TomcatServer`` may implement start and other effectors using a
Particularly for sensors, some technologies are used so frequently that they are
packaged as ***feeds*** which can discover their configuration (including from drivers). These include JMX and HTTP (see ``JmxFeed`` and ``HttpFeed``).
-Brooklyn comes with entity implementations for a growing number of commonly used systems, including various web application servers, databases and NoSQL data stores, and messaging systems. See: [Extras]({{site.path.guide}}/use/guide/extras/index.html).
+Brooklyn comes with entity implementations for a growing number of commonly used systems, including various web application servers, databases and NoSQL data stores, and messaging systems.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/concepts/lifecycle-managementcontext.md
----------------------------------------------------------------------
diff --git a/docs/guide/concepts/lifecycle-managementcontext.md b/docs/guide/concepts/lifecycle-managementcontext.md
index 84831d1..90cedcf 100644
--- a/docs/guide/concepts/lifecycle-managementcontext.md
+++ b/docs/guide/concepts/lifecycle-managementcontext.md
@@ -16,7 +16,7 @@ An application entity (``Application`` class) is responsible for starting the de
An ``Application``'s ``start()`` method begins provisioning the child entities of the application (and their entities, recursively).
Provisioning of entities typically happens in parallel automatically,
-although this can be customized. This is implemented as ***tasks*** which are tracked by the management plane and is visible in the [web-based management console]({{site.path.guide}}/use/guide/management/index.html#console).
+although this can be customized. This is implemented as ***tasks*** which are tracked by the management plane and is accessible in the web-based management console and REST API.
Customized provisioning can be useful where two starting entities depend on each other. For example, it is often necessary to delay start of one entity until another entity reaches a certain state, and to supply run-time information about the latter to the former.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/dev/code/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/code/index.md b/docs/guide/dev/code/index.md
index 1d4407b..6436023 100644
--- a/docs/guide/dev/code/index.md
+++ b/docs/guide/dev/code/index.md
@@ -25,11 +25,14 @@ cd usage/dist/target/brooklyn-dist/
bin/brooklyn launch
{% endhighlight %}
+{% comment %}
+TODO examples
Plenty of examples are in the **examples** sub-dir,
described [here]({{site.path.guide}}/use/examples).
+{% endcomment %}
Information on using Brooklyn -- configuring locations (in `brooklyn.properties`)
-and adding new projects to a catalog -- can be found in the [User's Guide]({{site.path.guide}}/use/guide/quickstart/index.html).
+and adding new projects to a catalog -- can be found in the [User's Guide]({{site.path.guide}}).
This document is intended to help people become familiar with the codebase.
## Project Structure
@@ -74,8 +77,8 @@ Brooklyn is split into the following projects and sub-projects:
* **scripts**: various scripts useful for building, updating, etc. (see comments in the scripts)
* **qa**: longevity and stress tests
* **test-support**: provides Brooklyn-specific support for tests, used by nearly all projects in scope ``test``
-* **``docs``**: the markdown source code for this documentation, as described [here]({{site.path.guide}}/dev/tips/update-docs.html)
-* **``examples``**: some canonical examples, as listed [here]({{site.path.guide}}/use/examples)
+* **``docs``**: the markdown source code for this documentation
+* **``examples``**: some canonical examples
* **``sandbox``**: various projects, entities, and policies which the Brooklyn Project is incubating
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/dev/env/ide/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/env/ide/index.md b/docs/guide/dev/env/ide/index.md
index ac56a18..0dddfc1 100644
--- a/docs/guide/dev/env/ide/index.md
+++ b/docs/guide/dev/env/ide/index.md
@@ -75,9 +75,8 @@ find . \( -path "*/src/main" -or -path "*/src/test" \) -exec echo {} \; -exec mk
but for others (older ones) you may need to handcraft these
(either right-click the project in the Package Explorer and choose Configure,
or edit the ``.project`` manually adding it to the project properties).
- The tips [for jclouds maven-eclipse](http://www.jclouds.org/documentation/devguides/using-eclipse) might be helpful.
-If the pain starts to be too much, come find us on IRC #brooklyncentral or [elsewhere]({{site.path.guide}}/meta/contact.html) and we can hopefully share our pearls.
+If the pain starts to be too much, come find us on IRC #brooklyncentral or [elsewhere]({{site.path.website}}/community/) and we can hopefully share our pearls.
(And if you have a tip we haven't mentioned please let us know that too!)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/dev/env/maven-build.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/env/maven-build.md b/docs/guide/dev/env/maven-build.md
index f64970a..e9b0f2e 100644
--- a/docs/guide/dev/env/maven-build.md
+++ b/docs/guide/dev/env/maven-build.md
@@ -24,12 +24,12 @@ Key things to note if you're new to Maven:
* Add ``-DskipTests`` to skip tests.
* Run ``-PIntegration`` to run integration tests, or ``-PLive`` to run live tests
- ([tests described here](tests.html))
+ ([tests described here](../code/tests.html))
* Nearly all the gory details are in the root ``pom.xml``, which is referenced by child project poms.
* You can also open and use the code in your favourite IDE,
- although you may hit a few **[snags](ide.html)**
+ although you may hit a few **[snags](ide/)**
(that link has some tips for resolving them too)
@@ -72,10 +72,6 @@ If there is a good reason that a file, pattern, or directory should be permanent
``examples/simple-web-cluster% mvnf ../../{software/webapp,usage/all}``
-* The **developers catalog** ([developers-catalog.xml](developers-catalog.xml)) uses artifacts from your local `~/.m2/repository/...` (after building from source). This avoids unnecessary web requests to Maven Central or Sonatype, and will allow you to work off-line.
-
- ``wget {{site.url_root}}{{site.path.guide}}/dev/build/developers-catalog.xml > ~/.brooklyn/catalog.xml``
-
## Appendix: Sample Output
A healthy build will look something like the following,
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/dev/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/index.md b/docs/guide/dev/index.md
index dd709de..a4f6ef9 100644
--- a/docs/guide/dev/index.md
+++ b/docs/guide/dev/index.md
@@ -8,7 +8,7 @@ breadcrumbs:
children:
- env/
- code/
-- { link: "http://github.com/apache/incubating-brooklyn", title: "GitHub" }
+- { link: "http://github.com/apache/incubator-brooklyn", title: "GitHub" }
- code/tests.md
- tips/
- tips/logging.md
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/dev/tips/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/index.md b/docs/guide/dev/tips/index.md
index e5e9eda..ac173c0 100644
--- a/docs/guide/dev/tips/index.md
+++ b/docs/guide/dev/tips/index.md
@@ -12,7 +12,7 @@ title: Miscellaneous Tips and Tricks
* When debugging an entity, make sure the [brooklyn.SSH logger](logging.html) is set to DEBUG and accessible.
-* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup]({{site.path.guide}}/dev/build/ide.html)),
+* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup]({{site.path.guide}}/dev/env/ide/)),
and far quicker to spot problems than runtime, plus we get early-warning of problems introduced in the future.
(In particular, Groovy's laxity with compilation means it is easy to introduce silly errors which good test coverage will find much faster.)
@@ -36,7 +36,7 @@ title: Miscellaneous Tips and Tricks
Clusters will take such a ``MachineProvisioningLocation`` (or a singleton list); fabircs take a list of locations.
Some PaaS systems have their own location model, such as ``OpenShiftLocation``.
-Finally, don't be shy about [talking with others]({{site.path.guide}}/meta/contact.html),
+Finally, don't be shy about [talking with others]({{site.path.website}}/community/),
that's far better than spinning your wheels (or worse, having a bad experience),
plus it means we can hopefully improve things for other people!
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/java/defining-and-deploying.md
----------------------------------------------------------------------
diff --git a/docs/guide/java/defining-and-deploying.md b/docs/guide/java/defining-and-deploying.md
index 4f05b0b..8f56000 100644
--- a/docs/guide/java/defining-and-deploying.md
+++ b/docs/guide/java/defining-and-deploying.md
@@ -33,8 +33,8 @@ provides a template to follow.
## Deploying the Application
-If you have not already done so, follow the section in the
-[Getting Started Guide]({{site.path.guide}}/use/guide/quickstart/index.html) to create a `brooklyn.properties`
+If you have not already done so, follow the instructions
+[here]({{site.path.guide}}/ops/locations/) to create a `brooklyn.properties`
file containing credentials for your preferred cloud provider.
To launch this application, build the project and run the `start.sh` script in the resulting assembly:
@@ -69,17 +69,19 @@ and exposes operations ("effectors") that can be performed on entities.
## What Next?
In addition to the sample project created by the archetype, with its README and
-`assembly` build, you can find additional code related to this example included with Brooklyn as the ``simple-web-cluster`` example,
+`assembly` build, you can find additional code related to this example included with Brooklyn as the ``simple-web-cluster`` example.
+{% comment %}
described [in detail here]({{site.path.guide}}/use/examples/webcluster).
+{% endcomment %}
For your applications, you might want to mix in other data stores, messaging systems, or on-line services including PaaS.
Brooklyn supports some of these out-of-the-box, including a wide-range of tools which it can use Whirr to provision, such as Hadoop.
But if you have something you don't see,
-[let us know]({{site.path.guide}}/meta/contact.html) --
+[let us know]({{site.path.website}}/community/) --
we want to work with you to
-[write a new entity]({{site.path.guide}}/dev/code/entity.html) or
-[policy]({{site.path.guide}}/dev/code/policy.html)
-and [contribute it]({{site.path.guide}}/dev/how-to-contrib.html).
+[write a new entity]({{site.path.guide}}/java/entity.html) or
+[policy]({{site.path.guide}}/java/policy.html)
+and [contribute it]({{site.path.website}}/developers/how-to-contribute.html).
<!--
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/misc/download.md
----------------------------------------------------------------------
diff --git a/docs/guide/misc/download.md b/docs/guide/misc/download.md
index ff8f469..02bad9e 100644
--- a/docs/guide/misc/download.md
+++ b/docs/guide/misc/download.md
@@ -4,7 +4,7 @@ title: Downloads
---
{% include fields.md %}
-First time user? The [getting started]({{ site.path.guide }}/use/guide/quickstart/index.html) guide will walk you through downloading Brooklyn, setup of your `brooklyn.properties` and `catalog.xml` files, and then trying the [examples](#examples).
+First time user? The [getting started]({{ site.path.guide }}/start/) guide will walk you through downloading Brooklyn and running an example.
## Download Version {{ site.brooklyn-version }}
@@ -12,7 +12,7 @@ First time user? The [getting started]({{ site.path.guide }}/use/guide/quickstar
<tr>
<th style='text-align:left'>Download</th>
<th style='text-align:left'>File/Format</th>
- <th>checksums <small><a href="/meta/verify.html" title='Instructions on verifying the integrity of your downloads.'>(?)</a></small></th>
+ <th>checksums <small><a href="{{ site.path.website }}/download/verify.html" title='Instructions on verifying the integrity of your downloads.'>(?)</a></small></th>
</tr>
<tr>
<td style='text-align:left;vertical-align:top' rowspan='2'>Distro</td>
@@ -84,9 +84,10 @@ and [Sonatype]({{ sonatype_repo_groupid_url }}brooklyn-all/) for snapshot versio
## Release Notes
-Release notes can be found [here]({{ site.path.guide }}/start/release-notes.html).
-
+Release notes can be found [here]({{ site.path.guide }}/misc/release-notes.html).
+{% comment %}
+TODO
<a name="examples"></a>
## Examples
@@ -95,6 +96,7 @@ Examples can be found in the main Brooklyn codebase, in the `/examples` director
A good example to start with is the [Elastic Web Cluster]({{site.path.guide}}/use/examples/webcluster.html).
+{% endcomment %}
<a name="maven"></a>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/ops/brooklyn_properties.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/brooklyn_properties.md b/docs/guide/ops/brooklyn_properties.md
index 0485afe..da8b848 100644
--- a/docs/guide/ops/brooklyn_properties.md
+++ b/docs/guide/ops/brooklyn_properties.md
@@ -10,6 +10,8 @@ children:
- { section: HTTPS Configuration }
---
+{% include fields.md %}
+
The file `~/.brooklyn/brooklyn.properties` is read when Brooklyn starts
to load server configuration values.
A different properties file can be specified either additionally or instead
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/yaml/brooklyn-flow-websequencediagrams.com-w400.png
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/brooklyn-flow-websequencediagrams.com-w400.png b/docs/guide/yaml/brooklyn-flow-websequencediagrams.com-w400.png
deleted file mode 100644
index c2b48ba..0000000
Binary files a/docs/guide/yaml/brooklyn-flow-websequencediagrams.com-w400.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/yaml/brooklyn-flow-websequencediagrams.com.png
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/brooklyn-flow-websequencediagrams.com.png b/docs/guide/yaml/brooklyn-flow-websequencediagrams.com.png
deleted file mode 100644
index 78eb5c8..0000000
Binary files a/docs/guide/yaml/brooklyn-flow-websequencediagrams.com.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/guide/yaml/setting-locations.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/setting-locations.md b/docs/guide/yaml/setting-locations.md
index 7f5dfc4..ab92369 100644
--- a/docs/guide/yaml/setting-locations.md
+++ b/docs/guide/yaml/setting-locations.md
@@ -5,6 +5,8 @@ toc: ../guide_toc.json
categories: [use, guide, defining-applications]
---
+{% include fields.md %}
+
Brooklyn supports a very wide range of target locations -- localhost is mainly a convenience for testing.
With deep integration to [Apache jclouds](http://jclouds.org), most well-known clouds and cloud platforms are supported.
The following example is for Amazon EC2:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/website/community/links.md
----------------------------------------------------------------------
diff --git a/docs/website/community/links.md b/docs/website/community/links.md
deleted file mode 100644
index e684e1c..0000000
--- a/docs/website/community/links.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-layout: website-normal
-title: Development Bookmarks
-menu_proxy_for: index.md
----
-
-{% include fields.md %}
-
-Handy places:
-
-* **Code** is in Github at [https://github.com/apache/incubator-brooklyn/](https://github.com/apache/incubator-brooklyn/)
-
-* **Issues** are in Jira at [https://issues.apache.org/jira/browse/BROOKLYN/](https://issues.apache.org/jira/browse/BROOKLYN/)
-
-* **Maven repositories** are:
- * [Apache releases]({{ apache_releases_repo_groupid_url }})
- * [Apache snapshots]({{ apache_snapshots_repo_groupid_url }})
- * Other repositories are at [http://developers.cloudsoftcorp.com/download/maven2/](http://developers.cloudsoftcorp.com/download/maven2/) for releases
- and [http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/](http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/) for snapshots
-
-* **CI server** is a jenkins server at: [https://builds.apache.org/job/incubator-brooklyn-master-build/](https://builds.apache.org/job/incubator-brooklyn-master-build/)
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/website/developers/links.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/links.md b/docs/website/developers/links.md
new file mode 100644
index 0000000..e684e1c
--- /dev/null
+++ b/docs/website/developers/links.md
@@ -0,0 +1,22 @@
+---
+layout: website-normal
+title: Development Bookmarks
+menu_proxy_for: index.md
+---
+
+{% include fields.md %}
+
+Handy places:
+
+* **Code** is in Github at [https://github.com/apache/incubator-brooklyn/](https://github.com/apache/incubator-brooklyn/)
+
+* **Issues** are in Jira at [https://issues.apache.org/jira/browse/BROOKLYN/](https://issues.apache.org/jira/browse/BROOKLYN/)
+
+* **Maven repositories** are:
+ * [Apache releases]({{ apache_releases_repo_groupid_url }})
+ * [Apache snapshots]({{ apache_snapshots_repo_groupid_url }})
+ * Other repositories are at [http://developers.cloudsoftcorp.com/download/maven2/](http://developers.cloudsoftcorp.com/download/maven2/) for releases
+ and [http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/](http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/) for snapshots
+
+* **CI server** is a jenkins server at: [https://builds.apache.org/job/incubator-brooklyn-master-build/](https://builds.apache.org/job/incubator-brooklyn-master-build/)
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/website/index.md
----------------------------------------------------------------------
diff --git a/docs/website/index.md b/docs/website/index.md
index 1eac218..a23cac9 100644
--- a/docs/website/index.md
+++ b/docs/website/index.md
@@ -15,9 +15,8 @@ children:
- { path: /guide/ops/index.md, title_in_menu: Operations,
menu_customization: { dropdown_section_header: true } }
- { path: /guide/dev/index.md, title_in_menu: Developer Guide }
- - { path: documentation/faq.md, title_in_menu: FAQ,
+ - { path: documentation/other-docs.md, title_in_menu: Other Resources,
menu_customization: { dropdown_new_section: true } }
- - { path: documentation/other-docs.md, title_in_menu: Other Resources }
- community/
- developers/
---
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/48c63265/docs/website/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md
index 5ce3c3f..47cc32a 100644
--- a/docs/website/meta/versions.md
+++ b/docs/website/meta/versions.md
@@ -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
[04/13] incubator-brooklyn git commit: fix for auto-scroll-detecting
side menu to take a link if it is clicked
Posted by he...@apache.org.
fix for auto-scroll-detecting side menu to take a link if it is clicked
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/1e6f8b42
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/1e6f8b42
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/1e6f8b42
Branch: refs/heads/master
Commit: 1e6f8b424edb3bc9e860cf8fb4124c640a06a720
Parents: a8a9f28
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 13:38:20 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Jan 19 22:57:24 2015 +0000
----------------------------------------------------------------------
docs/_includes/sidemenu.html | 81 +++++++++++++++++++++++++++++++++++----
1 file changed, 73 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1e6f8b42/docs/_includes/sidemenu.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidemenu.html b/docs/_includes/sidemenu.html
index f37ce66..808d9e2 100644
--- a/docs/_includes/sidemenu.html
+++ b/docs/_includes/sidemenu.html
@@ -105,7 +105,7 @@ var sideMenu = $("#side-menu"),
var highlight_section_last_top = -1;
var highlight_section_completed = false;
-var highlight_section = function(data) {
+var highlight_section = function() {
// Get container scroll position
var highlight_section_new_top = $(this).scrollTop();
if (highlight_section_new_top == highlight_section_last_top) return;
@@ -114,13 +114,16 @@ var highlight_section = function(data) {
var last_item = null, active_item = $("#side-menu a.section#active");
+ var found_top = false;
var displayable_items = scrollItems.map(function(itemI){
item = $(scrollItems[itemI]);
if (item && item.length) {
if (highlight_section_last_top == -1 || !highlight_section_completed) {
- // just opening page - take item at top of page
- if (item.offset().top < highlight_section_new_top + 15)
- return item;
+ // just opening page - take item matching hash, or otherwise the first item visible
+ if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 15 && !found_top)) {
+ found_top = true;
+ return item;
+ }
} else if (scroll_advancing) {
// if scrolling advance, pick up a section when title starts before 1/3 height
if (item.offset().top < highlight_section_new_top + $(window).height()/3)
@@ -146,12 +149,12 @@ var highlight_section = function(data) {
return item;
}
- if (!highlight_section_completed && document.readyState === "complete") {
- highlight_section_completed = true;
- }
last_item = item;
}
});
+ if (!highlight_section_completed && document.readyState === "complete") {
+ highlight_section_completed = true;
+ }
if (!displayable_items.length) {
$("#side-menu a.section").removeClass("active");
} else {
@@ -169,7 +172,69 @@ var highlight_section = function(data) {
highlight_section_last_top = highlight_section_new_top;
};
+var highlight_new_section = function() {
+ highlight_section_completed = false;
+ highlight_section_last_top = -1;
+ highlight_section();
+}
$(window).scroll(highlight_section);
-$(highlight_section);
+$(highlight_new_section);
+
+// detect link change - courtesy http://www.bennadel.com/blog/1520-binding-events-to-non-dom-objects-with-jquery.htm
+ (
+ function( $ ){
+ // Default to the current location.
+ var strLocation = window.location.href;
+ var strHash = window.location.hash;
+ var strPrevLocation = "";
+ var strPrevHash = "";
+
+ // This is how often we will be checkint for
+ // changes on the location.
+ var intIntervalTime = 100;
+
+ // This method removes the pound from the hash.
+ var fnCleanHash = function( strHash ){
+ return(
+ strHash.substring( 1, strHash.length )
+ );
+ }
+
+ // This will be the method that we use to check
+ // changes in the window location.
+ var fnCheckLocation = function(){
+ // Check to see if the location has changed.
+ if (strLocation != window.location.href){
+
+ // Store the new and previous locations.
+ strPrevLocation = strLocation;
+ strPrevHash = strHash;
+ strLocation = window.location.href;
+ strHash = window.location.hash;
+
+ // The location has changed. Trigger a
+ // change event on the location object,
+ // passing in the current and previous
+ // location values.
+ $( window.location ).trigger(
+ "change",
+ {
+ currentHref: strLocation,
+ currentHash: fnCleanHash( strHash ),
+ previousHref: strPrevLocation,
+ previousHash: fnCleanHash( strPrevHash )
+ }
+ );
+
+ }
+ }
+
+ // Set an interval to check the location changes.
+ setInterval( fnCheckLocation, intIntervalTime );
+ }
+ )( jQuery );
+// and trigger highlight section on link change
+$(window.location).bind("change", highlight_new_section);
+
</script>
[13/13] incubator-brooklyn git commit: This closes #458
Posted by he...@apache.org.
This closes #458
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/3d4191ca
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/3d4191ca
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/3d4191ca
Branch: refs/heads/master
Commit: 3d4191ca1c044c99543d693977129f73b8458fb0
Parents: 677762b 772ea29
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Jan 20 16:07:12 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Jan 20 16:07:12 2015 +0000
----------------------------------------------------------------------
.../DownloadProducerFromProperties.java | 2 +-
.../management/entitlement/Entitlements.java | 1 +
docs/.gitignore | 1 +
docs/README.md | 5 +
docs/_build/build.sh | 32 +-
docs/_build/htmlproof-brooklyn.sh | 19 +
docs/_build/javadoc-overview.html | 21 +
docs/_build/make-javadoc.sh | 14 +-
docs/_config.yml | 6 +
docs/_includes/base-head.html | 2 +-
docs/_includes/base-scss.scss | 1 +
docs/_includes/feature-image.html | 4 +
docs/_includes/feature-item-end.html | 14 +
docs/_includes/feature-item.html | 4 +
docs/_includes/java_link.html | 18 +
docs/_includes/sidemenu.html | 85 +-
docs/_includes/sitemap-item.html | 4 +-
docs/_includes/topmenu.html | 5 +-
docs/_layouts/base.html | 6 +-
docs/_layouts/guide-normal.html | 23 -
docs/_plugins/brooklyn_metadata.rb | 21 +-
...ooklyn-flow-websequencediagrams.com-w400.png | Bin 0 -> 58518 bytes
.../brooklyn-flow-websequencediagrams.com.png | Bin 0 -> 106928 bytes
docs/guide/concepts/execution.md | 4 +-
.../concepts/lifecycle-managementcontext.md | 2 +-
docs/guide/dev/code/index.md | 9 +-
docs/guide/dev/env/ide/index.md | 3 +-
docs/guide/dev/env/index.md | 2 +-
docs/guide/dev/env/maven-build.md | 8 +-
docs/guide/dev/index.md | 8 +-
.../guide/dev/tips/debugging-remote-brooklyn.md | 46 +-
docs/guide/dev/tips/index.md | 4 +-
docs/guide/java/common-usage.md | 100 ++-
docs/guide/java/defining-and-deploying.md | 16 +-
docs/guide/misc/download.md | 16 +-
docs/guide/misc/index.md | 2 +-
docs/guide/ops/brooklyn_properties.md | 175 ++++
docs/guide/ops/catalog/index.md | 97 ++-
docs/guide/ops/cli.md | 143 ++++
docs/guide/ops/index.md | 8 +-
docs/guide/ops/launching/index.md | 143 ----
docs/guide/ops/locations/configuring.md | 105 ---
docs/guide/ops/locations/index.md | 267 +++++--
docs/guide/ops/locations/more-locations.md | 55 ++
docs/guide/ops/locations/ssh-keys.md | 85 ++
docs/guide/ops/logging.md | 46 ++
docs/guide/ops/persistence/index.md | 23 +-
docs/guide/ops/runtime-management/index.md | 325 --------
.../webconsole-dashboard-w400.png | Bin 137463 -> 0 bytes
.../runtime-management/webconsole-dashboard.png | Bin 214723 -> 0 bytes
.../webconsole-detail-w400.png | Bin 111993 -> 0 bytes
.../runtime-management/webconsole-detail.png | Bin 165359 -> 0 bytes
docs/guide/start/_my-web-cluster.yaml | 10 +-
docs/guide/start/blueprints.md | 70 +-
docs/guide/start/config.md | 50 --
docs/guide/start/index.md | 1 -
docs/guide/start/managing.md | 26 +-
docs/guide/start/policies.md | 19 +-
docs/guide/start/running.md | 76 +-
...ooklyn-flow-websequencediagrams.com-w400.png | Bin 58518 -> 0 bytes
.../brooklyn-flow-websequencediagrams.com.png | Bin 106928 -> 0 bytes
.../yaml/chef/advanced-chef-integration.md | 4 +-
docs/guide/yaml/configuring-vms.md | 2 +-
docs/guide/yaml/creating-yaml.md | 2 +-
docs/guide/yaml/multiple-services.md | 39 +-
docs/guide/yaml/mutlitple-services.md | 100 ---
docs/guide/yaml/setting-locations.md | 19 +-
docs/style/css/_archive_warning.scss | 31 +
docs/style/css/_basic.scss | 62 ++
docs/style/css/_blueprint_tour.scss | 181 +++++
docs/style/css/_code_blocks.scss | 98 +++
docs/style/css/_feature_list.scss | 60 ++
docs/style/css/_footer.scss | 36 +
docs/style/css/_landing.scss | 26 +
docs/style/css/_main_container.scss | 84 ++
docs/style/css/_menu.scss | 201 +++++
docs/style/css/_search.scss | 29 +
docs/style/css/_tooltips.scss | 14 +
docs/style/css/_util.scss | 27 +
docs/style/css/base.scss | 793 -------------------
docs/style/css/guide-toc.css | 88 --
docs/style/css/guide.css | 119 ---
docs/style/css/javadoc.scss | 119 +++
docs/style/css/website.scss | 20 +
docs/website/community/index.md | 2 +-
docs/website/community/links.md | 22 -
docs/website/developers/index.md | 2 +-
docs/website/developers/links.md | 22 +
docs/website/documentation/increase-entropy.md | 2 +-
docs/website/documentation/index.md | 11 +-
docs/website/documentation/install-on-server.md | 25 +-
docs/website/documentation/passwordless-ssh.md | 29 -
docs/website/documentation/ssh-key.md | 9 -
docs/website/documentation/todo.md | 7 -
docs/website/download/index.md | 23 +-
docs/website/download/verify.md | 69 +-
docs/website/index.md | 3 +-
docs/website/learnmore/blueprint-tour.md | 5 +-
.../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 +
docs/website/learnmore/theory.md | 5 +-
docs/website/meta/versions.md | 10 +-
111 files changed, 2616 insertions(+), 2203 deletions(-)
----------------------------------------------------------------------
[05/13] incubator-brooklyn git commit: blueprint tour tidy
Posted by he...@apache.org.
blueprint tour tidy
remove "self-destruct" message, and use drop-shadow and triangle on hover annotations
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/a8a9f28b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/a8a9f28b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/a8a9f28b
Branch: refs/heads/master
Commit: a8a9f28b1a1495ea7d20956c98b91d803acd1ebd
Parents: 310c414
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 12:51:12 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Jan 19 22:57:24 2015 +0000
----------------------------------------------------------------------
docs/style/css/_blueprint_tour.scss | 12 +++++++++---
docs/website/learnmore/blueprint-tour.md | 3 +--
2 files changed, 10 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/a8a9f28b/docs/style/css/_blueprint_tour.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_blueprint_tour.scss b/docs/style/css/_blueprint_tour.scss
index 203ca03..5fe50fe 100644
--- a/docs/style/css/_blueprint_tour.scss
+++ b/docs/style/css/_blueprint_tour.scss
@@ -66,6 +66,7 @@ div.annotated_blueprint {
height: auto;
width: 100%;
padding: 8px 8px;
+ padding-bottom: 11px;
color: $explained_text_highlight_fg_color;
div.short {
@@ -83,7 +84,7 @@ div.annotated_blueprint {
}
div.connector {
height: 7px;
- width: 24px;
+ width: 48px;
}
}
}
@@ -103,18 +104,23 @@ div.annotated_blueprint {
border: 4px solid $explained_code_highlight_bg_color;
border-radius: 8px;
text-align: center;
+ box-shadow: 2px 10px 20px $gray_aa;
div.short {
font-size: 100% !important;
text-align: center !important;
color: $text_color;
margin-bottom: 8px;
- font-weight: bold;
+ font-weight: normal;
z-index: 10;
}
div.long { display: inherit !important; }
}
div.connector {
- background-color: $explained_code_highlight_bg_color;
+ border-style: solid;
+ width: 16px !important;
+ border-width: 5px 0px 5px 6px;
+ border-style: solid;
+ border-color: transparent transparent transparent $explained_code_highlight_bg_color;
}
}
// highlighting of key code segments
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/a8a9f28b/docs/website/learnmore/blueprint-tour.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/blueprint-tour.md b/docs/website/learnmore/blueprint-tour.md
index c202d19..04ce5d2 100644
--- a/docs/website/learnmore/blueprint-tour.md
+++ b/docs/website/learnmore/blueprint-tour.md
@@ -4,12 +4,11 @@ title: A Quick Tour of a Brooklyn Blueprint
title_in_menu: Blueprint Tour
---
-
<div class="jumobotron annotated_blueprint" markdown="1">
<div class="code_scroller">
<div class="initial_notice"><div><div>
Hover over an element to learn more
- <div class="ann_light">This message will self-destruct in <span id="countdown">3s</span></div>
+ <div class="ann_light">This message will go away in <span id="countdown">3s</span></div>
<div class="ann_play fa fa-play-circle-o"></div>
</div></div></div>
<div class="code_viewer">
[12/13] incubator-brooklyn git commit: tidies to download instructions
Posted by he...@apache.org.
tidies to download instructions
remove usages of site.data.brooklyn-version in favour of site.brooklyn-stable-version,
simplify main download page, linking to other versions, and fixing links
(some were broken, and us/eu ones caused certificate errors so i've taken them out)
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/772ea293
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/772ea293
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/772ea293
Branch: refs/heads/master
Commit: 772ea293529204bfaa748fc743259fa576830bb4
Parents: e3b40c4
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Jan 20 15:57:24 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Jan 20 16:04:54 2015 +0000
----------------------------------------------------------------------
docs/_config.yml | 3 +
docs/_plugins/brooklyn_metadata.rb | 4 +-
docs/guide/misc/download.md | 8 ++-
docs/guide/misc/index.md | 2 +-
docs/guide/start/_my-web-cluster.yaml | 2 +-
docs/guide/start/running.md | 6 +-
docs/style/css/_basic.scss | 5 ++
docs/website/documentation/install-on-server.md | 8 +--
docs/website/download/index.md | 23 +++----
docs/website/download/verify.md | 69 +++++++++++---------
docs/website/meta/versions.md | 4 +-
11 files changed, 74 insertions(+), 60 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 121dbad..10a5d5a 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -44,6 +44,9 @@ exclude: ['/Gemfile*','/README.md']
sass:
sass_dir: style/css
+# used for the "verify" page
+brooklyn-stable-versions: [ 0.7.0-M2-incubating ]
+
brooklyn-stable-version: 0.7.0-M2-incubating
brooklyn-version: 0.7.0-SNAPSHOT # BROOKLYN_VERSION
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/_plugins/brooklyn_metadata.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/brooklyn_metadata.rb b/docs/_plugins/brooklyn_metadata.rb
index c50f844..cb2ba2e 100644
--- a/docs/_plugins/brooklyn_metadata.rb
+++ b/docs/_plugins/brooklyn_metadata.rb
@@ -61,8 +61,10 @@ module BrooklynMetadata
"is_snapshot" => is_snapshot,
"url" => url_set
}
+
# config is preferred of data, because you can write just {{ site.brooklyn.xxx }},
- # but some places reference site.data.brooklyn
+ # also note {{ site.brooklyn-version }} v {{ site.brooklyn-stable-version }} from _config.yml
+ # but some places referenced site.data.brooklyn (i think these have been remove)
site.data['brooklyn'] = site.config['brooklyn']
end
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/misc/download.md
----------------------------------------------------------------------
diff --git a/docs/guide/misc/download.md b/docs/guide/misc/download.md
index 02bad9e..c79ef16 100644
--- a/docs/guide/misc/download.md
+++ b/docs/guide/misc/download.md
@@ -4,11 +4,15 @@ title: Downloads
---
{% include fields.md %}
-First time user? The [getting started]({{ site.path.guide }}/start/) guide will walk you through downloading Brooklyn and running an example.
+**Brooklyn in Apache has not yet made an official clean binary release.
+The downloads on this page have not been voted on and should be used at your own risk.
+Additionally some links on this page may not work until those builds have been officially released.
+For more information, see the [main download page]({{ site.path.website }}/download/).**
+
## Download Version {{ site.brooklyn-version }}
-<table>
+<table class="table">
<tr>
<th style='text-align:left'>Download</th>
<th style='text-align:left'>File/Format</th>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/misc/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/misc/index.md b/docs/guide/misc/index.md
index 1f80f3f..9639cbf 100644
--- a/docs/guide/misc/index.md
+++ b/docs/guide/misc/index.md
@@ -17,4 +17,4 @@ Further documentation specific to this version of Brooklyn includes:
* [{{ item.title_in_menu }}]({{ item.url }})
{% endfor %}
-Also see the [other versions]({{ path.guide }}/meta/versions.html) or [general documentation]({{ path.guide }}/documentation/).
+Also see the [other versions]({{ site.path.website }}/meta/versions.html) or [general documentation]({{ site.path.website }}/documentation/).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/start/_my-web-cluster.yaml
----------------------------------------------------------------------
diff --git a/docs/guide/start/_my-web-cluster.yaml b/docs/guide/start/_my-web-cluster.yaml
index 7862c6b..166c497 100644
--- a/docs/guide/start/_my-web-cluster.yaml
+++ b/docs/guide/start/_my-web-cluster.yaml
@@ -7,7 +7,7 @@ services:
- type: brooklyn.entity.webapp.ControlledDynamicWebAppCluster
name: My Web
brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/{{ site.data.brooklyn.version }}/brooklyn-example-hello-world-sql-webapp-{{ site.data.brooklyn.version }}.war
+ wars.root: http://search.maven.org/remotecontent?filepath=io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.6.0/brooklyn-example-hello-world-sql-webapp-0.6.0.war
java.sysprops:
brooklyn.example.db.url: >
$brooklyn:formatString("jdbc:%s%s?user=%s\\&password=%s",
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md
index 965272d..6de22c6 100644
--- a/docs/guide/start/running.md
+++ b/docs/guide/start/running.md
@@ -21,15 +21,15 @@ Expand the `tar.gz` archive:
{% if brooklyn_version contains 'SNAPSHOT' %}
{% highlight bash %}
-$ tar -zxf brooklyn-dist-{{ site.data.brooklyn.version }}-timestamp-dist.tar.gz
+$ tar -zxf brooklyn-dist-{{ site.brooklyn-version }}-timestamp-dist.tar.gz
{% endhighlight %}
{% else %}
{% highlight bash %}
-$ tar -zxf brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz
+$ tar -zxf brooklyn-{{ site.brooklyn-version }}-dist.tar.gz
{% endhighlight %}
{% endif %}
-This will create a `brooklyn-{{ site.data.brooklyn.version }}` folder.
+This will create a `brooklyn-{{ site.brooklyn-version }}` folder.
**Note**: You'll need a Java JRE or SDK installed (version 6 or later), as Brooklyn is Java under the covers.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/style/css/_basic.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_basic.scss b/docs/style/css/_basic.scss
index 05fe469..d8c9235 100644
--- a/docs/style/css/_basic.scss
+++ b/docs/style/css/_basic.scss
@@ -55,3 +55,8 @@ a:hover {text-decoration: none; color: $a_hover_color;}
margin-left: -1em;
}
}
+.table > thead > tr > th, .table > tbody > tr > th, .table > tfoot > tr > th, .table > thead > tr > td, .table > tbody > tr > td, .table > tfoot > tr > td {
+ // extend bootstrap with a bottom border on table items;
+ // these get collapsed so not sure why bootstrap does weirdness where there's no bottom border
+ border-bottom: 1px solid $white_dd;
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/documentation/install-on-server.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/install-on-server.md b/docs/website/documentation/install-on-server.md
index defef7e..67dc6da 100644
--- a/docs/website/documentation/install-on-server.md
+++ b/docs/website/documentation/install-on-server.md
@@ -61,20 +61,20 @@ Expand the `tar.gz` archive:
{% if brooklyn_version contains 'SNAPSHOT' %}
{% highlight bash %}
-$ tar -zxf brooklyn-dist-{{ site.data.brooklyn.version }}-timestamp-dist.tar.gz
+$ tar -zxf brooklyn-dist-{{ site.brooklyn-stable-version }}-timestamp-dist.tar.gz
{% endhighlight %}
{% else %}
{% highlight bash %}
-$ tar -zxf brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz
+$ tar -zxf brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz
{% endhighlight %}
{% endif %}
-This will create a `brooklyn-{{ site.data.brooklyn.version }}` folder.
+This will create a `brooklyn-{{ site.brooklyn-stable-version }}` folder.
Let's setup some paths for easy commands.
{% highlight bash %}
-$ cd brooklyn-{{ site.data.brooklyn.version }}
+$ cd brooklyn-{{ site.brooklyn-stable-version }}
$ BROOKLYN_DIR="$(pwd)"
$ export PATH=$PATH:$BROOKLYN_DIR/bin/
{% endhighlight %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/download/index.md
----------------------------------------------------------------------
diff --git a/docs/website/download/index.md b/docs/website/download/index.md
index 33f5d16..3008502 100644
--- a/docs/website/download/index.md
+++ b/docs/website/download/index.md
@@ -2,39 +2,32 @@
layout: website-normal
title: Download
children:
-- { path: verify.md }
+- verify.md
+- ../meta/versions.md
---
## Latest Brooklyn Source Code Release
-[Download Apache Brooklyn {{ site.data.brooklyn.version }} from our mirror sites](https://www.apache.org/dyn/closer.cgi/incubator/brooklyn/{{ site.data.brooklyn.version }}/apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz)
+[Download Apache Brooklyn {{ site.brooklyn-stable-version }} from our mirror sites](https://www.apache.org/dyn/closer.cgi/incubator/brooklyn/{{ site.brooklyn-stable-version }}/apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz)
You can also verify that you build has not been tampered with by [verifying the hashes and signatures](verify.html).
## Build the Binary Package
-We do not yet have an official binary package for Apache Brooklyn. We plan to address this in our next release. However,
-it is relatively easy to create the binary package from source code, if you have a working JDK of at least version 6,
-and Maven 3.
+We do not yet have an official binary package for Apache Brooklyn. We plan to address this in our next release.
-Unpack `apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz` and then execute this command in the `apache-brooklyn-{{ site.data.brooklyn.version }}` folder:
+However, it is relatively easy to create the binary package from source code, if you have a working recent JDK and Maven 3.
+
+Unpack `apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz` and then execute this command in the `apache-brooklyn-{{ site.brooklyn-stable-version }}` folder:
{% highlight bash %}
mvn clean install -DskipTests
{% endhighlight %}
-You can then find the binary distribution in the folder `usage/dist/target/brooklyn-dist`, or archived as `usage/dist/target/brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz`.
+You should then find the binary distribution in the folder `usage/dist/target/brooklyn-dist`, or archived as `usage/dist/target/brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz`.
## Get Started!
Take a look at the [Get Started]({{ site.path.guide }}/start/running.html) page!
-
-
-## Previous Versions
-
-Versions of Brooklyn prior to 0.7.0-M2 were all made prior to joining the Apache Incubator, therefore **they are not
-endorsed by Apache** and are not hosted by Apache or their mirrors. 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).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/download/verify.md
----------------------------------------------------------------------
diff --git a/docs/website/download/verify.md b/docs/website/download/verify.md
index 0feb4db..df0a516 100644
--- a/docs/website/download/verify.md
+++ b/docs/website/download/verify.md
@@ -3,48 +3,47 @@ layout: website-normal
title: Verify the Integrity of Downloads
---
-It is essential for security that you verify the integrity of the downloaded files using their PGP signatures or SHA-1 checksums.
+You can verify the integrity of the downloaded files using their PGP signatures or SHA-1 checksums.
-## Verifying hashes
+## Verifying Hashes
-You can download MD5, SHA1 and SHA256 hashes using these links. Note that these links are for first-class Apache
-Software Foundation mirrors so there will be reduced opportunity for tampering with these files.
+To verify the downloads, first get the MD5, SHA1 and/or SHA256 hashes using these links.
+Note that all links are for first-class Apache Software Foundation mirrors
+so there is already reduced opportunity for anyone maliciously tampering with these files.
<table class="table">
<tr>
<th>Artifact</th>
-<th colspan="2">MD5 hash</th>
-<th colspan="2">SHA1 hash</th>
-<th colspan="2">SHA256 hash</th>
+<th colspan="3">Hashes</th>
</tr>
+
+{% for v in site.brooklyn-stable-versions %}
<tr>
-<td>apache-brooklyn-0.7.0-M2-incubating.tar.gz</td>
-<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.md5">US</a></td>
-<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.md5">EU</a></td>
-<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha1">US</a></td>
-<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha1">EU</a></td>
-<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha256">US</a></td>
-<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha256">EU</a></td>
+<td>apache-brooklyn-{{ v }}.tar.gz</td>
+<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ v }}/apache-brooklyn-{{ v }}.tar.gz.md5">md5</a></td>
+<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ v }}/apache-brooklyn-{{ v }}.tar.gz.sha1">sha1</a></td>
+<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ v }}/apache-brooklyn-{{ v }}.tar.gz.sha256">sha256</a></td>
</tr>
+{% endfor %}
</table>
You can verify the SHA1 or SHA256 hashes easily by placing the files in the same folder as the download artifact and
then running `shasum`, which is included in most UNIX-like systems:
{% highlight bash %}
-shasum -c apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz.sha1
-shasum -c apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz.sha256
+shasum -c apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.sha1
+shasum -c apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.sha256
{% endhighlight %}
You can verify the MD5 hashes by running a command like this, and comparing the output to the contents of the `.md5` file:
{% highlight bash %}
-md5 apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz
+md5 apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz
{% endhighlight %}
-### Verifying PGP signatures using PGP or GPG
+### Verifying PGP Signatures using PGP or GPG
You can download PGP/GPG signatures using these links. Note that these links are for first-class Apache
Software Foundation mirrors so there will be reduced opportunity for tampering with these files.
@@ -52,18 +51,20 @@ Software Foundation mirrors so there will be reduced opportunity for tampering w
<table class="table">
<tr>
<th>Artifact</th>
-<th colspan="2">Mirror</th>
+<th colspan="2">Link</th>
</tr>
<tr>
-<td>Release Manager's public keys (KEYS)</td>
-<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/KEYS">US</a></td>
-<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/KEYS">EU</a></td>
+<td>Release Manager's public keys</td>
+<td><a href="https://www.apache.org/dist/incubator/brooklyn/KEYS">KEYS</a></td>
</tr>
+
+{% for v in site.brooklyn-stable-versions %}
<tr>
-<td>apache-brooklyn-0.7.0-M2-incubating.tar.gz.asc</td>
-<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.asc">US</a></td>
-<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.asc">EU</a></td>
+<td>apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.asc</td>
+<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ site.brooklyn-stable-version }}/apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.asc">asc</a></td>
</tr>
+{% endfor %}
+
</table>
In order to validate the release signature, download both the release `.asc` file for the release, and the `KEYS` file
@@ -71,15 +72,21 @@ which contains the public keys of key individuals in the Apache Brooklyn project
Verify the signatures using one of the following commands:
- pgpk -a KEYS
- pgpv brooklyn-{{ site.brooklyn-version }}-dist.tar.gz.asc
+{% highlight bash %}
+pgpk -a KEYS
+pgpv brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz.asc
+{% endhighlight %}
or
- pgp -ka KEYS
- pgp brooklyn-{{ site.brooklyn-version }}-dist.zip.asc
+{% highlight bash %}
+pgp -ka KEYS
+pgp brooklyn-{{ site.brooklyn-stable-version }}-dist.zip.asc
+{% endhighlight %}
or
- gpg --import KEYS
- gpg --verify brooklyn-{{ site.brooklyn-version }}-dist.tar.gz.asc
+{% highlight bash %}
+gpg --import KEYS
+gpg --verify brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz.asc
+{% endhighlight %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md
index 47cc32a..b295040 100644
--- a/docs/website/meta/versions.md
+++ b/docs/website/meta/versions.md
@@ -18,10 +18,10 @@ 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-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,
therefore **they are not endorsed by Apache** and are not hosted by Apache or their mirrors.
[06/13] incubator-brooklyn git commit: add java_link.html for
javadoc+src, tidy up and expand locations docs
Posted by he...@apache.org.
add java_link.html for javadoc+src, tidy up and expand locations docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/5cf0666f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/5cf0666f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/5cf0666f
Branch: refs/heads/master
Commit: 5cf0666f8e42bfbad720032bb4889265af0dd171
Parents: fa257f6
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 22:51:13 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Jan 19 22:59:44 2015 +0000
----------------------------------------------------------------------
docs/_includes/java_link.html | 18 ++
docs/_includes/sitemap-item.html | 2 +-
docs/_plugins/brooklyn_metadata.rb | 16 +-
docs/guide/ops/index.md | 3 +-
docs/guide/ops/locations/configuring.md | 105 --------
docs/guide/ops/locations/index.md | 267 ++++++++++++++++----
docs/guide/ops/locations/more-locations.md | 55 ++++
docs/guide/ops/locations/ssh-keys.md | 60 +++++
docs/guide/ops/persistence/index.md | 23 +-
docs/style/css/_code_blocks.scss | 3 +
docs/website/documentation/increase-entropy.md | 2 +-
11 files changed, 378 insertions(+), 176 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/_includes/java_link.html
----------------------------------------------------------------------
diff --git a/docs/_includes/java_link.html b/docs/_includes/java_link.html
new file mode 100644
index 0000000..b296652
--- /dev/null
+++ b/docs/_includes/java_link.html
@@ -0,0 +1,18 @@
+{% comment %}
+
+includes a code-formatted class name with link to its javadoc and optionally its source code
+
+usage:
+
+{ % include java_link.html class_name="JcloudsLocationConfig" package_path="brooklyn/location/jclouds" project_subpath="location/jclouds" % }
+
+
+{% endcomment %}{% if include.project_subpath %}<code>{{ include.class_name }}</code>
+ (<a href="{{ site.guide.path }}/misc/javadoc/{{ include.package_path }}/{{ include.class_name }}.html">javadoc</a>,
+ <a href="{{ site.brooklyn.url.git }}/{{ include.project_subpath }}/src/main/java/{{ include.package_path }}/{{ include.class_name }}.java">src</a>)
+{% else %}<a href="{{ site.guide.path }}/misc/javadoc/{{ include.package_path }}/{{ include.class_name }}.html">
+<code>{{ include.class_name }}</code></a>
+{% endif %}{% comment %}
+
+must NOT have a newline at the end here, as the include is often done inline
+{% endcomment %}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/_includes/sitemap-item.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sitemap-item.html b/docs/_includes/sitemap-item.html
index 247fc5d..eebc513 100644
--- a/docs/_includes/sitemap-item.html
+++ b/docs/_includes/sitemap-item.html
@@ -1,6 +1,6 @@
{% pop site_items item %}
{% set_hash_entry item path item_path %}
- {% set_hash_entry item url item_url %}
+{% set_hash_entry item url item_url %}
{% unless item_path %}
{% unless item_url %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/_plugins/brooklyn_metadata.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/brooklyn_metadata.rb b/docs/_plugins/brooklyn_metadata.rb
index b5fe81d..89d82aa 100644
--- a/docs/_plugins/brooklyn_metadata.rb
+++ b/docs/_plugins/brooklyn_metadata.rb
@@ -1,17 +1,18 @@
# Inserts several useful fields that can be referenced using {{ name }} syntax
#
-# TODO: remove, no need for a plugin i think, this is already set in fields.md
-# (although doing it in ruby might be better!)
+# TODO: move things from fields.md to here
#
-# site.data.brooklyn.version: brooklyn version, such as 0.7.0-M1
-# site.data.brooklyn.is_snapshot: true if this is a snapshot version, otherwise false
+# site.brooklyn.version: brooklyn version, such as 0.7.0-M1 (taken from brooklyn-version in _config.yml)
+# site.brooklyn.is_snapshot: true if this is a snapshot version, otherwise false
#
module BrooklynMetadata
- BROOKLYN_VERSION = "0.7.0-M2-incubating" unless defined? BROOKLYN_VERSION
+ BROOKLYN_VERSION = "0.7.0-SNAPSHOT" unless defined? BROOKLYN_VERSION
class Generator < Jekyll::Generator
def generate(site)
+ raise "Brooklyn version mismatch" if BrooklynMetadata::BROOKLYN_VERSION != site.config['brooklyn-version']
+
is_snapshot = BrooklynMetadata::BROOKLYN_VERSION.end_with?('-SNAPSHOT')
if is_snapshot
@@ -55,14 +56,11 @@ module BrooklynMetadata
url_set["git"] = "https://github.com/apache/incubator-brooklyn/tree/#{ git_branch }"
- site.data['brooklyn'] = {
+ site.config['brooklyn'] = {
"version" => BrooklynMetadata::BROOKLYN_VERSION,
"is_snapshot" => is_snapshot,
"url" => url_set
}
-
- # TODO check that "#{ brooklyn['url']['git'] }/core/src/main/java/brooklyn/BrooklynVersion.java"
- # exists AND contains "versionFromStatic = \"#{ brooklyn['version'] }\""
end
end
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/guide/ops/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/index.md b/docs/guide/ops/index.md
index 60b7c6e..b224852 100644
--- a/docs/guide/ops/index.md
+++ b/docs/guide/ops/index.md
@@ -2,8 +2,7 @@
title: Operations
layout: website-normal
children:
-- locations/index.md
-- locations/configuring.md
+- locations/
- persistence/
- launching/
- catalog/
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/guide/ops/locations/configuring.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/configuring.md b/docs/guide/ops/locations/configuring.md
deleted file mode 100644
index cb3ee16..0000000
--- a/docs/guide/ops/locations/configuring.md
+++ /dev/null
@@ -1,105 +0,0 @@
----
-title: Configuring Locations
-layout: website-normal
----
-
-<a id="locations"></a>
-
-Brooklyn supports deploying to any machine which admits SSH access, as well as to
-a huge variety of external and on-premise clouds. You can also connect to services,
-or use whatever technique for deployment suits you best (such as Xebia Overthere, in development!).
-
-Configuration is typically set in `~/.brooklyn/brooklyn.properties` using keys such as the following:
-
-{% highlight bash %}
-# use this key for localhost (this is the default, although if you have a passphrase you must set it)
-brooklyn.location.localhost.privateKeyFile=~/.ssh/id_rsa
-
-brooklyn.location.localhost.privateKeyPassphrase=s3cr3tPASSPHRASE
-
-# use a special key when connecting to public clouds, and a particularly special one for AWS
-brooklyn.location.jclouds.privateKeyFile=~/.ssh/public_clouds/id_rsa
-brooklyn.location.jclouds.aws-ec2.privateKeyFile=~/.ssh/public_clouds/aws_id_rsa
-
-# AWS credentials (when deploying to location jclouds:aws-ec2)
-brooklyn.location.jclouds.aws-ec2.identity=ABCDEFGHIJKLMNOPQRST
-brooklyn.location.jclouds.aws-ec2.credential=s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
-
-# credentials for 'geoscaling' service
-brooklyn.geoscaling.username=cloudsoft
-brooklyn.geoscaling.password=xxx
-{% endhighlight %}
-
-These can also be set as environment variables (in the shell) or system properties (java command line).
-(There are also ``BROOKLYN_JCLOUDS_PRIVATE_KEY_FILE`` variants accepted.)
-
-For any jclouds provider you will typically need to set ``identity`` and ``credential``
-in the ``brooklyn.location.jclouds.provider`` namespace.
-
-To deploy to sets of machines with known IP's, assuming you have the credentials,
-use the syntax ``byon:(hosts="user@10.9.1.1,user@10.9.1.2,user@10.9.1.3")``
-(this requires your default private key to have access;
-see the ``prod1`` example below for specifying other credentials).
-
-A wide range of other fields is available, because in the real world sometimes things do get complicated.
-The following is supported from the configuration file (with whatever customization you might want available in code):
-
-- If there is a passphrase on the key file being used, you must supply it to Brooklyn for it to work, of course!
- ``privateKeyPassphrase`` does the trick (as in ``brooklyn.location.jclouds.privateKeyPassphrase``, or other places
- where ``privateKeyFile`` is valid). If you don't like keys, you can just use a plain old ``password``.
-
-- Hardware requirements such as ``minRam`` and ``minCores`` can be supplied, or a ``hardwareId`` (jclouds only)
-
-- Specific Secury Groups can be specified using `securityGroups`, if you want to reuse set of existing ones (jclouds only)
-
-- Specific KeyPair can be specified using `keyPair`, if you want to reuse an existing keypair (jclouds only).
-
-- Specific VM images can be specified using ``imageId`` or ``imageNameRegex`` (jclouds only)
-
-- User metadata can be attached, using the syntax ``userMetadata=key=value,key2="value 2"`` (jclouds only)
-
-- A ``user`` can be specified, with the property that -- in a jclouds world -- the user will be *created* on the machine,
- with admin rights, authorizing the relevant public key (corresponding to the private key, or as described below).
- Login for the root account will be disabled, as will login by password if a public key is supplied.
- (This is skipped if ``user`` is the ``root`` or other initial login user.)
-
-- You can specify the user account to use to login to jclouds initially with the ``loginUser`` property.
- Typically this is auto-detected by jclouds
- (often ``root``, or ``ubuntu`` or ``ec2-user`` for known Ubuntu or Amazon Linux images),
- but the strategy isn't foolproof, particularly in some private cloud setups. (jclouds only). In some cases, you may need to specify a `loginUser.privateKeyFile` if the image you are using doesn't allow ssh password login.
-
-- Public keys can be specified using ``publicKeyFile``,
- although these can usually be omitted if they follow the common pattern of being
- the private key file with the suffix ``.pub`` appended.
- (It is useful in the case of ``loginUser.publicKeyFile``, where you shouldn't need,
- or might not even have, the private key of the ``root`` user in order to log in.)
-
-- You can specify the number of attempts Brooklyn should make to create
- machines with ``machineCreateAttempts`` (jclouds only). This is useful for
- working around the rare occasions in which cloud providers give machines that
- are dead on arrival.
-
-You can also define named locations for commonly used groups of properties,
-with the syntax ``brooklyn.location.named.your-group-name.``
-followed by the relevant properties.
-These can be accessed at runtime using the syntax ``named:your-group-name`` as the deployment location.
-
-Some more advanced examples showing the syntax and properties above are as follows:
-
-{% highlight bash %}
-# Production pool of machines for my application (deploy to named:prod1)
-brooklyn.location.named.prod1=byon:(hosts="10.9.1.1,10.9.1.2,produser2@10.9.2.{10,11,20-29}")
-brooklyn.location.named.prod1.user=produser1
-brooklyn.location.named.prod1.privateKeyFile=~/.ssh/produser_id_rsa
-brooklyn.location.named.prod1.privateKeyPassphrase=s3cr3tCOMPANYpassphrase
-
-# AWS using my company's credentials and image standard, then labelling images so others know they're mine
-brooklyn.location.named.company-jungle=jclouds:aws-ec2:us-west-1
-brooklyn.location.named.company-jungle.identity=BCDEFGHIJKLMNOPQRSTU
-brooklyn.location.named.company-jungle.privateKeyFile=~/.ssh/public_clouds/company_aws_id_rsa
-brooklyn.location.named.company-jungle.imageId=ami-12345
-brooklyn.location.named.company-jungle.minRam=2048
-brooklyn.location.named.company-jungle.userMetadata=application=my-jungle-app,owner="Bob Johnson"
-brooklyn.location.named.company-jungle.machineCreateAttempts=2
-{% endhighlight %}
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/guide/ops/locations/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/index.md b/docs/guide/ops/locations/index.md
index 3d2b99a..b5e5afd 100644
--- a/docs/guide/ops/locations/index.md
+++ b/docs/guide/ops/locations/index.md
@@ -1,101 +1,268 @@
---
-title: Locations Intro
+title: Locations
layout: website-normal
+children:
+- { section: Clouds }
+- { section: Inheritance and Named Locations, title: Named Locations }
+- { section: Localhost }
+- { section: BYON }
+- more-locations.md
+- ssh-keys.md
---
-Locations are the environments to which Brooklyn deploys applications.
-These can be clouds (public or private), fixed infrastructure environments, or your laptop.
+Locations are the environments to which Brooklyn deploys applications, including:
-Brooklyn looks for Location configuration in `~/.brooklyn/brooklyn.properties`.
+Brooklyn supports a wide range of locations:
-## Setting up an SSH key
+* <a href="#clouds">Clouds</a>, where it will provision machines
+* <a href="#localhost">Localhost</a> (e.g. your laptop),
+ where it will deploy via `ssh` to `localhost` for rapid testing
+* <a href="#byon">BYON</a>, where you "bring your own nodes",
+ specifying already-existing hosts to use
+* And many others, including object stores and online services
-While some locations can be accessed using *user:password* credentials it is more common to use authentication keys.
+Configuration can be set in `~/.brooklyn/brooklyn.properties`
+or directly in YAML when specifying a location.
+On some entities, config keys determining maching selection and provisioning behavior
+can also be set `in `provisioning.properties`.
-To use keyfile based authentication, Brooklyn requires that the management machine has an SSH key. By default Brooklyn looks for a key at `~/.ssh/id_rsa` and `~/.ssh/id_dsa`.
-If you do not already have an SSH key installed, create a new id_rsa key:
+### Clouds
-{% highlight bash %}
-$ ssh-keygen -t rsa -N "" -f ~/.ssh/id_rsa
-{% endhighlight %}
+For most cloud provisioning tasks, Brooklyn uses
+<a href="http://jclouds.org">Apache jclouds</a>.
+The identifiers for some of the most commonly used jclouds-supported clouds are
+(or [see the full list](http://jclouds.apache.org/reference/providers/)):
-If you wish to use an existing key SSH, or an SSH key
-that has a passphrase, or a location other than `~/.ssh`, you can specify this in
-`brooklyn.properties` using `brooklyn.location.localhost.privateKeyFile` and
-`brooklyn.location.localhost.privateKeyPassphrase`.
+* `jclouds:aws-ec2:<region>`: Amazon EC2, where `:<region>` might be `us-east-1` or `eu-west-1` (or omitted)
+* `jclouds:softlayer:<region>`: IBM Softlayer, where `:<region>` might be `dal05` or `ams01` (or omitted)
+* `jclouds:google-compute-engine`: Google Compute Engine
+* `jclouds:openstack-nova:<endpoint>`: OpenStack, where `:<endpoint>` is the access URL (required)
+* `jclouds:cloudstack:<endpoint>`: Apache CloudStack, where `:<endpoint>` is the access URL (required)
-## Localhost
+For any of these, of course, Brooklyn needs to be configured with an `identity` and a `credential`:
-Brooklyn can access localhost if there is an SSH key on the machine and if the SSH key has been added to the list of `authorized_keys` on that machine.
+{% highlight yaml %}
+location:
+ jclouds:aws-ec2:
+ identity: ABCDEFGHIJKLMNOPQRST
+ credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
+{% endhighlight %}
+
+The above YAML can be embedded directly in blueprints, either at the root or on individual services.
+If you prefer to keep the credentials separate, these can be set instead in `brooklyn.properties`
+in the `jclouds.<provider>` namespace:
{% highlight bash %}
-# _Appends_ id_rsa.pub to authorized_keys. Other keys are unaffected.
-$ cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
+brooklyn.location.jclouds.aws-ec2.identity=ABCDEFGHIJKLMNOPQRST
+brooklyn.location.jclouds.aws-ec2.credential=s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
{% endhighlight %}
-MacOS user? In addition to the above, enable 'Remote Login' in System Preferences >
- Sharing.
+And in this case you can reference the location in YAML with `location: jclouds:aws-ec2`.
+The Getting Started [template brooklyn.properties](../start/brooklyn.properties) contains more examples
+of configuring cloud endpoints, including information on credential types used in different clouds.
-## Cloud Endpoints (via jclouds)
-[Apache jclouds](http://www.jclouds.org) is a multi-cloud library that Brooklyn uses to access many clouds. The [full list of supported providers](http://jclouds.apache.org/reference/providers/) is available on jclouds.apache.org.
+#### OS Initial Login and Setup
-Add your cloud provider's (API) credentials to `brooklyn.properties` and create an SSH key on the management machine.
+Once a machine is provisioned, Brooklyn will normally attempt to log in via SSH and configure the machine sensibly.
-Some clouds provide both API keys and SSH keys. In this case add only the API credentials to `brooklyn.properties`. (jclouds will transparently use the API credentials to setup access using the management machine's SSH key.)
+The credentials for the initial OS log on are typically discovered from the cloud,
+but in some environments this is not possible.
+The keys `loginUser` and either `loginUser.password` or `loginUser.privateKeyFile` can be used to force
+Brooklyn to use specific credentials for the initial login to a cloud-provisioned machine.
+(This is particularly useful when using a custom image templates where the cloud-side account management logic is not enabled.)
-### Example: AWS Virginia Large Centos
+Following a successful logon, Brooklyn performs the following steps to configure the machine:
-{% highlight bash %}
-## Snippet from ~/.brooklyn/brooklyn.properties.
+1. to create a new user with the same name as the user `brooklyn` is running as locally
+ (this can be overridden with `user`, below)
+
+1. to install the local user's `~/.ssh/id_rsa.pub` as an `authorized_keys` on the new machine,
+ to make it easy for the operator to `ssh` in
+ (override with `privateKeyFile`; or if there is no `id_{r,d}sa{,.pub}` an ad hoc keypair will be generated;
+ if there is a passphrase on the key, this must be supplied)
+
+1. give `sudo` access to the newly created user (override with `grantUserSudo: false`)
+
+1. disable direct `root` login to the machine
+
+These steps can be skipped or customized as described below.
+
+
+
+#### jclouds Config Keys
+
+The following is a subset of the most commonly used configuration keys used to customize
+cloud provisioning.
+For more keys and more detail on the keys below, see
+{% include java_link.html class_name="JcloudsLocationConfig" package_path="brooklyn/location/jclouds" project_subpath="locations/jclouds" %}.
+
+###### OS Setup
+
+- `user` and `password` can be used to configure the operating user created on cloud-provisioned machines
+
+- The `loginUser` config key (and subkeys) control the initial user to log in as,
+ in cases where this cannot be discovered from the cloud provider
+
+- Private keys can be specified using ``privateKeyFile``;
+ these are not copied to provisioned machines, but are required if using a local public key
+ or a pre-defined `authorized_keys` on the server.
+ (For more information on SSH keys, see [here](ssh-keys.html).)
+
+- If there is a passphrase on the key file being used, you must supply it to Brooklyn for it to work, of course!
+ ``privateKeyPassphrase`` does the trick (as in ``brooklyn.location.jclouds.privateKeyPassphrase``, or other places
+ where ``privateKeyFile`` is valid). If you don't like keys, you can just use a plain old ``password``.
+
+- Public keys can be specified using ``publicKeyFile``,
+ although these can usually be omitted if they follow the common pattern of being
+ the private key file with the suffix ``.pub`` appended.
+ (It is useful in the case of ``loginUser.publicKeyFile``, where you shouldn't need,
+ or might not even have, the private key of the ``root`` user in order to log in.)
+
+- Use `dontCreateUser` to have Brooklyn run as the initial `loginUser` (usually `root`),
+ without creating any other user.
+
+- A post-provisioning `setup.script` can be specified (as a URL) to run an additional script,
+ before making the `Location` available to entities,
+ optionally also using `setup.script.vars` (set as `key1:value1,key2:value2`)
+
+
+###### VM Creation
+
+- Most providers require exactly one of either `region` (e.g. `us-east-1`) or `endpoint` (the URL, usually for private cloud deployments)
+
+- Hardware requirements can be specified, including
+ ``minRam``, ``minCores``, and `os64Bit`; or as a specific ``hardwareId``
+
+- VM image constraints can be set using `osFamily` (e.g. `Ubuntu`, `CentOS`, `Debian`, `RHEL`)
+ and `osVersionRegex`, or specific VM images can be specified using ``imageId`` or ``imageNameRegex``
+
+- Specific VM images can be specified using ``imageId`` or ``imageNameRegex``
+
+- Specific Security Groups can be specified using `securityGroups`, as a list of strings (the existing security group names),
+ or `inboundPorts` can be set, as a list of numeric ports (selected clouds only)
-# Provide jclouds with AWS API credentials.
-brooklyn.location.jclouds.aws-ec2.identity = AKA_YOUR_ACCESS_KEY_ID
-brooklyn.location.jclouds.aws-ec2.credential = YourSecretKeyWhichIsABase64EncodedString
+- A specific existing key pair for the cloud to set for `loginUser` can be specified using `keyPair`
+ (selected clouds only)
-# Name this location 'AWS Virginia Large Centos' and wire to AWS US-East-1
-brooklyn.location.named.AWS\ Virginia\ Large\ Centos = jclouds:aws-ec2:us-east-1
+- User metadata can be attached, using the syntax ``userMetadata=key=value,key2="value 2"``
-# (Using the same name) specify image, user and minimum ram size (ie instance size)
+- You can specify the number of attempts Brooklyn should make to create
+ machines with ``machineCreateAttempts`` (jclouds only). This is useful for
+ working around the rare occasions in which cloud providers give machines that
+ are dead on arrival.
+
+- If you want to investigate failures, set `destroyOnFailure` to `false`
+ to keep failed VM's around. (You'll have to manually clean them up.)
+
+
+### Inheritance and Named Locations
+
+Named locations can be defined for commonly used groups of properties,
+with the syntax ``brooklyn.location.named.your-group-name.``
+followed by the relevant properties.
+These can be accessed at runtime using the syntax ``named:your-group-name`` as the deployment location.
+
+Some illustrative examples using named locations and
+showing the syntax and properties above are as follows:
+
+{% highlight bash %}
+# Production pool of machines for my application (deploy to named:prod1)
+brooklyn.location.named.prod1=byon:(hosts="10.9.1.1,10.9.1.2,produser2@10.9.2.{10,11,20-29}")
+brooklyn.location.named.prod1.user=produser1
+brooklyn.location.named.prod1.privateKeyFile=~/.ssh/produser_id_rsa
+brooklyn.location.named.prod1.privateKeyPassphrase=s3cr3tCOMPANYpassphrase
+
+# AWS using my company's credentials and image standard, then labelling images so others know they're mine
+brooklyn.location.named.company-jungle=jclouds:aws-ec2:us-west-1
+brooklyn.location.named.company-jungle.identity=BCDEFGHIJKLMNOPQRSTU
+brooklyn.location.named.company-jungle.privateKeyFile=~/.ssh/public_clouds/company_aws_id_rsa
+brooklyn.location.named.company-jungle.imageId=ami-12345
+brooklyn.location.named.company-jungle.minRam=2048
+brooklyn.location.named.company-jungle.userMetadata=application=my-jungle-app,owner="Bob Johnson"
+brooklyn.location.named.company-jungle.machineCreateAttempts=2
+
+brooklyn.location.named.AWS\ Virginia\ Large\ Centos = jclouds:aws-ec2
+brooklyn.location.named.AWS\ Virginia\ Large\ Centos.region = us-east-1
brooklyn.location.named.AWS\ Virginia\ Large\ Centos.imageId=us-east-1/ami-7d7bfc14
brooklyn.location.named.AWS\ Virginia\ Large\ Centos.user=root
brooklyn.location.named.AWS\ Virginia\ Large\ Centos.minRam=4096
+{% endhighlight %}
+If you are confused about inheritance order, the following test may be useful:
+{% highlight bash %}
+brooklyn.location.jclouds.KEY=VAL1
+brooklyn.location.jclouds.aws-ec2.KEY=VAL2
+brooklyn.location.named.my-aws=jclouds:aws-ec2
+brooklyn.location.named.my-aws.KEY=VAL3
{% endhighlight %}
-This will appear as 'AWS Virginia Large Centos' in the web console, but will need to be escaped on the command line as: `AWS\ Virginia\ Large\ Centos`.
+In the above example, if you deploy to `location: named:my-aws`,
+Brooklyn will get `VAL3` for `KEY`;
+this overrides `VAL2` which applies by default to all `aws-ec2` locations,
+which in turn overrides `VAL1`, which applies to all jclouds locations.
-See the Getting Started [template brooklyn.properties](../start/brooklyn.properties) for more examples of using cloud endpoints.
+### Localhost
-## Fixed Infrastructure
+If passwordless ssh login to `localhost` is enabled on your machine,
+you should be able to deploy blueprints with no special configuration,
+just by specifying `location: localhost` in YAML.
-Bringing your own nodes (BYON) to Brooklyn is straightforward.
+If you use a passpharse or prefer a different key, these can be configured as follows:
-You will need the IP addresses of the nodes and the access credentials. Both SSH and password based login are supported.
+{% highlight bash %}
+brooklyn.location.localhost.privateKeyFile=~/.ssh/brooklyn_key
+brooklyn.location.localhost.privateKeyPassphrase=s3cr3tPASSPHRASE
+{% endhighlight %}
-### Example: On-Prem Iron
+If you encounter issues or for more information, see [SSH Keys Localhost Setup](ssh-keys.html#localhost-setup).
-{% highlight bash %}
-## Snippet from ~/.brooklyn/brooklyn.properties.
-# Use the byon prefix, and provide the IP addresss (or IP ranges)
-brooklyn.location.named.On-Prem\ Iron\ Example=byon:(hosts="10.9.1.1,10.9.1.2,produser2@10.9.2.{10,11,20-29}")
-brooklyn.location.named.On-Prem\ Iron\ Example.user=produser1
-brooklyn.location.named.On-Prem\ Iron\ Example.privateKeyFile=~/.ssh/produser_id_rsa
-brooklyn.location.named.On-Prem\ Iron\ Example.privateKeyPassphrase=s3cr3tpassphrase
+### BYON
+
+"Bring-your-own-nodes" mode is useful in production, were machines have been provisioned by someone else,
+and during testing, to cut down provisioning time.
+
+To deploy to machines with known IP's in a blueprint, use the following syntax:
+
+{% highlight yaml %}
+location:
+ byon:
+ user: brooklyn
+ privateKeyFile: ~/.ssh/brooklyn.pem
+ hosts:
+ - 192.168.0.18
+ - 192.168.0.19
{% endhighlight %}
+Some of the login properties as described above for jclouds are supported,
+but not `loginUser` (as no users are created), and not any of the
+VM creation parameters such as `minRam` and `imageId`.
+(These clearly do not apply in the same way, and they are *not*
+by default treated as constraints, although an entity can confirm these
+where needed.)
+As before, if the brooklyn user and its default key are authorized for the hosts,
+those fields can be omitted.
-## Advanced Options
+Named locations can also be configured in your `brooklyn.properties`,
+using the format ``byon:(key=value,key2=value2)``.
+For convenience, for hosts wildcard globs are supported.
-Unusual provider? 'Featureful' API? Brooklyn can cope.
+{% highlight bash %}
+brooklyn.location.named.On-Prem\ Iron\ Example=byon:(hosts="10.9.1.1,10.9.1.2,produser2@10.9.2.{10,11,20-29}")
+brooklyn.location.named.On-Prem\ Iron\ Example.user=produser1
+brooklyn.location.named.On-Prem\ Iron\ Example.privateKeyFile=~/.ssh/produser_id_rsa
+brooklyn.location.named.On-Prem\ Iron\ Example.privateKeyPassphrase=s3cr3tpassphrase
+{% endhighlight %}
-[This spreadsheet](https://docs.google.com/a/cloudsoftcorp.com/spreadsheet/ccc?key=0Avy7Tdf2EOIqdGQzSlNiT2M0V19SejBScDhSdzMtT2c) provides explanation, guidance, and examples for the majority of location options.
+### Other Location Topics
+* [More Locations](more-locations.md)
+* [SSH Keys](ssh-keys.md)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/guide/ops/locations/more-locations.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/more-locations.md b/docs/guide/ops/locations/more-locations.md
new file mode 100644
index 0000000..35e2398
--- /dev/null
+++ b/docs/guide/ops/locations/more-locations.md
@@ -0,0 +1,55 @@
+---
+title: More Locations
+layout: website-normal
+children:
+- { section: Single Host }
+- { section: The Multi Location }
+- { section: The Server Pool }
+---
+
+Some additional location types are supported for specialized situations:
+
+### Single Host
+
+The spec `host`, taking a string argument (the address) or a map (`host`, `user`, `password`, etc.),
+provides a convenient syntax when specifying a single host.
+For example:
+
+{% highlight yaml %}
+services:
+- type: brooklyn.entity.webapp.jboss.JBoss7Server
+ location:
+ host: 192.168.0.1
+{% endhighlight %}
+
+Or, in `brooklyn.properties`, set `brooklyn.location.named.host1=host:(192.168.0.1)`.
+
+
+### The Multi Location
+
+The spec `multi` allows multiple locations, specified as `targets`,
+to be combined and treated as one location.
+When the first target is full, the next is tried, and so on:
+
+{% highlight yaml %}
+location:
+ multi:
+ targets:
+ - byon:(hosts=192.168.0.1)
+ - jclouds:aws-ec2:
+ identity: acct1
+ - jclouds:aws-ec2:
+ identity: acct2
+{% endhighlight %}
+
+The example above provisions the first node to `192.168.0.1`,
+then it provisions into `acct1` at Amazon if possible,
+and then to `acct2`.
+
+
+
+### The Server Pool
+
+The {% include java_link.html package_path="brooklyn/entity/pool" project_subpath="software/base" %}
+entity type allows defining an entity which becomes available as a location.
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/guide/ops/locations/ssh-keys.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/ssh-keys.md b/docs/guide/ops/locations/ssh-keys.md
new file mode 100644
index 0000000..6839f62
--- /dev/null
+++ b/docs/guide/ops/locations/ssh-keys.md
@@ -0,0 +1,60 @@
+---
+title: SSH Keys
+layout: website-normal
+---
+
+SSH keys are one of the simplest and most secure ways to access remote servers.
+They consist of two parts:
+
+* A private key (e.g. `id_rsa`) which is known only to one party or group
+
+* A public key (e.g. `id_rsa.pub`) which can be given to anyone and everyone,
+ and which can be used to confirm that a party has a private key
+ (or has signed a communication with the private key)
+
+In this way, someone -- such as you -- can have a private key,
+and can install a public key on a remote machine (in an `authorized_keys` file)
+for secure automated access.
+Commands such as `ssh` (and Brooklyn) can log in without
+revealing the private key to the remote machine,
+the remote machine can confirm it is you accessing it (if no one else has the private key),
+and no one snooping on the network can decrypt of any of the traffic.
+
+
+### Creating an SSH Key
+
+If you don't have an SSH key, create one with:
+
+{% highlight bash %}
+$ ssh-keygen -t rsa -N "" -f ~/.ssh/id_rsa
+{% endhighlight %}
+
+
+### Localhost Setup
+
+If you want to deploy to `localhost`, ensure that you have a public and private key,
+and that your key is authorized for ssh access:
+
+{% highlight bash %}
+# _Appends_ id_rsa.pub to authorized_keys. Other keys are unaffected.
+$ cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
+{% endhighlight %}
+
+You should be able to run `ssh localhost` without any password required.
+
+**Got a passphrase?** Set `brooklyn.location.localhost.privateKeyPassphrase`
+as described [here](index.html#os-setup)
+
+**MacOS user?** In addition to the above, enable "Remote Login" in "System Preferences > Sharing".
+
+
+### Potential Problems
+
+* `~/.ssh/` or files in that directory too open: they should be visible only to the user (apart from public keys),
+ both on the source machine and the target machine
+
+* Sometimes machines are configured with different sets of support SSL/TLS versions and ciphers;
+ if command-line `ssh` and `scp` work, but Brooklyn/java does not, check the versions enabled in Java and on both servers.
+
+* Missing entropy: creating and using ssh keys requires randomness available on the servers,
+ usually in `/dev/random`; see [here]({{ site.path.website }}/documentation/increase-entropy.html) for more information
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/guide/ops/persistence/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/persistence/index.md b/docs/guide/ops/persistence/index.md
index 819e182..cbb3112 100644
--- a/docs/guide/ops/persistence/index.md
+++ b/docs/guide/ops/persistence/index.md
@@ -1,6 +1,13 @@
---
title: Persistence
layout: website-normal
+children:
+- { section: Command Line Options }
+- { section: File-based Persistence }
+- { section: Object Store Persistence }
+- { section: Rebinding to State }
+- { section: High Availability }
+- { section: Writing Persistable Code }
---
Brooklyn can be configured to persist its state so that the Brooklyn server can be restarted,
@@ -92,8 +99,8 @@ brooklyn launch --persist auto --persistenceDir myContainerName --persistenceLoc
{% endhighlight %}
-Rebind
-------
+Rebinding to State
+------------------
When Brooklyn starts up pointing at existing state, it will recreate the entities, locations
and policies based on that persisted state.
@@ -104,8 +111,7 @@ HTTP or JMX). This new state will be reported in the web-console and can also tr
any registered policies.
-Copying Persistence State
--------------------------
+## CLI Commands for Copying State
Brooklyn includes a command to copy persistence state easily between two locations.
The `copy-state` CLI command takes the following arguments:
@@ -122,10 +128,11 @@ The `copy-state` CLI command takes the following arguments:
The local transformations file to be applied to the copy of the data before uploading it.
-Handling Rebind Failures
-------------------------
-If rebind were to fail for any reason, details of the underlying failures will be reported
-in the brooklyn.debug.log. There are several approaches to resolving problems.
+## Handling Rebind Failures
+
+If rebind fails fail for any reason, details of the underlying failures will be reported
+in the `brooklyn.debug.log`. There are several approaches to resolving problems.
+
### Determine Underlying Cause
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/style/css/_code_blocks.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_code_blocks.scss b/docs/style/css/_code_blocks.scss
index 269c6a0..dd39dd8 100644
--- a/docs/style/css/_code_blocks.scss
+++ b/docs/style/css/_code_blocks.scss
@@ -41,6 +41,9 @@ code {
padding: 4px 4px 2px 4px;
border-radius: 3px;
}
+a code {
+ color: inherit;
+}
.nowrap { @include nowrap(); }
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5cf0666f/docs/website/documentation/increase-entropy.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/increase-entropy.md b/docs/website/documentation/increase-entropy.md
index bd0e8ea..53d5768 100644
--- a/docs/website/documentation/increase-entropy.md
+++ b/docs/website/documentation/increase-entropy.md
@@ -1,5 +1,5 @@
---
-title: Increase entropy
+title: Increase Entropy
layout: website-normal
---
If you are installing AMP on a virtual machine, you may find it useful to increase the Linux kernel entropy to speed up the ssh connections to the managed entities. You can install and configure `rng-tools` or just use /dev/urandom`.
[03/13] incubator-brooklyn git commit: feature list in the docs
Posted by he...@apache.org.
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 <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 13:06:27 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
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 }
---
[02/13] incubator-brooklyn git commit: refactor CSS and apply to
javadoc
Posted by he...@apache.org.
refactor CSS and apply to javadoc
javadoc now doesn't look unloved, and datestamp is only on overview summary page
(means we can update files much more easily),
also SHA1 is on overview summary page for completeness
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/310c4148
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/310c4148
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/310c4148
Branch: refs/heads/master
Commit: 310c4148ea70ae54f668253cf8bddb187a37e9f3
Parents: 677762b
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 12:11:39 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Jan 19 22:57:24 2015 +0000
----------------------------------------------------------------------
docs/.gitignore | 1 +
docs/_build/build.sh | 15 +-
docs/_build/javadoc-overview.html | 21 +
docs/_build/make-javadoc.sh | 14 +-
docs/_config.yml | 3 +
docs/_includes/base-head.html | 2 +-
docs/_includes/base-scss.scss | 1 +
docs/_layouts/guide-normal.html | 23 -
docs/guide/start/config.md | 2 +
docs/style/css/_archive_warning.scss | 31 ++
docs/style/css/_basic.scss | 61 +++
docs/style/css/_blueprint_tour.scss | 175 +++++++
docs/style/css/_code_blocks.scss | 95 ++++
docs/style/css/_footer.scss | 36 ++
docs/style/css/_landing.scss | 26 +
docs/style/css/_main_container.scss | 78 +++
docs/style/css/_menu.scss | 201 ++++++++
docs/style/css/_search.scss | 29 ++
docs/style/css/_tooltips.scss | 14 +
docs/style/css/_util.scss | 27 +
docs/style/css/base.scss | 793 ------------------------------
docs/style/css/guide-toc.css | 88 ----
docs/style/css/guide.css | 119 -----
docs/style/css/javadoc.scss | 119 +++++
docs/style/css/website.scss | 19 +
25 files changed, 963 insertions(+), 1030 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/.gitignore
----------------------------------------------------------------------
diff --git a/docs/.gitignore b/docs/.gitignore
index 1311819..3767b72 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,2 +1,3 @@
_site
_config_local.yml
+.sass-cache
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index 74d8a30..eb9215a 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -43,6 +43,7 @@ function parse_mode() {
exit 0 ;;
website-root)
JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-guide.yml,_build/config-website-root.yml
+ STYLE_SUBDIR=style
DIRS_TO_MOVE[0]=website
DIRS_TO_MOVE_TARGET[0]=""
SKIP_JAVADOC=true
@@ -55,7 +56,8 @@ function parse_mode() {
DIRS_TO_MOVE[0]=guide
DIRS_TO_MOVE_TARGET[0]=v/latest
DIRS_TO_MOVE[1]=style
- DIRS_TO_MOVE_TARGET[1]=v/latest/style
+ STYLE_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/style
+ DIRS_TO_MOVE_TARGET[1]=$STYLE_SUBDIR
INSTALL_RSYNC_OPTIONS=""
INSTALL_RSYNC_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/
JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/
@@ -68,7 +70,8 @@ function parse_mode() {
# BROOKLYN_VERSION_BELOW
DIRS_TO_MOVE_TARGET[0]=v/0.7.0-SNAPSHOT
DIRS_TO_MOVE[1]=style
- DIRS_TO_MOVE_TARGET[1]=${DIRS_TO_MOVE_TARGET[0]}/style
+ STYLE_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/style
+ DIRS_TO_MOVE_TARGET[1]=$STYLE_SUBDIR
INSTALL_RSYNC_OPTIONS=""
INSTALL_RSYNC_SUBDIR=${DIRS_TO_MOVE_TARGET[0]}/
JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/
@@ -78,6 +81,7 @@ function parse_mode() {
JEKYLL_CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.yml,_build/config-guide-root.yml
DIRS_TO_MOVE[0]=guide
DIRS_TO_MOVE_TARGET[0]=""
+ STYLE_SUBDIR=style
JAVADOC_TARGET=$JAVADOC_SUBPATH/
SUMMARY="user guide files in the root"
;;
@@ -87,6 +91,7 @@ function parse_mode() {
DIRS_TO_MOVE_TARGET[0]=v/latest
DIRS_TO_MOVE[1]=website
DIRS_TO_MOVE_TARGET[1]=""
+ STYLE_SUBDIR=style
JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/
SUMMARY="all files, website in root and guide in /${DIRS_TO_MOVE_TARGET[0]}"
;;
@@ -97,12 +102,14 @@ function parse_mode() {
DIRS_TO_MOVE[1]=website
DIRS_TO_MOVE_TARGET[1]=brooklyn
DIRS_TO_MOVE[2]=style
- DIRS_TO_MOVE_TARGET[2]=brooklyn/style
+ STYLE_SUBDIR=${DIRS_TO_MOVE_TARGET[1]}/style
+ DIRS_TO_MOVE_TARGET[2]=$STYLE_SUBDIR
JAVADOC_TARGET=${DIRS_TO_MOVE_TARGET[0]}/$JAVADOC_SUBPATH/
SUMMARY="all files in /brooklyn"
;;
original)
JEKYLL_CONFIG=_config.yml,_build/config-production.yml
+ STYLE_SUBDIR=style
SUMMARY="all files in their original place"
;;
"")
@@ -192,6 +199,8 @@ function make_javadoc() {
return 1
fi
mv _build/target/$JAVADOC_BUILD_TARGET_SUBPATH/* _site/$JAVADOC_TARGET
+ cat _site/${STYLE_SUBDIR}/css/javadoc.css >> _site/$JAVADOC_TARGET/stylesheet.css || return 1
+ cp _site/${STYLE_SUBDIR}/img/feather.png _site/$JAVADOC_TARGET/ || return 1
fi
}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_build/javadoc-overview.html
----------------------------------------------------------------------
diff --git a/docs/_build/javadoc-overview.html b/docs/_build/javadoc-overview.html
new file mode 100644
index 0000000..a429ea3
--- /dev/null
+++ b/docs/_build/javadoc-overview.html
@@ -0,0 +1,21 @@
+<html><body>
+
+<!-- BROOKLYN_VERSION -->
+Javadoc for <a href="http://brooklyn.io"> Apache Brooklyn</a> 0.7.0-SNAPSHOT
+
+<p>
+ Apache Brooklyn is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the
+ Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the
+ infrastructure, communications, and decision making process have stabilized in a manner consistent with other
+ successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of
+ the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+</p>
+<p>
+ Apache Brooklyn is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.
+</p>
+
+<p>
+This is the Javadoc for v 0.7.0-SNAPSHOT (git SHA1 hash ${SHA1STAMP}) auto-generated on ${DATESTAMP}.
+</p>
+
+</body><html>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_build/make-javadoc.sh
----------------------------------------------------------------------
diff --git a/docs/_build/make-javadoc.sh b/docs/_build/make-javadoc.sh
index 1a80efd..9dd9f82 100755
--- a/docs/_build/make-javadoc.sh
+++ b/docs/_build/make-javadoc.sh
@@ -19,7 +19,9 @@ fi
mkdir -p target
rm -rf target/$JAVADOC_TARGET1_SUBPATH/
+export YEARSTAMP=`date "+%Y"`
export DATESTAMP=`date "+%Y-%m-%d"`
+export SHA1STAMP=`git rev-parse HEAD`
# BROOKLYN_VERSION_BELOW
export BROOKLYN_JAVADOC_CLASSPATH=../../usage/all/target/brooklyn-all-0.7.0-SNAPSHOT-with-dependencies.jar
@@ -40,8 +42,10 @@ javadoc -sourcepath $SOURCE_PATHS \
-classpath "${BROOKLYN_JAVADOC_CLASSPATH}" \
-doctitle "Apache Brooklyn" \
-windowtitle "Apache Brooklyn" \
- -header "Apache Brooklyn" \
- -footer '<b>Apache Brooklyn - Multi-Cloud Application Management</b> <br/> <a href="http://brooklyn.io/" target="_top">brooklyn.io</a>. Apache License. © '$DATESTAMP'.' \
+ -notimestamp \
+ -overview javadoc-overview.html \
+ -header '<a href="/" class="brooklyn-header">Apache Brooklyn <div class="img"></div></a>' \
+ -footer '<b>Apache Brooklyn - Multi-Cloud Application Management</b> <br/> <a href="http://brooklyn.io/" target="_top">brooklyn.io</a>. Apache License. © '$YEARSTAMP'.' \
2>&1 1>/dev/null | tee target/javadoc.log
if ((${PIPESTATUS[0]})) ; then echo ; echo ; echo "ERROR: javadoc process exited non-zero" ; exit 1 ; fi
@@ -51,7 +55,11 @@ if [ ! -f target/$JAVADOC_TARGET1_SUBPATH/brooklyn/entity/Entity.html ]; then ec
if [ ! -z "`grep warnings target/javadoc.log`" ] ; then echo "WARNINGs occurred during javadoc build. See target/javadoc.log for more information." ; fi
-if [ -d ../_site/guide/$$JAVADOC_TARGET2_SUBPATH/ ] ; then
+sed -i.bak s/'${DATESTAMP}'/"${DATESTAMP}"/ target/$JAVADOC_TARGET1_SUBPATH/overview-summary.html
+sed -i.bak s/'${SHA1STAMP}'/"${SHA1STAMP}"/ target/$JAVADOC_TARGET1_SUBPATH/overview-summary.html
+rm target/$JAVADOC_TARGET1_SUBPATH/*.bak
+
+if [ -d ../_site/guide/$JAVADOC_TARGET2_SUBPATH/ ] ; then
echo "API directory detected in test structure _site, copying docs there so they can be served with serve-site.sh"
cp -r target/$JAVADOC_TARGET1_SUBPATH/* ../_site/guide/$JAVADOC_TARGET2_SUBPATH/
fi
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 343da20..121dbad 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -41,6 +41,9 @@ root_menu_page: /website/index.md
# These files should not be included in the final build (in addition to _* contents)
exclude: ['/Gemfile*','/README.md']
+sass:
+ sass_dir: style/css
+
brooklyn-stable-version: 0.7.0-M2-incubating
brooklyn-version: 0.7.0-SNAPSHOT # BROOKLYN_VERSION
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_includes/base-head.html
----------------------------------------------------------------------
diff --git a/docs/_includes/base-head.html b/docs/_includes/base-head.html
index 7286eb7..dc1d31f 100644
--- a/docs/_includes/base-head.html
+++ b/docs/_includes/base-head.html
@@ -10,7 +10,7 @@
<link rel="stylesheet" href="{{ site.path.style }}/css/code.css" type="text/css" media="screen" />
-<link href="{{site.path.style}}/css/base.css" rel="stylesheet">
+<link href="{{site.path.style}}/css/website.css" rel="stylesheet">
<script src="{% dependency_url jquery.js %}"></script>
<script src="{% dependency_url bootstrap.js %}"></script>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_includes/base-scss.scss
----------------------------------------------------------------------
diff --git a/docs/_includes/base-scss.scss b/docs/_includes/base-scss.scss
index d102394..aec3e2f 100644
--- a/docs/_includes/base-scss.scss
+++ b/docs/_includes/base-scss.scss
@@ -1,5 +1,6 @@
$fonts: "Lato", "Helvetica Neue", Helvetica, Arial, sans-serif;
+$header_fonts: Avenir, $fonts;
// colors
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/_layouts/guide-normal.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/guide-normal.html b/docs/_layouts/guide-normal.html
deleted file mode 100644
index 67278e7..0000000
--- a/docs/_layouts/guide-normal.html
+++ /dev/null
@@ -1,23 +0,0 @@
----
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. 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
-#
-# 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.
-
-layout: website-normal
----
-
-{{ content }}
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/guide/start/config.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/config.md b/docs/guide/start/config.md
index 1fa61be..10895d6 100644
--- a/docs/guide/start/config.md
+++ b/docs/guide/start/config.md
@@ -5,6 +5,8 @@ layout: website-normal
menu_parent: index.md
---
+{% include fields.md %}
+
Brooklyn reads startup configuration from a file `~/.brooklyn/brooklyn.properties`, by default.
You can create this from a template [brooklyn.properties]({{brooklyn_properties_url_path}}) file which you edit.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_archive_warning.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_archive_warning.scss b/docs/style/css/_archive_warning.scss
new file mode 100644
index 0000000..5803458
--- /dev/null
+++ b/docs/style/css/_archive_warning.scss
@@ -0,0 +1,31 @@
+/* ARCHIVE PAGE WARNING
+ ----------------------------------------------------------------------- */
+
+#page_notes {
+ display: none;
+ background-color: #4D9D3A;
+ border: 3px solid orange;
+ -moz-border-radius: 8px;
+ border-radius: 8px;
+ padding: 0.3em;
+ padding-left: 0.75em;
+ margin-top: 24px;
+ margin-bottom: -24px;
+
+ div.warning {
+ background-color: #F8CB9C;
+ border: 1px solid #FFAB7C;
+ padding-left: 0.75em;
+ -moz-border-radius: 8px;
+ border-radius: 8px;
+ }
+ .warning_banner_image img {
+ width: 64px; padding-top: 8px; padding-right: 12px;
+ float: left;
+ }
+ p { line-height: 100%; color: white; }
+ p.warning_banner_buttons {padding-right: 24px; }
+ p.warning_banner_buttons a, #page_notes p.warning_banner_buttons a:visited {
+ color: orange; font-weight: bold; padding-right: 1em; text-decoration: none; }
+ p.warning_banner_buttons a:hover { color: #FFC31E; font-weight: bold; }
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_basic.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_basic.scss b/docs/style/css/_basic.scss
new file mode 100644
index 0000000..2f5a989
--- /dev/null
+++ b/docs/style/css/_basic.scss
@@ -0,0 +1,61 @@
+/* BASIC STYLES
+ ----------------------------------------------------------------------- */
+body {
+ margin: 0px;
+ padding: 60px 0px 20px 0px;
+ font-family: $fonts;
+ font-weight: 300;
+ font-size: 17px;
+ background-color: white;
+ color: $text_color;
+}
+h1, h2, h3, h4, h5, h6 { font-family: $header_fonts; }
+input, select, textarea {}
+p, li, label, td, th,input, select, textarea {}
+p, input, label, li {}
+p { margin: 0.75em 0; line-height: 1.4em;}
+form {padding: 0; margin: 0;}
+img {border: 0;}
+
+a {color: $a_color;}
+a:hover {text-decoration: none; color: $a_hover_color;}
+
+/* Offset link anchors so they are not hidden by the header */
+a[id]:empty, a[name]:empty {
+ padding-top: 60px;
+ margin-top: -60px;
+ display: block;
+}
+.dropdown-menu > li > a {
+ font-weight: 300;
+}
+.btn-default, .btn-primary, .btn-success, .btn-info, .btn-warning, .btn-danger {
+ text-shadow: none;
+ font-weight: 300;
+}
+.btn-default {
+ color: $gray_66;
+}
+.panel-heading {
+ h4 {
+ padding-bottom: 0px;
+ margin-bottom: 0px;
+ }
+}
+.panel-body {
+ margin: 0px;
+ font-size: 95%;
+ color: $gray_66;
+ padding: 15px;
+ background-color: $white_fa;
+ border-radius: 5px;
+ p:first-child {
+ margin-top: 0px;
+ }
+ p:last-child {
+ margin-bottom: 0px;
+ }
+ > ul, > ol {
+ margin-left: -1em;
+ }
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_blueprint_tour.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_blueprint_tour.scss b/docs/style/css/_blueprint_tour.scss
new file mode 100644
index 0000000..203ca03
--- /dev/null
+++ b/docs/style/css/_blueprint_tour.scss
@@ -0,0 +1,175 @@
+/* YAML EXPLAINED
+ ----------------------------------------------------------------------- */
+
+$explained_code_bg_color: $gray_66;
+$explained_code_fg_color: $white_dd;
+$explained_code_highlight_bg_color: $vibrant_bg_green;
+$explained_code_highlight_fg_color: $white_fa;
+$explained_text_highlight_fg_color: $text_color;
+$explained_text_highlight_bg_color: $white_fa;
+
+$code_width: 57%;
+$annotation_width: 41%;
+
+div.annotated_blueprint {
+ margin-top: 60px;
+ div.code_scroller {
+ background-color: $code_bg_color;
+ border: 0.4em solid $explained_code_bg_color;
+ border-left: 0;
+ border-right: 0;
+ border-radius: 3px;
+ width: $code_width;
+ margin-right: 0px;
+ margin-left: auto;
+ background-color: $explained_code_bg_color;
+ color: $explained_code_fg_color;
+ overflow-x: scroll;
+ div {
+ overflow-x: visible !important;
+ overflow-y: visible !important;
+ }
+ div.code_viewer {
+ width: auto;
+ height: 100%;
+ div.block {
+ @include flex();
+ -webkit-align-items: center;
+ align-items: center;
+ z-index: -10;
+ }
+ div.block > div:last-child {
+ @include pre();
+ border: 0;
+ border-radius: 0;
+ padding: 0px 0.6em;
+ background-color: $explained_code_bg_color;
+ color: $explained_code_fg_color;
+ min-width: 100%;
+ margin-top: 3px;
+ margin-bottom: 3px;
+ }
+ div.block > div.annotations_wrapper1 {
+ font-family: $fonts;
+ div.annotations_wrapper2 {
+ // seems we have to use abs positioning because other techniques
+ // (translation, negative margins, etc) don't show up outside the scroll-x
+ position: absolute;
+ @include transform('translateX(-100%) translateY(-50%)');
+ width: $annotation_width;
+
+ @include flex();
+ -webkit-align-items: center;
+ align-items: center;
+ div.annotations {
+ // positioning and sizing
+ height: auto;
+ width: 100%;
+ padding: 8px 8px;
+ color: $explained_text_highlight_fg_color;
+
+ div.short {
+ font-size: 125%;
+ text-align: right;
+ }
+ div.long {
+ display: none;
+
+ font-size: 85%;
+ p { margin: 8px 0 8px 0; }
+ p:first-child { margin-top: 0; }
+ p:last-child { margin-bottom: 0; }
+ }
+ }
+ div.connector {
+ height: 7px;
+ width: 24px;
+ }
+ }
+ }
+ div.block:hover > div:last-child {
+ background-color: $explained_code_highlight_bg_color;
+ color: $explained_code_highlight_fg_color;
+ // TODO the bg color doesn't apply to regions which are only visible after a scroll-right :(
+ // to fix this i think we can us JS to set width of div.block to the width of this, the code last-child
+ }
+ div.block:hover {
+ z-index: 30 !important;
+ div.annotations_wrapper1 {
+ z-index: 30 !important;
+ }
+ div.annotations {
+ background-color: $explained_text_highlight_bg_color;
+ border: 4px solid $explained_code_highlight_bg_color;
+ border-radius: 8px;
+ text-align: center;
+ div.short {
+ font-size: 100% !important;
+ text-align: center !important;
+ color: $text_color;
+ margin-bottom: 8px;
+ font-weight: bold;
+ z-index: 10;
+ }
+ div.long { display: inherit !important; }
+ }
+ div.connector {
+ background-color: $explained_code_highlight_bg_color;
+ }
+ }
+ // highlighting of key code segments
+ div.block > div:last-child .ann_highlight {
+ font-weight: bold;
+ color: #e8f0e0;
+ }
+ div.block:hover > div:last-child .ann_highlight {
+ color: #f8fff8;
+ }
+ }
+ }
+ div.code_viewer:hover {
+ div.annotations div.short {
+ color: $gray_aa;
+ }
+ }
+
+ // have an initial notice
+ div.code_scroller {
+ div.initial_notice {
+ height: 0;
+ width: 0;
+ overflow-x: visible;
+ overflow-y: visible;
+ }
+ div.initial_notice > div {
+ z-index: 10;
+ background-color: transparentize($gray_aa, 0.1);
+ position: relative;
+ width: 0;
+ height: 0;
+ @include flex();
+ -webkit-align-items: top;
+ align-items: top;
+ }
+ div.initial_notice > div > div {
+ padding-top: 24px;
+ font-size: 125%;
+ font-weight: bold;
+ text-align: center;
+ width: 100%;
+ .ann_light {
+ padding-top: 12px;
+ font-weight: 300;
+ }
+ .ann_play {
+ display: block;
+ padding-top: 24px;
+ padding-bottom: 24px;
+ font-size: 600%;
+ }
+ }
+ }
+ div.code_scroller:hover div.initial_notice {
+ display: none;
+ }
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_code_blocks.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_code_blocks.scss b/docs/style/css/_code_blocks.scss
new file mode 100644
index 0000000..269c6a0
--- /dev/null
+++ b/docs/style/css/_code_blocks.scss
@@ -0,0 +1,95 @@
+/* CODE RENDERING
+ ----------------------------------------------------------------------- */
+@mixin nowrap() {
+ white-space: pre;
+ word-wrap: normal;
+ overflow-y: scroll;
+}
+
+@mixin code() {
+ font-family: Consolas, Lucida Console, Monaco, monospace;
+ @include nowrap();
+ font-size: 14px;
+ /* override color and bg-color on 'code' from bootstrap, and a touch more padding on top since font-size is smaller */
+ color: $text_color;
+ background-color: $code_bg_color;
+}
+
+@mixin pre() {
+ @include code();
+ padding: 0.4em 0.8em;
+ overflow-x: scroll;
+ /* override border and line-height on 'pre' from bootstrap */
+ border: none;
+ border-radius: 2px;
+ line-height: 1.4;
+ font-size: 13px;
+}
+
+pre {
+ @include pre();
+ code {
+ /* override settings on 'pre code' from bootstrap */
+ @include pre();
+ line-height: 1;
+ /** and no padding since pre already has some */
+ padding: 0px;
+ }
+}
+code {
+ @include code();
+ padding: 4px 4px 2px 4px;
+ border-radius: 3px;
+}
+
+.nowrap { @include nowrap(); }
+
+.highlight { background-color:$code_bg_color; } /* clipboard icon should have the same background color as the code */
+
+.highlight .clipboard_button { display: none; }
+.highlight:hover .clipboard_button { display: inherit; }
+.clipboard_button.zeroclipboard-is-hover { display: inherit; }
+
+.clipboard_container { float: right; padding: 8px; }
+.clipboard_button:before {
+ // fa-copy
+ content: "\f0c5";
+}
+.clipboard_button {
+ font-size: 18px;
+ color: $vibrant_fg_green;
+ @include transform('translateY(-2px)');
+}
+.clipboard_button:hover, .clipboard_button.zeroclipboard-is-hover {
+ color: $a_hover_color;
+ cursor: pointer; cursor: hand;
+}
+.clipboard_button.zeroclipboard-is-active .on-active {
+ display: inherit;
+}
+.clipboard_button .on-active {
+ // z-index often doesn't help here (diff stacking context to the side menu)... but it shouldn't hurt!
+ z-index: 10;
+ font-family: $fonts;
+ display: none;
+ margin-top: -20px;
+ height: 0;
+ width: 0;
+ overflow-x: visible;
+ overflow-y: visible;
+ position: relative;
+ top: -30px;
+}
+.clipboard_button .on-active > div {
+ background-color: $white_dd;
+ border: 1px solid $gray_aa;
+ font-size: 75%;
+ font-weight: normal;
+ left: -50%;
+ color: $blackish;
+ width: auto;
+ display: inline-block;
+ @include nowrap();
+ padding: 3px 7px;
+ @include transform('translateX(-50%)');
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_footer.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_footer.scss b/docs/style/css/_footer.scss
new file mode 100644
index 0000000..4034de4
--- /dev/null
+++ b/docs/style/css/_footer.scss
@@ -0,0 +1,36 @@
+/* FOOTER
+ ----------------------------------------------------------------------- */
+
+/* sticky footer */
+html {
+ position: relative;
+ min-height: 100%;
+}
+
+@media (min-width: 1200px) {
+ .slightlyNarrowContainer {
+ width: 970px;
+ }
+}
+
+div#footer {
+ position: absolute;
+ bottom: 0;
+ width: 100%;
+ padding-top: 1em;
+ padding-bottom: 1em;
+ background-color: $white_f5;
+ text-align: center;
+ font-size: 80%;
+}
+.octicon-footer {
+ color: $footer_icon_gray;
+ font-size: 130%;
+ position: relative;
+ top: 2px;
+ padding-left: 6px;
+}
+a:hover .octicon-footer {
+ color: $brooklyn_green;
+}
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_landing.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_landing.scss b/docs/style/css/_landing.scss
new file mode 100644
index 0000000..baeff39
--- /dev/null
+++ b/docs/style/css/_landing.scss
@@ -0,0 +1,26 @@
+
+/* LANDING PAGE
+ ----------------------------------------------------------------------- */
+
+.jumbotron {
+ margin-top: 18px;
+}
+
+#apachebrooklynbanner {
+ background-image: url("../img/apache-brooklyn-logo-817px-wide.png");
+ background-repeat: no-repeat;
+ background-position: center;
+ width: 817px;
+ height: 99px;
+ margin-bottom: 50px;
+}
+
+div.feather.landing {
+ overflow: visible;
+ max-height: 10px;
+ img {
+ width: 200px;
+ margin-left: 40px;
+ margin-top: 0px;
+ }
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_main_container.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_main_container.scss b/docs/style/css/_main_container.scss
new file mode 100644
index 0000000..09e2634
--- /dev/null
+++ b/docs/style/css/_main_container.scss
@@ -0,0 +1,78 @@
+
+#content_container {
+ padding-bottom: 48px;
+ img {
+ max-width: 100%;
+ }
+}
+
+
+/* HEADER LINKS
+ ----------------------------------------------------------------------- */
+
+/* this causes jumps to anchors to show the anchor below the navbar */
+#content_container { h1, h2, h3, h4, h5, h6 {
+ margin-top: -64px;
+ padding-top: 64px;
+}}
+
+#content_container h1 {
+ max-width: 95%;
+ font-variant: normal;
+ margin-top: -16px;
+ padding-bottom: 6px;
+ margin-bottom: 24px;
+ border-bottom: 1px dotted $gray_aa;
+ font-weight: 300;
+ font-size: 36px;
+ text-transform: uppercase;
+}
+
+/* headings get a tooltip showing the permalink URL, a la github jekyll */
+/* install subset of font-awesome */
+@font-face {
+ font-family: 'FontAwesome';
+ src: url('#{$style_dir}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.eot');
+ src: url('#{$style_dir}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.eot?#iefix&v=4.2.0') format('embedded-opentype'), url('#{$style_dir}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.woff?v=4.2.0') format('woff'), url('#{$style_dir}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.ttf?v=4.2.0') format('truetype'), url('#{$style_dir}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular') format('svg');
+ font-weight: normal;
+ font-style: normal;
+}
+.fa {
+ display: inline-block;
+ font-family: FontAwesome;
+ font-style: normal;
+ font-weight: normal;
+ line-height: 1;
+ -webkit-font-smoothing: antialiased;
+ -moz-osx-font-smoothing: grayscale;
+}
+.fa-link:before {
+ content: "\f0c1";
+}
+.fa-play-circle-o:before {
+ content: "\f01d";
+}
+/*
+ * This code is courtesy Ben Balter, modified by Parker Moore for jekyllrb.com
+ * http://ben.balter.com/2014/03/13/pages-anchor-links/
+ */
+.header-link {
+ position: relative;
+ left: 0.5em;
+ opacity: 0;
+ font-size: 0.8em;
+
+/* not using -- but this is cool!
+ -webkit-transition: opacity 0.2s ease-in-out 0.1s;
+ -moz-transition: opacity 0.2s ease-in-out 0.1s;
+ -ms-transition: opacity 0.2s ease-in-out 0.1s;
+*/
+}
+h2:hover .header-link,
+h3:hover .header-link,
+h4:hover .header-link,
+h5:hover .header-link,
+h6:hover .header-link {
+ opacity: 1;
+}
+a.header-literal-anchor { display: inline !important; }
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_menu.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_menu.scss b/docs/style/css/_menu.scss
new file mode 100644
index 0000000..b63386e
--- /dev/null
+++ b/docs/style/css/_menu.scss
@@ -0,0 +1,201 @@
+/* WEBSITE MENUS
+ ----------------------------------------------------------------------- */
+
+/* top menu bar */
+.navbar-brand {
+ margin-top: -4px;
+ margin-left: -30px !important;
+}
+
+@mixin icon($name) {
+ .icon-#{$name} {
+ width: 32px;
+ height: 32px;
+ background: url('#{$style_dir}/img/'+$name+'-256-black.png');
+ background-size: 32px 32px;
+ }
+ .icon-#{$name}:hover {
+ background: url('#{$style_dir}/img/'+$name+'-256-green.png');
+ background-size: 32px 32px;
+ }
+}
+
+.navbar {
+ @include icon('github');
+ @include icon('twitter');
+ @include icon('irc');
+}
+
+.navbar .tooltip .tooltip-inner {
+ position: relative;
+ right: 40%;
+ // include calc for those browsers which support it
+ right: calc(50% - 25px);
+ max-width: 300px;
+}
+
+/* special container with sidebar where if sidebar is squeezed
+ (under "responsiveness") the text keeps at least its "auto" size,
+ squashing the main container instead */
+.container-and-sidebars {
+ width: 100%;
+ @include flex();
+}
+.container-between-sidebars {
+ -webkit-box-flex: 1 100%;
+ -webkit-flex: 1 100%;
+ -webkit-flex-flex: 1 100%;
+ flex: 1 100%;
+ flex: 10 1 100%;
+ display: inline-block;
+ width: auto;
+ margin-left: auto;
+ margin-right: auto;
+}
+.container-sidebar {
+ -webkit-box-flex: 0 auto;
+ -webkit-flex: 0 auto;
+ -webkit-flex-flex: 0 auto;
+ flex: 0 auto;
+ flex: 0 0 auto;
+}
+.container-sidebar-right {
+ @extend .container-sidebar;
+ text-align: left;
+ padding-right: 10px;
+}
+.container-sidebar-left {
+ @extend .container-sidebar;
+ text-align: right;
+ padding-left: 10px;
+}
+
+@media (min-width: 768px) {
+ .container-sidebar { min-width: calc((100% - 750px)/2); }
+}
+@media (min-width: 992px) {
+ .container-sidebar { min-width: calc((100% - 970px)/2); }
+}
+@media (min-width: 1200px) {
+ .container-sidebar { min-width: calc((100% - 1170px)/2); }
+}
+
+
+.navbar-feather {
+ padding-top: 12px;
+ margin-right: -6px;
+}
+.navbar-sidebar-right-icons {
+ padding-top: 10px;
+ margin-left: -6px;
+ white-space: nowrap;
+ a {
+ display: inline-block;
+ width: 32px;
+ height: 32px;
+ }
+}
+.navbar-icon-shift { margin-right: -2px; }
+
+.navbar div.dropdown_section_header hr {
+ margin: 4px 12px;
+ border-color: $white_dd;
+}
+
+.navbar div.dropdown_new_section hr {
+ margin: 6px 0px;
+ border-color: $white_dd;
+}
+
+/* pop-up top-menu */
+.navbar-default .navbar-nav > li > a:hover,
+.navbar-default .navbar-nav > li > a:focus,
+.navbar-default .navbar-nav > .active > a:hover,
+.navbar-default .navbar-nav > .active > a:focus {
+ background-color: $white_f5;
+ color: $brooklyn_green;
+}
+.top-menu {
+ font-size: 14px;
+ font-weight: 400;
+ .dropdown-menu > li > a:hover, .dropdown-menu > li > a:focus {
+ background-color: $white_f5;
+ background-image: none;
+ color: $brooklyn_green;
+ }
+ ul.nav li.dropdown:hover > ul.dropdown-menu {
+ display: block;
+ }
+}
+
+/* side menu */
+.side-menu {
+ font-family: Avenir, $fonts;
+ font-size: 14px;
+ font-weight: 400;
+ position: fixed;
+ h4.with_following {
+ margin-bottom: 0;
+ }
+ h4.with_preceding {
+ margin-top: 0;
+ }
+ h4.with_following a {
+ border-bottom-right-radius: 0 !important ;
+ border-bottom-left-radius: 0 !important ;
+ border-bottom: 0;
+ }
+ h4.with_preceding a {
+ border-top-right-radius: 0;
+ border-top-left-radius: 0;
+ border-top: 0;
+ }
+ a, a.breadcrumb.breadcrumb0 { padding-left: 15px; padding-top: 8px; padding-bottom: 6px; }
+ a.breadcrumb.breadcrumb1 { padding-left: 30px; }
+ a.breadcrumb.breadcrumb2 { padding-left: 45px; }
+ a.breadcrumb.breadcrumb3 { padding-left: 60px; }
+ /* further crumbs all get the same */
+ a.breadcrumb { padding-left: 70px; }
+
+ div.sub-item {
+ background-color: $bootstrap_theme_green_gradient_lower;
+ border-left: 1px solid $bootstrap_blue_border;
+ }
+ div.sub-item:last-child {
+ border-bottom: 1px solid $white_dd;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ }
+ div.sub-item:last-child a.sub-item:last-child {
+ border-bottom-right-radius: 4px !important;
+ }
+ a.with-sub-item {
+ /* border-bottom: 1px solid $white_dd; */
+ border-bottom: 0;
+ }
+ a.sub-item {
+ border-radius: 0 !important;
+ border-bottom: 0;
+ margin-left: 12px;
+ padding-left: 10px;
+ padding-top: 8px;
+ padding-bottom: 8px;
+ }
+ a.sub-item.list-group-item.active {
+ background-color: $white_f5;
+ // the below is needed to achieve the above, since bg-image is already set
+ background-image: -webkit-linear-gradient(top, $white_f5 0%, $white_f5 100%);
+ background-image: linear-gradient(to bottom, $white_f5 0%, $white_f5 100%);
+
+ border-color: $white_dd;
+ color: $text_color;
+ text-shadow: none;
+ // not sure why the bottom border is visible at all, and stays on hover, but vanishes on 'active';
+ // but this sorts it out (taking 1 away from padding)
+ margin-bottom: 0;
+ padding-bottom: 7px;
+ }
+ a.sub-item.list-group-item.active:hover {
+ color: $a_hover_color;
+ }
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_search.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_search.scss b/docs/style/css/_search.scss
new file mode 100644
index 0000000..21ef97f
--- /dev/null
+++ b/docs/style/css/_search.scss
@@ -0,0 +1,29 @@
+/* SEARCH
+ ----------------------------------------------------------------------- */
+
+div.search_right {
+ float: right;
+ @include transform('translateY(-12px)');
+ padding-right: 5%;
+ padding-bottom: 18px;
+ font-size: 75%;
+ .searchform {
+ width: 240px;
+ margin: 0;
+ padding: 5px 5px 0 0;
+ overflow: hidden;
+ text-align: right;
+ }
+ .searchinput {
+ width: 227px;
+ background: #ffffff;
+ border: 1px solid #b1b7c2;
+ -moz-border-radius: 2px;
+ border-radius: 2px;
+ color: #c8ccd5;
+ padding: 3px;
+ }
+ .searchinput:focus {
+ color: $blackish;
+ }
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_tooltips.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_tooltips.scss b/docs/style/css/_tooltips.scss
new file mode 100644
index 0000000..11dee6a
--- /dev/null
+++ b/docs/style/css/_tooltips.scss
@@ -0,0 +1,14 @@
+/* TOOLTIPS
+ ----------------------------------------------------------------------- */
+
+.tooltip .tooltip-inner {
+ color: $text_color;
+ background-color: $white_dd;
+ font-weight: 500;
+}
+.tooltip.top .tooltip-arrow {
+ border-top-color: $white_dd;
+}
+.tooltip.bottom .tooltip-arrow {
+ border-bottom-color: $white_dd;
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/_util.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_util.scss b/docs/style/css/_util.scss
new file mode 100644
index 0000000..b6d4b44
--- /dev/null
+++ b/docs/style/css/_util.scss
@@ -0,0 +1,27 @@
+/* GENERAL UTILS
+ ----------------------------------------------------------------------- */
+
+@mixin flex() {
+ display: -webkit-box; /* OLD - iOS 6-, Safari 3.1-6 */
+ display: -moz-box; /* OLD - Firefox 19- (buggy but mostly works) */
+ display: -ms-flexbox; /* TWEENER - IE 10 */
+ display: -webkit-flex; /* NEW - Chrome */
+ display: flex; /* NEW, Spec - Opera 12.1, Firefox 20+ */
+}
+
+@mixin transform($tfn) {
+ -webkit-transform: #{$tfn};
+ -moz-transform: #{$tfn};
+ -o-transform: #{$tfn};
+ transform: #{$tfn};
+}
+
+@mixin flip() {
+ filter: FlipH;
+ @include transform('scaleX(-1)');
+ -ms-filter: "FlipH";
+}
+
+.flip {
+ @include flip;
+}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/base.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/base.scss b/docs/style/css/base.scss
deleted file mode 100644
index 2f778ee..0000000
--- a/docs/style/css/base.scss
+++ /dev/null
@@ -1,793 +0,0 @@
----
----
-
-{% include base-scss.scss %}
-
-/* BASIC STYLES
- ----------------------------------------------------------------------- */
-body {
- margin: 0px;
- padding: 60px 0px 20px 0px;
- font-family: $fonts;
- font-weight: 300;
- font-size: 17px;
- background-color: white;
- color: $text_color;
-}
-h1, h2, h3, h4, h5, h6 { font-family: Avenir, $fonts; }
-input, select, textarea {}
-p, li, label, td, th,input, select, textarea {}
-p, input, label, li {}
-p { margin: 0.75em 0; line-height: 1.4em;}
-form {padding: 0; margin: 0;}
-img {border: 0;}
-
-a {color: $a_color;}
-a:hover {text-decoration: none; color: $a_hover_color;}
-
-/* Offset link anchors so they are not hidden by the header */
-a[id]:empty, a[name]:empty {
- padding-top: 60px;
- margin-top: -60px;
- display: block;
-}
-.dropdown-menu > li > a {
- font-weight: 300;
-}
-.btn-default, .btn-primary, .btn-success, .btn-info, .btn-warning, .btn-danger {
- text-shadow: none;
- font-weight: 300;
-}
-.btn-default {
- color: $gray_66;
-}
-.panel-heading {
- h4 {
- padding-bottom: 0px;
- margin-bottom: 0px;
- }
-}
-.panel-body {
- margin: 0px;
- font-size: 95%;
- color: $gray_66;
- padding: 15px;
- background-color: $white_fa;
- border-radius: 5px;
- p:first-child {
- margin-top: 0px;
- }
- p:last-child {
- margin-bottom: 0px;
- }
- > ul, > ol {
- margin-left: -1em;
- }
-}
-/* GENERAL UTILS
- ----------------------------------------------------------------------- */
-
-@mixin flex() {
- display: -webkit-box; /* OLD - iOS 6-, Safari 3.1-6 */
- display: -moz-box; /* OLD - Firefox 19- (buggy but mostly works) */
- display: -ms-flexbox; /* TWEENER - IE 10 */
- display: -webkit-flex; /* NEW - Chrome */
- display: flex; /* NEW, Spec - Opera 12.1, Firefox 20+ */
-}
-
-@mixin transform($tfn) {
- -webkit-transform: #{$tfn};
- -moz-transform: #{$tfn};
- -o-transform: #{$tfn};
- transform: #{$tfn};
-}
-
-@mixin flip() {
- filter: FlipH;
- @include transform('scaleX(-1)');
- -ms-filter: "FlipH";
-}
-
-.flip {
- @include flip;
-}
-
-/* CUSTOM HEADINGS
- ----------------------------------------------------------------------- */
-
-/* this causes jumps to anchors to show the anchor below the navbar */
-#content_container { h1, h2, h3, h4, h5, h6 {
- margin-top: -64px;
- padding-top: 64px;
-}}
-
-#content_container h1 {
- max-width: 95%;
- font-variant: normal;
- margin-top: -16px;
- padding-bottom: 6px;
- margin-bottom: 24px;
- border-bottom: 1px dotted $gray_aa;
- font-weight: 300;
- font-size: 36px;
- text-transform: uppercase;
-}
-
-/* headings get a tooltip showing the permalink URL, a la github jekyll */
-/* install subset of font-awesome */
-@font-face {
- font-family: 'FontAwesome';
- src: url('{{ site.path.style }}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.eot');
- src: url('{{ site.path.style }}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.eot?#iefix&v=4.2.0') format('embedded-opentype'), url('{{ site.path.style }}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.woff?v=4.2.0') format('woff'), url('{{ site.path.style }}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.ttf?v=4.2.0') format('truetype'), url('{{ site.path.style }}/deps/font-awesome-4.2.0/fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular') format('svg');
- font-weight: normal;
- font-style: normal;
-}
-.fa {
- display: inline-block;
- font-family: FontAwesome;
- font-style: normal;
- font-weight: normal;
- line-height: 1;
- -webkit-font-smoothing: antialiased;
- -moz-osx-font-smoothing: grayscale;
-}
-.fa-link:before {
- content: "\f0c1";
-}
-.fa-play-circle-o:before {
- content: "\f01d";
-}
-/*
- * This code is courtesy Ben Balter, modified by Parker Moore for jekyllrb.com
- * http://ben.balter.com/2014/03/13/pages-anchor-links/
- */
-.header-link {
- position: relative;
- left: 0.5em;
- opacity: 0;
- font-size: 0.8em;
-
-/* not using -- but this is cool!
- -webkit-transition: opacity 0.2s ease-in-out 0.1s;
- -moz-transition: opacity 0.2s ease-in-out 0.1s;
- -ms-transition: opacity 0.2s ease-in-out 0.1s;
-*/
-}
-h2:hover .header-link,
-h3:hover .header-link,
-h4:hover .header-link,
-h5:hover .header-link,
-h6:hover .header-link {
- opacity: 1;
-}
-a.header-literal-anchor { display: inline !important; }
-
-/* TOOLTIPS
- ----------------------------------------------------------------------- */
-
-.tooltip .tooltip-inner {
- color: $text_color;
- background-color: $white_dd;
- font-weight: 500;
-}
-.tooltip.top .tooltip-arrow {
- border-top-color: $white_dd;
-}
-.tooltip.bottom .tooltip-arrow {
- border-bottom-color: $white_dd;
-}
-
-/* WEBSITE MENUS
- ----------------------------------------------------------------------- */
-
-/* top menu bar */
-.navbar-brand {
- margin-top: -4px;
- margin-left: -30px !important;
-}
-
-@mixin icon($name) {
- .icon-#{$name} {
- width: 32px;
- height: 32px;
- background: url('{{ site.path.style }}/img/'+$name+'-256-black.png');
- background-size: 32px 32px;
- }
- .icon-#{$name}:hover {
- background: url('{{ site.path.style }}/img/'+$name+'-256-green.png');
- background-size: 32px 32px;
- }
-}
-
-.navbar {
- @include icon('github');
- @include icon('twitter');
- @include icon('irc');
-}
-
-.navbar .tooltip .tooltip-inner {
- position: relative;
- right: 40%;
- // include calc for those browsers which support it
- right: calc(50% - 25px);
- max-width: 300px;
-}
-
-/* special container with sidebar where if sidebar is squeezed
- (under "responsiveness") the text keeps at least its "auto" size,
- squashing the main container instead */
-.container-and-sidebars {
- width: 100%;
- @include flex();
-}
-.container-between-sidebars {
- -webkit-box-flex: 1 100%;
- -webkit-flex: 1 100%;
- -webkit-flex-flex: 1 100%;
- flex: 1 100%;
- flex: 10 1 100%;
- display: inline-block;
- width: auto;
- margin-left: auto;
- margin-right: auto;
-}
-.container-sidebar {
- -webkit-box-flex: 0 auto;
- -webkit-flex: 0 auto;
- -webkit-flex-flex: 0 auto;
- flex: 0 auto;
- flex: 0 0 auto;
-}
-.container-sidebar-right {
- @extend .container-sidebar;
- text-align: left;
- padding-right: 10px;
-}
-.container-sidebar-left {
- @extend .container-sidebar;
- text-align: right;
- padding-left: 10px;
-}
-
-@media (min-width: 768px) {
- .container-sidebar { min-width: calc((100% - 750px)/2); }
-}
-@media (min-width: 992px) {
- .container-sidebar { min-width: calc((100% - 970px)/2); }
-}
-@media (min-width: 1200px) {
- .container-sidebar { min-width: calc((100% - 1170px)/2); }
-}
-
-
-.navbar-feather {
- padding-top: 12px;
- margin-right: -6px;
-}
-.navbar-sidebar-right-icons {
- padding-top: 10px;
- margin-left: -6px;
- white-space: nowrap;
- a {
- display: inline-block;
- width: 32px;
- height: 32px;
- }
-}
-.navbar-icon-shift { margin-right: -2px; }
-
-.navbar div.dropdown_section_header hr {
- margin: 4px 12px;
- border-color: $white_dd;
-}
-
-.navbar div.dropdown_new_section hr {
- margin: 6px 0px;
- border-color: $white_dd;
-}
-
-/* pop-up top-menu */
-.navbar-default .navbar-nav > li > a:hover,
-.navbar-default .navbar-nav > li > a:focus,
-.navbar-default .navbar-nav > .active > a:hover,
-.navbar-default .navbar-nav > .active > a:focus {
- background-color: $white_f5;
- color: $brooklyn_green;
-}
-.top-menu {
- font-size: 14px;
- font-weight: 400;
- .dropdown-menu > li > a:hover, .dropdown-menu > li > a:focus {
- background-color: $white_f5;
- background-image: none;
- color: $brooklyn_green;
- }
- ul.nav li.dropdown:hover > ul.dropdown-menu {
- display: block;
- }
-}
-
-/* side menu */
-.side-menu {
- font-family: Avenir, $fonts;
- font-size: 14px;
- font-weight: 400;
- position: fixed;
- h4.with_following {
- margin-bottom: 0;
- }
- h4.with_preceding {
- margin-top: 0;
- }
- h4.with_following a {
- border-bottom-right-radius: 0 !important ;
- border-bottom-left-radius: 0 !important ;
- border-bottom: 0;
- }
- h4.with_preceding a {
- border-top-right-radius: 0;
- border-top-left-radius: 0;
- border-top: 0;
- }
- a, a.breadcrumb.breadcrumb0 { padding-left: 15px; padding-top: 8px; padding-bottom: 6px; }
- a.breadcrumb.breadcrumb1 { padding-left: 30px; }
- a.breadcrumb.breadcrumb2 { padding-left: 45px; }
- a.breadcrumb.breadcrumb3 { padding-left: 60px; }
- /* further crumbs all get the same */
- a.breadcrumb { padding-left: 70px; }
-
- div.sub-item {
- background-color: $bootstrap_theme_green_gradient_lower;
- border-left: 1px solid $bootstrap_blue_border;
- }
- div.sub-item:last-child {
- border-bottom: 1px solid $white_dd;
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- }
- div.sub-item:last-child a.sub-item:last-child {
- border-bottom-right-radius: 4px !important;
- }
- a.with-sub-item {
- /* border-bottom: 1px solid $white_dd; */
- border-bottom: 0;
- }
- a.sub-item {
- border-radius: 0 !important;
- border-bottom: 0;
- margin-left: 12px;
- padding-left: 10px;
- padding-top: 8px;
- padding-bottom: 8px;
- }
- a.sub-item.list-group-item.active {
- background-color: $white_f5;
- // the below is needed to achieve the above, since bg-image is already set
- background-image: -webkit-linear-gradient(top, $white_f5 0%, $white_f5 100%);
- background-image: linear-gradient(to bottom, $white_f5 0%, $white_f5 100%);
-
- border-color: $white_dd;
- color: $text_color;
- text-shadow: none;
- // not sure why the bottom border is visible at all, and stays on hover, but vanishes on 'active';
- // but this sorts it out (taking 1 away from padding)
- margin-bottom: 0;
- padding-bottom: 7px;
- }
- a.sub-item.list-group-item.active:hover {
- color: $a_hover_color;
- }
-}
-
-
-/* FOOTER
- ----------------------------------------------------------------------- */
-
-/* sticky footer */
-html {
- position: relative;
- min-height: 100%;
-}
-
-@media (min-width: 1200px) {
- .slightlyNarrowContainer {
- width: 970px;
- }
-}
-
-div#footer {
- position: absolute;
- bottom: 0;
- width: 100%;
- padding-top: 1em;
- padding-bottom: 1em;
- background-color: $white_f5;
- text-align: center;
- font-size: 80%;
-}
-.octicon-footer {
- color: $footer_icon_gray;
- font-size: 130%;
- position: relative;
- top: 2px;
- padding-left: 6px;
-}
-a:hover .octicon-footer {
- color: $brooklyn_green;
-}
-
-
-/* CODE RENDERING
- ----------------------------------------------------------------------- */
-@mixin nowrap() {
- white-space: pre;
- word-wrap: normal;
- overflow-y: scroll;
-}
-
-@mixin code() {
- font-family: Consolas, Lucida Console, Monaco, monospace;
- @include nowrap();
- font-size: 14px;
- /* override color and bg-color on 'code' from bootstrap, and a touch more padding on top since font-size is smaller */
- color: $text_color;
- background-color: $code_bg_color;
-}
-
-@mixin pre() {
- @include code();
- padding: 0.4em 0.8em;
- overflow-x: scroll;
- /* override border and line-height on 'pre' from bootstrap */
- border: none;
- border-radius: 2px;
- line-height: 1.4;
- font-size: 13px;
-}
-
-pre {
- @include pre();
- code {
- /* override settings on 'pre code' from bootstrap */
- @include pre();
- line-height: 1;
- /** and no padding since pre already has some */
- padding: 0px;
- }
-}
-code {
- @include code();
- padding: 4px 4px 2px 4px;
- border-radius: 3px;
-}
-
-.nowrap { @include nowrap(); }
-
-.highlight { background-color:$code_bg_color; } /* clipboard icon should have the same background color as the code */
-
-.highlight .clipboard_button { display: none; }
-.highlight:hover .clipboard_button { display: inherit; }
-.clipboard_button.zeroclipboard-is-hover { display: inherit; }
-
-.clipboard_container { float: right; padding: 8px; }
-.clipboard_button:before {
- // fa-copy
- content: "\f0c5";
-}
-.clipboard_button {
- font-size: 18px;
- color: $vibrant_fg_green;
- @include transform('translateY(-2px)');
-}
-.clipboard_button:hover, .clipboard_button.zeroclipboard-is-hover {
- color: $a_hover_color;
- cursor: pointer; cursor: hand;
-}
-.clipboard_button.zeroclipboard-is-active .on-active {
- display: inherit;
-}
-.clipboard_button .on-active {
- // z-index often doesn't help here (diff stacking context to the side menu)... but it shouldn't hurt!
- z-index: 10;
- font-family: $fonts;
- display: none;
- margin-top: -20px;
- height: 0;
- width: 0;
- overflow-x: visible;
- overflow-y: visible;
- position: relative;
- top: -30px;
-}
-.clipboard_button .on-active > div {
- background-color: $white_dd;
- border: 1px solid $gray_aa;
- font-size: 75%;
- font-weight: normal;
- left: -50%;
- color: $blackish;
- width: auto;
- display: inline-block;
- @include nowrap();
- padding: 3px 7px;
- @include transform('translateX(-50%)');
-}
-
-
-/* SEARCH
- ----------------------------------------------------------------------- */
-
-div.search_right {
- float: right;
- @include transform('translateY(-12px)');
- padding-right: 5%;
- padding-bottom: 18px;
- font-size: 75%;
- .searchform {
- width: 240px;
- margin: 0;
- padding: 5px 5px 0 0;
- overflow: hidden;
- text-align: right;
- }
- .searchinput {
- width: 227px;
- background: #ffffff;
- border: 1px solid #b1b7c2;
- -moz-border-radius: 2px;
- border-radius: 2px;
- color: #c8ccd5;
- padding: 3px;
- }
- .searchinput:focus {
- color: $blackish;
- }
-}
-
-
-/* ARCHIVE PAGE WARNING
- ----------------------------------------------------------------------- */
-
-#page_notes {
- display: none;
- background-color: #4D9D3A;
- border: 3px solid orange;
- -moz-border-radius: 8px;
- border-radius: 8px;
- padding: 0.3em;
- padding-left: 0.75em;
- margin-top: 24px;
- margin-bottom: -24px;
-
- div.warning {
- background-color: #F8CB9C;
- border: 1px solid #FFAB7C;
- padding-left: 0.75em;
- -moz-border-radius: 8px;
- border-radius: 8px;
- }
- .warning_banner_image img {
- width: 64px; padding-top: 8px; padding-right: 12px;
- float: left;
- }
- p { line-height: 100%; color: white; }
- p.warning_banner_buttons {padding-right: 24px; }
- p.warning_banner_buttons a, #page_notes p.warning_banner_buttons a:visited {
- color: orange; font-weight: bold; padding-right: 1em; text-decoration: none; }
- p.warning_banner_buttons a:hover { color: #FFC31E; font-weight: bold; }
-}
-
-
-/* LANDING PAGE
- ----------------------------------------------------------------------- */
-
-.jumbotron {
- margin-top: 18px;
-}
-
-#apachebrooklynbanner {
- background-image: url("../img/apache-brooklyn-logo-817px-wide.png");
- background-repeat: no-repeat;
- background-position: center;
- width: 817px;
- height: 99px;
- margin-bottom: 50px;
-}
-
-div.feather.landing {
- overflow: visible;
- max-height: 10px;
- img {
- width: 200px;
- margin-left: 40px;
- margin-top: 0px;
- }
-}
-
-
-/* MAIN CONTAINER
- ----------------------------------------------------------------------- */
-
-#content_container {
- padding-bottom: 48px;
- img {
- max-width: 100%;
- }
-}
-
-
-/* YAML EXPLAINED
- ----------------------------------------------------------------------- */
-
-$explained_code_bg_color: $gray_66;
-$explained_code_fg_color: $white_dd;
-$explained_code_highlight_bg_color: $vibrant_bg_green;
-$explained_code_highlight_fg_color: $white_fa;
-$explained_text_highlight_fg_color: $text_color;
-$explained_text_highlight_bg_color: $white_fa;
-
-$code_width: 57%;
-$annotation_width: 41%;
-
-div.annotated_blueprint {
- margin-top: 60px;
- div.code_scroller {
- background-color: $code_bg_color;
- border: 0.4em solid $explained_code_bg_color;
- border-left: 0;
- border-right: 0;
- border-radius: 3px;
- width: $code_width;
- margin-right: 0px;
- margin-left: auto;
- background-color: $explained_code_bg_color;
- color: $explained_code_fg_color;
- overflow-x: scroll;
- div {
- overflow-x: visible !important;
- overflow-y: visible !important;
- }
- div.code_viewer {
- width: auto;
- height: 100%;
- div.block {
- @include flex();
- -webkit-align-items: center;
- align-items: center;
- z-index: -10;
- }
- div.block > div:last-child {
- @include pre();
- border: 0;
- border-radius: 0;
- padding: 0px 0.6em;
- background-color: $explained_code_bg_color;
- color: $explained_code_fg_color;
- min-width: 100%;
- margin-top: 3px;
- margin-bottom: 3px;
- }
- div.block > div.annotations_wrapper1 {
- font-family: $fonts;
- div.annotations_wrapper2 {
- // seems we have to use abs positioning because other techniques
- // (translation, negative margins, etc) don't show up outside the scroll-x
- position: absolute;
- @include transform('translateX(-100%) translateY(-50%)');
- width: $annotation_width;
-
- @include flex();
- -webkit-align-items: center;
- align-items: center;
- div.annotations {
- // positioning and sizing
- height: auto;
- width: 100%;
- padding: 8px 8px;
- color: $explained_text_highlight_fg_color;
-
- div.short {
- font-size: 125%;
- text-align: right;
- }
- div.long {
- display: none;
-
- font-size: 85%;
- p { margin: 8px 0 8px 0; }
- p:first-child { margin-top: 0; }
- p:last-child { margin-bottom: 0; }
- }
- }
- div.connector {
- height: 7px;
- width: 24px;
- }
- }
- }
- div.block:hover > div:last-child {
- background-color: $explained_code_highlight_bg_color;
- color: $explained_code_highlight_fg_color;
- // TODO the bg color doesn't apply to regions which are only visible after a scroll-right :(
- // to fix this i think we can us JS to set width of div.block to the width of this, the code last-child
- }
- div.block:hover {
- z-index: 30 !important;
- div.annotations_wrapper1 {
- z-index: 30 !important;
- }
- div.annotations {
- background-color: $explained_text_highlight_bg_color;
- border: 4px solid $explained_code_highlight_bg_color;
- border-radius: 8px;
- text-align: center;
- div.short {
- font-size: 100% !important;
- text-align: center !important;
- color: $text_color;
- margin-bottom: 8px;
- font-weight: bold;
- z-index: 10;
- }
- div.long { display: inherit !important; }
- }
- div.connector {
- background-color: $explained_code_highlight_bg_color;
- }
- }
- // highlighting of key code segments
- div.block > div:last-child .ann_highlight {
- font-weight: bold;
- color: #e8f0e0;
- }
- div.block:hover > div:last-child .ann_highlight {
- color: #f8fff8;
- }
- }
- }
- div.code_viewer:hover {
- div.annotations div.short {
- color: $gray_aa;
- }
- }
-
- // have an initial notice
- div.code_scroller {
- div.initial_notice {
- height: 0;
- width: 0;
- overflow-x: visible;
- overflow-y: visible;
- }
- div.initial_notice > div {
- z-index: 10;
- background-color: transparentize($gray_aa, 0.1);
- position: relative;
- width: 0;
- height: 0;
- @include flex();
- -webkit-align-items: top;
- align-items: top;
- }
- div.initial_notice > div > div {
- padding-top: 24px;
- font-size: 125%;
- font-weight: bold;
- text-align: center;
- width: 100%;
- .ann_light {
- padding-top: 12px;
- font-weight: 300;
- }
- .ann_play {
- display: block;
- padding-top: 24px;
- padding-bottom: 24px;
- font-size: 600%;
- }
- }
- }
- div.code_scroller:hover div.initial_notice {
- display: none;
- }
-}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/guide-toc.css
----------------------------------------------------------------------
diff --git a/docs/style/css/guide-toc.css b/docs/style/css/guide-toc.css
deleted file mode 100644
index be38a11..0000000
--- a/docs/style/css/guide-toc.css
+++ /dev/null
@@ -1,88 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. 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
- *
- * 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.
-*/
-
-
-#sidebar_toc { padding-top: 6px; }
-#sidebar_toc a { text-decoration: none; }
-
-#sidebar_toc div.toc-1 { padding: 8px; margin: 4px 0px 0px 0px; }
-#sidebar_toc div.toc-1-item {text-transform: uppercase; font-size: 12px; color: #111111; margin: 15px 0 5px 0;}
-#sidebar_toc div.toc-1-item.toc-1-header { margin: 0px 0px 2px 0px; }
-#sidebar_toc div.toc-1-item:hover { color: #003800; }
-
-#sidebar_toc div.toc-2-item { color: #282; padding-top: 3px; }
-#sidebar_toc div.toc-2-item:hover { color: #010; }
-
-#sidebar_toc div.toc-1.toc-active { background: #C6D0D8; border-radius: 5px; }
-#sidebar_toc div.toc-1.toc-active div.toc-1-item { color: #222; }
-#sidebar_toc div.toc-2.toc-active div.toc-2-item { font-weight: bold; }
-#sidebar_toc div.toc-3.toc-active div.toc-3-item { font-weight: bold; }
-
-/* level 3 menu is displayed in the list, indented, if parent is active */
-#sidebar_toc div.toc-2.toc-active div.toc-2-children { margin: 2px 0px 3px 0px; }
-#sidebar_toc div.toc-2.toc-active div.toc-3-item {
- padding: 1px 0px 1px 12px;
-}
-#sidebar_toc div.toc-2.toc-active div.toc-3-item:hover { color: #060; }
-
-/* otherwise level 3 menu is popup */
-#sidebar_toc div.toc-2:not(.toc-active) div.toc-3-item { color: #262; background: #C6D0D8;
- text-align: right; padding: 2px 6px 2px 6px;
- border-width: 1px; border-style: solid; border-radius: 0px; border-color: #464;
-}
-#sidebar_toc div.toc-2:not(.toc-active) div.toc-3-item:hover { color: #030; border-color: #353; background: #e8eded; }
-
-#sidebar_toc div.toc-2:not(.toc-active) div.toc-2-children-popup {
- display: none;
-}
-#sidebar_toc div.toc-2:not(.toc-active):hover div.toc-2-children-popup {
- display: block;
- position: relative;
- height: 0px;
-/* right: -180px; to make appear at right */
- left: -158px;
- width: 180px;
- top: -17px;
-}
-#sidebar_toc div.toc-2:not(.toc-active) div.toc-2-children {
- display: block;
- width: 160px;
- padding: 0px 10px 0px 10px;
-}
-
-/* old
-.ui-accordion { font-size: 90% }
-.ui-accordion .left-menu-body {
- padding: 0;
- overflow:hidden;
-}
-.ui-accordion .toc1 { margin: 14px 0px 0px 0px; }
-
-#sidebar_toc .toc1 { background: #f8f8f8; }
-#sidebar_toc .toc2 { background: #f0f0f0; }
-#sidebar_toc .toc3 { background: #e8e8e8; padding: 0px 0px 0px 20px; }
-
-#sidebar_toc .ui-accordion-header-active { background: #d8d8d8; }
-
-#sidebar_toc .toc-active { background: #68aa70; }
-#sidebar_toc .toc-active a { color: #103010; }
-
-#sidebar_toc .ui-state-hover { background: #c8d0c8; }
-*/
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/guide.css
----------------------------------------------------------------------
diff --git a/docs/style/css/guide.css b/docs/style/css/guide.css
deleted file mode 100644
index 6cfa2d0..0000000
--- a/docs/style/css/guide.css
+++ /dev/null
@@ -1,119 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. 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
- *
- * 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.
-*/
-/*
-Brooklyn minisite
-*/
-
-/*ACCESSIBILITY*/
-#shortcuts {display: block; position: absolute; top: -100px; z-index: 0}
-#shortcuts a {padding: 0 0.5em; left: 0; z-index: 0}
-#shortcuts a:focus, #shortcuts a:active {display: inline; z-index: 2; background-color: #ffff00; color: #000000; text-decoration: none; position: absolute; top: 100px;}
-
-/* STRUCTURE */
-#container {width: 980px; padding: 0; margin: 0 auto;}
-#contentcontainer {clear: both; width: 980px; overflow: hidden;}
-#maincontent {width: 710px; float: left; padding: 10px 0px 25px 10px; background-color: #ffffff;}
-#sidebar {width: 155px; float: right; background: #ffffff url(../img/bridge.png) no-repeat 0 12px; padding: 112px 5px 20px 0;}
-
-/* HEADER */
-#header {padding: 0;}
-#identity {float: left; margin: 0; padding: 30px 0 15px 10px;}
-#identity a {text-decoration: none; display: block; margin: 0; color: #4d9d3a; font-size: 2.5em; padding: 0; background: transparent url(../img/brooklyn.gif) no-repeat 0 0; width: 206px; height: 44px; text-indent: -1000px; overflow: hidden;}
-.searchform {float: right; width: 160px; margin: 0; padding: 5px 5px 0 0; overflow: hidden; text-align: right;}
-.searchinput {
- width: 147px;
- padding: 3px;
- color: #c8ccd5;
- background: #ffffff;
- border: 1px solid #b1b7c2;
- -moz-border-radius: 5px; border-radius: 5px;
- font: -webkit-small-control;
-}
-.searchinput:focus {color: #333333;}
-
-/*MENUS*/
-#header #quicklinks {float: right; list-style: none; margin: 0; padding: 0 10px 0 0;}
-#header #quicklinks li {margin: 0; padding: 0 5px 0 7px; text-transform: uppercase; font-size: 10px; float: left; background: #ffffff url(../img/divider-quicklinks.gif) no-repeat left center;}
-#header #quicklinks li:first-child {background-image: none;}
-#header #quicklinks a {text-decoration: none; color: #4f8243;}
-#menubar {clear: both; width: 978px; height: 36px; background-color: #e8eded; border: 1px solid #d5dade; -moz-border-radius: 8px; border-radius: 8px;}
-#mainmenu {list-style: none; margin: 0; padding: 4px 0 0 2px; width: 765px; display: block; float: left; font-size: 15px;}
-#mainmenu li {float: left; position: relative; margin: 0; padding: 0; }
-#mainmenu>li {border: 1px solid transparent; border-top-left-radius: 5px; -moz-border-radius-topleft: 5px; border-top-right-radius: 5px; -moz-border-radius-topright: 5px; border-bottom: 0;}
-#mainmenu a {display: block; text-decoration: none; color: #508243;}
-#mainmenu>li>a {padding: 0 8px 5px 8px; line-height: 25px;}
-#mainmenu>li:hover {background-color: #ffffff; border: 1px solid #dbe0e4; border-bottom: 0;}
-#mainmenu .current a {color: #838a8b;}
-#mainmenu ul {display: none; position: absolute; top: 30px; left: -1px; float: left; background-color: #f5f5f5; border: 1px solid #dbe0e4; border-top: 0; list-style: none; margin: 0; padding: 5px; width: 185px;}
-#mainmenu ul ul {left: 100%; margin-left: 6px; top: -1px; border-top: 1px solid #dbe0e4;}
-#mainmenu ul li {width: 183px; padding: 0; border: 1px solid transparent;}
-#mainmenu ul li:hover {border: 1px solid #dbe0e4; background-color: #ffffff;}
-#mainmenu ul a {font-size: 14px; padding: 7px;}
-#mainmenu li:hover > ul, #mainmenu li.sfHover > ul {display: block;}
-
-/* MAIN CONTENT */
-#breadcrumb {font-size: 12px; margin: 0 0 2em 0; color: #636363;}
-#breadcrumb a {color: #636363; text-decoration: none;}
-#breadcrumb a:hover {color: #636363; text-decoration: underline;}
-#breadcrumb span {color: #9e9e9e;}
-#maincontent ul {margin: 0.75em 0; padding: 0 0 0 25px;}
-#maincontent li {line-height: 1.5em; margin: 0 0 0.25em 0; padding: 0;}
-table {width: 100%; border: 1px solid #dbe0e4; border-bottom-left-radius: 10px; -moz-border-radius-bottomleft: 10px; border-bottom-right-radius: 10px; -moz-border-radius-bottomright: 10px;}
-th, td {text-align: center; padding: 5px;}
-th {background-color: #f2f3f5; font-weight: bold; color: #121212; border-right: 1px solid #dbe0e4;}
-td {border-top: 1px solid #dbe0e4; border-right: 1px solid #dbe0e4; padding: 5px;}
-th:last-child, td:last-child {border-right: 0;}
-
-/* PAGE ELEMENTS */
-div.warning{
- background-color: #F8CB9C;
- border: 1px solid #FFAB7C;
- padding-left: 0.75em;
- -moz-border-radius: 8px;
- border-radius: 8px;
-}
-#page_notes{
- display: none;
- background-color: #4D9D3A;
- border: 3px solid orange;
- -moz-border-radius: 8px;
- border-radius: 8px;
- padding: 0.3em;
- padding-left: 0.75em;
- margin-top: -0.5em;
- margin-bottom: 1em;
-}
-#page_notes .warning_banner_image img {
- width: 64px; padding-top: 8px; padding-right: 12px;
- float: left;
-}
-#page_notes p { line-height: 100%; color: white; }
-#page_notes p.warning_banner_buttons {padding-right: 24px; }
-#page_notes p.warning_banner_buttons a, #page_notes p.warning_banner_buttons a:visited {
- color: orange; font-weight: bold; padding-right: 1em; text-decoration: none; }
-#page_notes p.warning_banner_buttons a:hover { color: #FFC31E; font-weight: bold; }
-
-
-/* SIDEBAR */
-#sidebar {font-size: 13px;}
-#sidebar h2 {text-transform: uppercase; font-size: 12px; color: #111111; margin: 15px 0 5px 0;}
-#sidebar ul {list-style: none; margin: 0; padding: 0;}
-#sidebar li {margin: 0 0 5px; padding: 0;}
-#sidebar li a {text-decoration: none;}
-#sidebar li a:hover {text-decoration: underline;}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/javadoc.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/javadoc.scss b/docs/style/css/javadoc.scss
new file mode 100644
index 0000000..204c8a9
--- /dev/null
+++ b/docs/style/css/javadoc.scss
@@ -0,0 +1,119 @@
+---
+---
+
+{% include base-scss.scss %}
+
+@import 'util';
+@import 'basic';
+@import 'tooltips';
+@import 'code_blocks';
+
+body {
+ padding: 0;
+ font-size: 100%;
+}
+
+.title { color: $blackish; }
+
+a, a:link, a:visited { color: $a_color; }
+a:hover, a:link:hover, a:visited:hover { color: $a_hover_color; }
+
+.indexContainer, td {
+ a, a:link, a:visited { color: darken($a_color, 20%); }
+}
+
+
+.topNav, .bottomNav, .bar {
+ background-image: -webkit-linear-gradient(top, darken($bootstrap_theme_green_gradient_upper, 10%) 0%, darken($bootstrap_theme_green_gradient_lower, 10%) 100%);
+ background-image: linear-gradient(to bottom, darken($bootstrap_theme_green_gradient_upper, 10%) 0%, darken($bootstrap_theme_green_gradient_lower, 10%) 100%);
+ a:hover, a:link:hover, a:visited:hover { color: lighten($a_hover_color, 10%); }
+}
+
+.topNav {
+ height: inherit;
+ padding-bottom: 6px;
+}
+.topNav .aboutLanguage .brooklyn-header {
+ font-family: $header_fonts;
+ font-weight: bold;
+ font-size: 140%;
+ img { margin-top: 8px; }
+}
+.bar .brooklyn-header .img {
+ display: none;
+}
+.brooklyn-header .img {
+ background-image: url('feather.png');
+ background-size: contain;
+ width: 50px;
+ height: 15px;
+ margin-left: 8px;
+ margin-top: 8px;
+ display: inline-block;
+}
+
+.bottomNav .aboutLanguage {
+ margin-top: 0;
+}
+
+.subNav div {
+ padding: 0;
+}
+
+// sub-nav items seem to need extra indent
+ul.subNavList li:first-child {
+ padding-left: 6px;
+}
+ul.subNavList li {
+ padding-top: 1px;
+ padding-bottom: 1px;
+}
+
+// there is so much code we don't want special treatment for it
+code {
+ font-size: 100%;
+ background-color: inherit;
+ padding: 0;
+ word-wrap: normal;
+ whitespace: inherit;
+}
+
+// tabs
+.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span {
+ padding-top: 5px;
+ padding-bottom: 3px;
+}
+.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd {
+ width: 0;
+}
+
+// package
+.subTitle {
+ margin-bottom: -6px;
+ font-family: $header_fonts;
+ font-weight: normal;
+ font-style: italic;
+ font-size: 125%;
+}
+.subTitle .block {
+ margin-top: 6px;
+ margin-bottom: 24px;
+ font-style: normal;
+
+ p {
+ font-family: $fonts;
+ font-style: normal;
+ font-weight: 300;
+ font-size: 90%;
+ }
+}
+.footer .subTitle .block {
+ margin-top: 18px;
+ font-weight: bold;
+ p {
+ font-weight: 300;
+ }
+}
+.header .subTitle .block {
+ font-weight: 300;
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/310c4148/docs/style/css/website.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/website.scss b/docs/style/css/website.scss
new file mode 100644
index 0000000..e855ec6
--- /dev/null
+++ b/docs/style/css/website.scss
@@ -0,0 +1,19 @@
+---
+---
+
+{% include base-scss.scss %}
+
+$style_dir: {{ site.path.style }};
+
+@import 'util';
+@import 'basic';
+@import 'tooltips';
+@import 'code_blocks';
+@import 'menu';
+@import 'search';
+@import 'footer';
+@import 'main_container';
+
+@import 'archive_warning';
+@import 'landing';
+@import 'blueprint_tour';
[09/13] incubator-brooklyn git commit: lots more tidy-up of docs,
esp in ops
Posted by he...@apache.org.
lots more tidy-up of docs, esp in ops
also removing the negative margin / extra padding above headers in favour of an auto-scroll technique to position window appropriately (not blocked by menu bar)
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/3add5d21
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/3add5d21
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/3add5d21
Branch: refs/heads/master
Commit: 3add5d210092e71c0f35313709aba45e226bb958
Parents: a24f148
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Jan 20 03:18:50 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Jan 20 04:26:17 2015 +0000
----------------------------------------------------------------------
.../DownloadProducerFromProperties.java | 2 +-
.../management/entitlement/Entitlements.java | 1 +
docs/README.md | 5 +
docs/_build/build.sh | 10 +-
docs/_includes/java_link.html | 6 +-
docs/_includes/sidemenu.html | 6 +-
docs/_includes/topmenu.html | 5 +-
docs/_plugins/brooklyn_metadata.rb | 3 +
docs/guide/dev/env/index.md | 2 +-
docs/guide/dev/index.md | 6 +
.../guide/dev/tips/debugging-remote-brooklyn.md | 46 ++-
docs/guide/java/common-usage.md | 100 +++++-
docs/guide/ops/brooklyn_properties.md | 173 ++++++++++
docs/guide/ops/cli.md | 143 ++++++++
docs/guide/ops/index.md | 5 +-
docs/guide/ops/launching/index.md | 143 --------
docs/guide/ops/locations/index.md | 6 +-
docs/guide/ops/locations/more-locations.md | 2 +-
docs/guide/ops/locations/ssh-keys.md | 37 ++-
docs/guide/ops/logging.md | 46 +++
docs/guide/ops/runtime-management/index.md | 325 -------------------
.../webconsole-dashboard-w400.png | Bin 137463 -> 0 bytes
.../runtime-management/webconsole-dashboard.png | Bin 214723 -> 0 bytes
.../webconsole-detail-w400.png | Bin 111993 -> 0 bytes
.../runtime-management/webconsole-detail.png | Bin 165359 -> 0 bytes
docs/guide/start/_my-web-cluster.yaml | 8 +-
docs/guide/start/blueprints.md | 70 ++--
docs/guide/start/config.md | 52 ---
docs/guide/start/index.md | 1 -
docs/guide/start/managing.md | 26 +-
docs/guide/start/running.md | 70 +---
.../yaml/chef/advanced-chef-integration.md | 4 +-
docs/guide/yaml/configuring-vms.md | 2 +-
docs/guide/yaml/creating-yaml.md | 2 +-
docs/guide/yaml/multiple-services.md | 39 ++-
docs/guide/yaml/mutlitple-services.md | 100 ------
docs/guide/yaml/setting-locations.md | 17 +-
docs/style/css/_basic.scss | 6 -
docs/style/css/_main_container.scss | 18 +-
docs/website/community/index.md | 2 +-
docs/website/developers/index.md | 2 +-
docs/website/documentation/index.md | 11 +-
docs/website/documentation/install-on-server.md | 17 +-
docs/website/documentation/passwordless-ssh.md | 29 --
docs/website/documentation/ssh-key.md | 9 -
docs/website/documentation/todo.md | 7 -
docs/website/learnmore/blueprint-tour.md | 2 +-
docs/website/learnmore/theory.md | 3 +-
48 files changed, 720 insertions(+), 849 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/core/src/main/java/brooklyn/entity/drivers/downloads/DownloadProducerFromProperties.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/entity/drivers/downloads/DownloadProducerFromProperties.java b/core/src/main/java/brooklyn/entity/drivers/downloads/DownloadProducerFromProperties.java
index 16de798..55696a4 100644
--- a/core/src/main/java/brooklyn/entity/drivers/downloads/DownloadProducerFromProperties.java
+++ b/core/src/main/java/brooklyn/entity/drivers/downloads/DownloadProducerFromProperties.java
@@ -90,7 +90,7 @@ import com.google.common.collect.Maps;
*
* A URL can be a "template", where things of the form ${version} will be substituted for the value
* of "version" provided for that entity. The freemarker template engine is used to convert URLs
- * (see <a href="http://freemarker.org>http://freemarker.org</a>). For example, one could use the URL:
+ * (see <a href="http://freemarker.org">http://freemarker.org</a>). For example, one could use the URL:
* <pre>
* {@code
* http://repo.acme.com/${simpletype}-${version}.${fileSuffix!tar.gz}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/core/src/main/java/brooklyn/management/entitlement/Entitlements.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/brooklyn/management/entitlement/Entitlements.java b/core/src/main/java/brooklyn/management/entitlement/Entitlements.java
index a555cac..0c4a232 100644
--- a/core/src/main/java/brooklyn/management/entitlement/Entitlements.java
+++ b/core/src/main/java/brooklyn/management/entitlement/Entitlements.java
@@ -292,6 +292,7 @@ public class Entitlements {
public static EntitlementManager newManager(ManagementContext mgmt, BrooklynProperties brooklynProperties) {
EntitlementManager result = newGlobalManager(mgmt, brooklynProperties);
// TODO read per user settings from brooklyn.properties, if set there ?
+ // update brooklyn_properties.md when done
return result;
}
private static EntitlementManager newGlobalManager(ManagementContext mgmt, BrooklynProperties brooklynProperties) {
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index c2fb5e7..5d1b386 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -218,6 +218,11 @@ using the instructions in `build.sh` as a guide.)
A typical update consists of the following commands (or a subset),
copied to `${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}`:
+ # ensure svn repo is up-to-date (very painful otherwise)
+ cd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
+ svn up
+ cd -
+
# main website, relative to /
_build/build.sh website-root --install
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index eb9215a..cca232e 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -161,7 +161,15 @@ function test_site() {
echo "Running htmlproof on _site"
mkdir -p target
LOG="target/htmlproof.log"
- htmlproof _site --href_ignore "https?://127.*" --alt_ignore ".*" 2>&1 | tee $LOG
+ # TODO for now exclude all javadoc; in time it would be nice to police that also
+ # (but not sure this is properly working yet)
+ htmlproof _site \
+ --href_ignore "https?://127.*" \
+ --href_ignore "https?://github.com/apache/incubator-brooklyn/edit/.*" \
+ --href_ignore "/" \
+ --alt_ignore ".*" \
+ --file_ignore ".*/javadoc/.*" \
+ 2>&1 | tee $LOG
}
function make_jekyll() {
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/_includes/java_link.html
----------------------------------------------------------------------
diff --git a/docs/_includes/java_link.html b/docs/_includes/java_link.html
index b296652..01ac1d7 100644
--- a/docs/_includes/java_link.html
+++ b/docs/_includes/java_link.html
@@ -8,9 +8,9 @@ usage:
{% endcomment %}{% if include.project_subpath %}<code>{{ include.class_name }}</code>
- (<a href="{{ site.guide.path }}/misc/javadoc/{{ include.package_path }}/{{ include.class_name }}.html">javadoc</a>,
- <a href="{{ site.brooklyn.url.git }}/{{ include.project_subpath }}/src/main/java/{{ include.package_path }}/{{ include.class_name }}.java">src</a>)
-{% else %}<a href="{{ site.guide.path }}/misc/javadoc/{{ include.package_path }}/{{ include.class_name }}.html">
+ (<a href="{{ site.path.guide }}/misc/javadoc/{{ include.package_path }}/{{ include.class_name }}.html">javadoc</a>,
+ <a href="{{ site.brooklyn.url.git }}/{{ include.project_subpath }}/src/main/java/{{ include.package_path }}/{{ include.class_name }}.java">src</a>){% comment %}
+{% endcomment %}{% else %}<a href="{{ site.path.guide }}/misc/javadoc/{{ include.package_path }}/{{ include.class_name }}.html">
<code>{{ include.class_name }}</code></a>
{% endif %}{% comment %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/_includes/sidemenu.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidemenu.html b/docs/_includes/sidemenu.html
index 808d9e2..ec3cf1c 100644
--- a/docs/_includes/sidemenu.html
+++ b/docs/_includes/sidemenu.html
@@ -120,8 +120,12 @@ var highlight_section = function() {
if (item && item.length) {
if (highlight_section_last_top == -1 || !highlight_section_completed) {
// just opening page - take item matching hash, or otherwise the first item visible
- if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 15 && !found_top)) {
+ if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 20 && !found_top)) {
found_top = true;
+ if (item.selector === window.location.hash && item.offset().top < highlight_section_new_top + 60) {
+ // because of our top header, we need to scroll 64px down from any link
+ $('html, body').animate({scrollTop: item.offset().top - 64}, 0);
+ }
return item;
}
} else if (scroll_advancing) {
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/_includes/topmenu.html
----------------------------------------------------------------------
diff --git a/docs/_includes/topmenu.html b/docs/_includes/topmenu.html
index 37a39d0..0275794 100644
--- a/docs/_includes/topmenu.html
+++ b/docs/_includes/topmenu.html
@@ -65,8 +65,9 @@
data-toggle="tooltip" data-placement="bottom" title="Twitter: @brooklyncentral"/>
<a href="http://webchat.freenode.net/?channels=brooklyncentral" class="navbar-icon icon-irc"
data-toggle="tooltip" data-placement="bottom" title="IRC: freenode #brooklyncentral"/>
- <!-- extra a element seems needed as landing page seems to copy the last element here (!?) -->
- <a href="." style="width: 0px; height: 0px;"></a>
+ <!-- extra a element seems needed as landing page seems to copy the last element here (!?)
+ -->
+ <a href="/" style="width: 0px; height: 0px;"></a>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/_plugins/brooklyn_metadata.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/brooklyn_metadata.rb b/docs/_plugins/brooklyn_metadata.rb
index 89d82aa..c50f844 100644
--- a/docs/_plugins/brooklyn_metadata.rb
+++ b/docs/_plugins/brooklyn_metadata.rb
@@ -61,6 +61,9 @@ module BrooklynMetadata
"is_snapshot" => is_snapshot,
"url" => url_set
}
+ # config is preferred of data, because you can write just {{ site.brooklyn.xxx }},
+ # but some places reference site.data.brooklyn
+ site.data['brooklyn'] = site.config['brooklyn']
end
end
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/dev/env/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/env/index.md b/docs/guide/dev/env/index.md
index ef00e89..8e1e422 100644
--- a/docs/guide/dev/env/index.md
+++ b/docs/guide/dev/env/index.md
@@ -10,4 +10,4 @@ children:
- ide/
---
-TODO
\ No newline at end of file
+{% include list-children.html %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/dev/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/index.md b/docs/guide/dev/index.md
index ee62245..dd709de 100644
--- a/docs/guide/dev/index.md
+++ b/docs/guide/dev/index.md
@@ -15,6 +15,9 @@ children:
- tips/debugging-remote-brooklyn.md
---
+{% comment %}
+TODO
+
The Developer Guide contains information on working with the Brooklyn codebase.
Of particular note to people getting started, there is:
@@ -29,3 +32,6 @@ And for the Brooklyn codebase itself, see:
* Areas of Special Hairiness
(All links are TODO.)
+{% endcomment %}
+
+{% include list-children.html %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/dev/tips/debugging-remote-brooklyn.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/debugging-remote-brooklyn.md b/docs/guide/dev/tips/debugging-remote-brooklyn.md
index 0f1677c..4d14e5f 100644
--- a/docs/guide/dev/tips/debugging-remote-brooklyn.md
+++ b/docs/guide/dev/tips/debugging-remote-brooklyn.md
@@ -19,27 +19,25 @@ Thankfully, the tools are available to do this, and setting it up is quite strai
The first step is to ensure that your local copy of the source code is at the version used to build the remote Brooklyn
instance. The git commit that was used to build Brooklyn is available via the REST API:
-```
-http://<remote-address>:<remote-port>/v1/server/version
-```
+ http://<remote-address>:<remote-port>/v1/server/version
This should return details of the build as a JSON string similar to the following (formatted for clarity):
-```JSON
+{% highlight json %}
{
"version": "0.7.0-SNAPSHOT",
"buildSha1": "c0fdc15291702281acdebf1b11d431a6385f5224",
"buildBranch": "UNKNOWN"
}
-```
+{% endhighlight %}
The value that we're interested in is `buildSha1`. This is the git commit that was used to build Brooklyn. We can now
checkout and build the Brooklyn code at this commit by running the following in the root of your Brooklyn repo:
-```
-git checkout c0fdc15291702281acdebf1b11d431a6385f5224
-mvn clean install -DskipTests
-```
+{% highlight bash %}
+% git checkout c0fdc15291702281acdebf1b11d431a6385f5224
+% mvn clean install -DskipTests
+{% endhighlight %}
Whilst building the code isn't strictly necessary, it can help prevent some IDE issues.
@@ -48,25 +46,24 @@ By default, Brooklyn does not listen for a debugger to be attached, however this
which will require a restart of the Brooklyn node. To do this, SSH to the remote Brooklyn node and run the following in the
root of the Brooklyn installation:
-```
+{% highlight bash %}
# NOTE: Running this kill command will lose existing apps and machines if persistence is disabled.
-kill `cat pid_java`
-export JAVA_OPTS="-Xms256m -Xmx1g -XX:MaxPermSize=256m -agentlib:jdwp=transport=dt_socket,address=127.0.0.1:8888,server=y,suspend=n"
-bin/brooklyn launch &
-```
+% kill `cat pid_java`
+% export JAVA_OPTS="-Xms256m -Xmx1g -XX:MaxPermSize=256m -agentlib:jdwp=transport=dt_socket,address=127.0.0.1:8888,server=y,suspend=n"
+% bin/brooklyn launch &
+{% endhighlight %}
If `JAVA_OPTS` is not set, Brooklyn will automatically set it to `"-Xms256m -Xmx1g -XX:MaxPermSize=256m"`, which is why
we have prepended the agentlib settings with these values here.
You should see the following in the console output:
-```
-Listening for transport dt_socket at address: 8888
-```
+ Listening for transport dt_socket at address: 8888
This will indicate the Brooklyn is listening on port 8888 for a debugger to be attached.
## <a name="sshTunnel"></a>Creating an SSH tunnel
+
If port 8888 is accessible on the remote Brooklyn server, then you can skip this step and simply use the address of the
server in place of 127.0.0.1 in the [Connecting your IDE](#connectingIDE) section below. It will normally be possible to
make the port accessible by configuring Security Groups, iptables, endpoints etc., but for a quick ad-hoc connection it's
@@ -74,7 +71,7 @@ usually simpler to create an SSH tunnel. This will create an open SSH connection
on a local interface via SSH to a port on the remote machine. To create the tunnel, run the following on your local
machine:
-```
+{% highlight bash %}
# replace this with the address or IP of the remote Brooklyn node
REMOTE_HOST=<remote-address>
# if you wish to use a different port, this value must match the port specified in the JAVA_OPTS
@@ -86,15 +83,12 @@ SSH_USER=root
# The private key file used to SSH to the remote node. If you use a password, see the alternative command below
PRIVATE_KEY_FILE=~/.ssh/id_rsa
-ssh -YNf -i $PRIVATE_KEY_FILE -l $SSH_USER -L $LOCAL_PORT:127.0.0.1:$REMOTE_PORT $REMOTE_HOST
-
-```
+% ssh -YNf -i $PRIVATE_KEY_FILE -l $SSH_USER -L $LOCAL_PORT:127.0.0.1:$REMOTE_PORT $REMOTE_HOST
+{% endhighlight %}
If you use a password to SSH to the remote Brooklyn node, simply remove the `-i $PRIVATE_KEY_FILE` section like so:
-```
-ssh -YNf -l $SSH_USER -L $LOCAL_PORT:127.0.0.1:$REMOTE_PORT $REMOTE_HOST
-```
+ ssh -YNf -l $SSH_USER -L $LOCAL_PORT:127.0.0.1:$REMOTE_PORT $REMOTE_HOST
If you are using a password to connect, you will be prompted to enter your password to connect to the remote node upon
running the SSH command.
@@ -104,10 +98,12 @@ tunnel to port 8888 on the remote 127.0.0.1 interface. It should now be possible
debugging.
## <a name="connectingIDE"></a> Connecting your IDE
+
Setting up your IDE will differ depending upon which IDE you are using. Instructions are given here for Eclipse and
IntelliJ, and have been tested with Eclipse Luna and IntelliJ Ultimate 14.
### Eclipse Setup
+
To debug using Eclipse, first open the Brooklyn project in Eclipse (see [IDE Setup](../env/ide/)).
Now create a debug configuration by clicking `Run` | `Debug Configurations...`. You will then be presented with the
@@ -119,6 +115,7 @@ Connection Type should be set to 'Standard (Socket Attach)'. The Host should be
and the Port should be set to 8888. Click 'Debug' to start debugging.
### IntelliJ Setup
+
To debug using IntelliJ, first open the Brooklyn project in IntelliJ (see [IDE Setup](../env/ide/)).
Now create a debug configuration by clicking `Run` | `Edit Configurations`. You will then be presented with the
@@ -134,6 +131,7 @@ configuration, then select the configuration from the configurations drop-down a
debugging.
### Testing
+
The easiest way to test that remote debugging has been setup correctly is to set a breakpoint and see if it is hit. An
easy place to start is to create a breakpoint in the `ServerResource.java` class, in the `getStatus()`
method.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/java/common-usage.md
----------------------------------------------------------------------
diff --git a/docs/guide/java/common-usage.md b/docs/guide/java/common-usage.md
index 3e631a2..8f0ed32 100644
--- a/docs/guide/java/common-usage.md
+++ b/docs/guide/java/common-usage.md
@@ -3,6 +3,8 @@ title: Common Classes and Entities
layout: website-normal
---
+<!-- TODO old, needs work (refactoring!) and use of java_link -->
+
### Entity Class Hierarchy
By convention in Brooklyn the following words have a particular meaning, both as types (which extend ``Group``, which extends ``Entity``) and when used as words in other entities (such as ``TomcatFabric``):
@@ -39,4 +41,100 @@ These include:
- **PaaS**: Cloud Foundry, Stackato; OpenShift
-®
+### Sensors
+
+Sensors are typically defined as static named fields on the Entity subclass. These define the channels of events and activity that interested parties can track remotely. For example:
+{% highlight java %}
+/** a sensor for saying hi (illustrative), carrying a String value
+ which is typically the name of the person to whom we are saying hi */
+public static final Sensor<String> HELLO_SENSOR = ...
+
+{% endhighlight %}
+
+If the entity is local (e.g. to a policy) these can be looked up using ``get(Sensor)``. If it may be remote, you can subscribe to it through various APIs.
+
+Sensors are used by operators and policies to monitor health and know when to invoke the effectors. The sensor data forms a nested map (i.e. JSON), which can be subscribed to through the ``ManagementContext``.
+
+Often ``Policy`` instances will subscribe to sensor events on their associated entity or its children; these events might be an ``AttributeValueEvent`` – an attribute value being reported on change or periodically – or something transient such as ``LogMessage`` or a custom ``Event`` such as "TOO_HOT".
+
+<!---
+TODO check classes above; is this much detail needed here?
+-->
+
+Sensor values form a map-of-maps. An example of some simple sensor information is shown below in JSON:
+
+ {
+ config : {
+ url : "jdbc:mysql://ec2-50-17-19-65.compute-1.amazonaws.com:3306/mysql"
+ status : "running"
+ }
+ workrate : {
+ msgsPerSec : 432
+ }
+ }
+
+Sensor values are defined as statics, which can be used to programmatically drive the subscription.
+
+A range of `Feed` instances are available to simplify reading sensor information.
+
+
+### Effectors
+
+Like sensors and config info, effectors are also static fields on the Entity class. These describe actions available on the entity, similar to methods. Their implementation includes details of how to invoke them, typically this is done by calling a method on the entity. Effectors are typically defined as follows:
+
+{% highlight java %}
+/** an effector which returns no value,
+ but which causes the entity to emit a HELLO sensor event */
+public static Effector<Void> SAY_HI = ...
+
+{% endhighlight %}
+
+Effectors are invoked by calling ``invoke(SAY_HI, name:"Bob")`` or similar. The method may take an entity if context is not clear, and it takes parameters as named parameters or a Map.
+
+Invocation returns a ``Task`` object (extending ``Future``). This allows the caller to understand progress and errors on the task, as well as ``Task.get()`` the return value. Be aware that ``task.get()`` is a blocking function that will wait until a value is available before returning.
+
+The management framework ensures that execution occurs on the machine where the ``Entity`` is mastered, with progress, result, and/or any errors reported back to the caller. It does this through the ``ExecutionManager`` which, where necessary, creates proxy ``Task`` instances. The ``ExecutionManager`` associates ``Tasks`` with the corresponding ``Entity`` so that these can be tracked externally (and relocated if the Entity is remastered to a different location).
+
+It is worth noting that where a method corresponds to an effector, direct invocation of that method on an ``Entity`` will implicitly generate the ``Task`` object as though the effector had been invoked. For example, invoking ``Cluster.resize(int)``, where ``resize`` provides an ``Effector RESIZE``, will generate a ``Task`` which can be observed remotely.
+
+
+### Tasks and the Execution Manager
+
+The ``ExecutionManager`` is responsible for tracking simultaneous executing tasks and associating these with given **tags**.
+Arbitrary tasks can be run by calling ``Task submit(Runnable)`` (similarly to the standard ``Executor``, although it also supports ``Callable`` arguments including Groovy closures, and can even be passed ``Task`` instances which have not been started). ``submit`` also accepts a few other named parameters, including ``description``, which allow additional metadata to be kept on the ``Task``. The main benefit then is to have rich metadata for executing tasks, which can be inspected through methods on the ``Task`` interface.
+
+By using the ``tag`` or ``tags`` named parameters on ``submit`` (or setting ``tags`` in a ``Task`` that is submitted), execution can be associated with various categories. This allows easy viewing can be examined by calling
+``ExecutionManager.getTasksWithTag(...)``.
+
+The following example uses Groovy, with time delays abused for readability. brooklyn's test cases check this using mutexes, which is recommended.
+
+ ExecutionManager em = []
+ em.submit(tag:"a", description:"One Mississippi", { Thread.sleep(1000) })
+ em.submit(tags:["a","b"], description:"Two Mississippi", { Thread.sleep(1000) })
+ assert em.getTasksWithTag("a").size()==2
+ assert em.getTasksWithTag("a").every { Task t -> !t.isDone() }
+ Thread.sleep(1500)
+ assert em.getTasksWithTag("a").size()==2
+ assert em.getTasksWithTag("a").every { Task t -> t.isDone() }
+
+It is possible to define `ParallelTask` and sequential `Task` instancess
+and to specify inter-task relationships with `TaskPreprocessor` instances.
+This allows building quite sophisticated workflows relatively easily.
+
+Continuing the example above, submitting a `SequentialTask`
+or specifying ``em.setTaskPreprocessorForTag("a", SingleThreadedExecution.class)``
+will cause ``Two Mississippi`` to run after ``One Mississippi`` completes.
+
+It is also possible to register `ScheduledTask` instances which run periodically.
+
+**The `Tasks` factory supplies a number of conveniences including builders to make working with tasks easier
+and should be the entry point in most cases.**
+
+
+
+### Subscriptions and the Subscription Manager
+
+In addition to scheduled tasks, tasks can triggered by subscriptions on other events including sensors.
+
+To register low-level listeners to events, use the `SubscriptionManager` API.
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/brooklyn_properties.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/brooklyn_properties.md b/docs/guide/ops/brooklyn_properties.md
new file mode 100644
index 0000000..0485afe
--- /dev/null
+++ b/docs/guide/ops/brooklyn_properties.md
@@ -0,0 +1,173 @@
+---
+title: brooklyn.properties
+layout: website-normal
+children:
+- { section: Quick Setup }
+- { section: Locations }
+- { section: Java }
+- { section: Authentication }
+- { section: Entitlements }
+- { section: HTTPS Configuration }
+---
+
+The file `~/.brooklyn/brooklyn.properties` is read when Brooklyn starts
+to load server configuration values.
+A different properties file can be specified either additionally or instead
+through [CLI options](cli.html#configuration).
+
+A template [brooklyn.properties]({{brooklyn_properties_url_path}}) file is available,
+with abundant comments.
+
+
+## Quick Setup
+
+The most common properties set in this file are for access control.
+Without this, Brooklyn will bind only to localhost or will create a random
+password written to the log for use on other networks.
+The simplest way to specify users and passwords is:
+
+{% highlight properties %}
+brooklyn.webconsole.security.users=admin,bob
+brooklyn.webconsole.security.user.admin.password=AdminPassw0rd
+brooklyn.webconsole.security.user.bob.password=BobPassw0rd
+{% endhighlight %}
+
+The properties file *must* have permissions 600
+(i.e. readable and writable only by the file's owner),
+for some security.
+
+In many cases, it is preferable instead to use an external credentials store such as LDAP
+or at least to have passwords in this file.
+Information on configuring these is [below](#authentication).
+
+If coming over a network it is highly recommended additionally to use `https`.
+This can be configured with:
+
+{% highlight properties %}
+brooklyn.webconsole.security.https.required=true
+{% endhighlight %}
+
+More information, including setting up a certificate, is described [further below](#https-configuration).
+
+
+## Locations
+
+Information on defining locations in the `brooklyn.properties` file is available [here](locations/).
+
+
+## Java
+
+Arbitrary data can be set in the `brooklyn.properties`.
+This can be accessed in java using `ManagementContext.getConfig(KEY)`.
+
+
+## Authentication
+
+**Security Providers** are the mechanism by which different authentication authorities are plugged in to Brooklyn.
+These can be configured by specifying `brooklyn.webconsole.security.provider` equal
+to the name of a class implementing `SecurityProvider`.
+An implementation of this could point to Spring, LDAP, OpenID or another identity management system.
+
+The default implementation, `ExplicitUsersSecurityProvider`, reads from a list of users and passwords
+which should be specified as configuration parameters e.g. in `brooklyn.properties`.
+This configuration could look like:
+
+{% highlight properties %}
+brooklyn.webconsole.security.users=admin
+brooklyn.webconsole.security.user.admin.salt=OHDf
+brooklyn.webconsole.security.user.admin.sha256=91e16f94509fa8e3dd21c43d69cadfd7da6e7384051b18f168390fe378bb36f9
+{% endhighlight %}
+
+The `users` line should contain a comma-separated list. The special value `*` is accepted to permit all users.
+
+To generate this, the brooklyn CLI can be used:
+{% highlight bash %}
+brooklyn generate-password --user admin
+
+Enter password:
+Re-enter password:
+
+Please add the following to your brooklyn.properies:
+
+brooklyn.webconsole.security.users=admin
+brooklyn.webconsole.security.user.admin.salt=OHDf
+brooklyn.webconsole.security.user.admin.sha256=91e16f94509fa8e3dd21c43d69cadfd7da6e7384051b18f168390fe378bb36f9
+{% endhighlight %}
+
+Alternatively, in dev/test environments where a lower level of security is required,
+the syntax `brooklyn.webconsole.security.user.<username>=<password>` can be used for
+each `<username>` specified in the `brooklyn.webconsole.security.users` list.
+
+Other security providers available include:
+
+* **No one**: `brooklyn.webconsole.security.provider=brooklyn.rest.security.provider.BlackholeSecurityProvider`
+ will block all logins (e.g. if not using the web console)
+* **No security**: `brooklyn.webconsole.security.provider=brooklyn.rest.security.provider.AnyoneSecurityProvider`
+ will allow logins with no credentials (e.g. in secure dev/test environments)
+* **LDAP**: `brooklyn.webconsole.security.provider=brooklyn.rest.security.provider.LdapSecurityProvider`
+ will cause Brooklyn to call to an LDAP server to authenticate users;
+ `brooklyn.webconsole.security.ldap.{url,realm}` must also be set as `brooklyn.properties`
+
+
+## Entitlements
+
+In addition to login access, fine-grained permissions including
+seeing entities, creating applications, seeing sensors, and invoking effectors
+can be defined on a per-user *and* per-target (e.g. which entity/effector) basis
+using an **Entitlement Manager**.
+
+This can be set globally with the property:
+
+{% highlight properties %}
+brooklyn.entitlements.global=<class>
+{% endhighlight %}
+
+The default entitlement manager is one which responds to per-user entitlement rules,
+and understands:
+
+* `root`: full access, including to the Groovy console
+* `readonly`: read-only access to almost all information
+* `minimal`: access only to server stats, for use by monitoring systems
+
+{% comment %}
+TODO in Entitlements
+
+These keywords are also understood at the `global` level, so to grant full access to `admin`
+but read-only access to any other authenticated users, you can write:
+
+{% highlight properties %}
+brooklyn.entitlements.global=readonly
+brooklyn.entitlements.user.admin=root
+{% endhighlight %}
+
+{% endcomment %}
+
+For more information, see {% include java_link.html class_name="EntitlementManager" package_path="brooklyn/management/entitlement" project_subpath="api" %}.
+
+
+## HTTPS Configuration
+
+To enable https, you will need a server certificate in a java keystore. To create a self-signed certificate, you can use the
+following command:
+
+{% highlight bash %}
+% keytool -genkey -keyalg RSA -alias brooklyn -keystore <path-to-keystore-directory>/server.key -storepass mypassword -validity 360 -keysize 2048
+{% endhighlight %}
+
+You will then be prompted to enter you name and organization details. This will create a keystore with the password `mypassword`
+- you should use your own secure password, which will be the same password used in your brooklyn.properties (below).
+You will also need to replace `<path-to-keystore-directory>` with the full path of the folder where you wish to store your
+keystore.
+
+The certificate generated will be a self-signed certificate and will not have a CN field identifying the website server
+name, which will cause a warning to be displayed by the browser when viewing the page. For production servers, a valid signed
+certificate from a trusted certifying authority should be used instead
+
+To enable HTTPS in Brooklyn, add the following to your brooklyn.properties:
+
+{% highlight properties %}
+brooklyn.webconsole.security.https.required=true
+brooklyn.webconsole.security.keystore.url=<path-to-keystore-directory>/server.key
+brooklyn.webconsole.security.keystore.password=mypassword
+brooklyn.webconsole.security.keystore.certificate.alias=brooklyn
+{% endhighlight %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/cli.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/cli.md b/docs/guide/ops/cli.md
new file mode 100644
index 0000000..3e44c62
--- /dev/null
+++ b/docs/guide/ops/cli.md
@@ -0,0 +1,143 @@
+---
+title: CLI
+layout: website-normal
+---
+
+To launch Brooklyn, from the directory where Brooklyn is unpacked, run:
+
+{% highlight bash %}
+% bin/brooklyn launch
+{% endhighlight %}
+
+With no configuration, this will launch the Brooklyn web console and REST API on [`http://localhost:8081/`](http://localhost:8081/).
+No password is set, but the server is listening only on the loopback network interface for security.
+Once [security is configured](brooklyn_properties.html), Brooklyn will listen on all network interfaces by default.
+
+You may wish to [add Brooklyn to your path](#path-setup);
+assuming you've done this, to get information the supported CLI options
+at any time, just run `brooklyn help`:
+
+{% highlight bash %}
+% bin/brooklyn help
+
+usage: brooklyn [(-q | --quiet)] [(-v | --verbose)] <command> [<args>]
+
+The most commonly used brooklyn commands are:
+ help Display help information about brooklyn
+ info Display information about brooklyn
+ launch Starts a brooklyn application. Note that a BROOKLYN_CLASSPATH environment variable needs to be set up beforehand to point to the user application classpath.
+
+See 'brooklyn help <command>' for more information on a specific command.
+{% endhighlight %}
+
+
+
+## Configuration
+
+Brooklyn can read configuration from a variety of places:
+
+* the file `~/.brooklyn/brooklyn.properties` (unless `--noGlobalBrooklynProperties` is specified)
+* another file, if the `--localBrooklynProperties <local brooklyn.properties file>`
+* ``-D`` defines on the brooklyn (java) command-line
+* shell environment variables
+
+These properties are described in more detail [here](brooklyn_properties.html).
+
+
+
+## Path Setup
+
+In order to have easy access to the cli it is useful to configure the PATH environment variable to also point to the cli's bin directory:
+
+{% highlight bash %}
+BROOKLYN_HOME=/path/to/brooklyn/
+export PATH=$PATH:$BROOKLYN_HOME/usage/dist/target/brooklyn-dist/bin/
+{% endhighlight %}
+
+
+## Running from a Source Build
+
+Here is an example of the commands you might run to get the Brooklyn code,
+compile it and launch an application:
+
+{% highlight bash %}
+git clone https://github.com/apache/incubator-brooklyn.git
+cd brooklyn
+mvn clean install -DskipTests
+BROOKLYN_HOME=$(pwd)
+export PATH=${PATH}:${BROOKLYN_HOME}/usage/dist/target/brooklyn-dist/bin/
+export BROOKLYN_CLASSPATH=${BROOKLYN_HOME}/examples/simple-web-cluster/target/classes
+brooklyn launch --app brooklyn.demo.SingleWebServerExample --location localhost
+{% endhighlight %}
+
+
+## Extending the Classpath
+
+You can add things to the Brooklyn classpath in a number of ways:
+
+* Add ``.jar`` files to Brooklyn's ``./lib/dropins/`` directory. These are added at the end of the classpath.
+* Add ``.jar`` files to Brooklyn's ``./lib/patch/`` directory. These are added at the front of the classpath.
+* Add resources to Brooklyn's ``./conf/`` directory. This directory is at the very front of the classpath.
+* Use the ``BROOKLYN_CLASSPATH`` environment variable. If set, this is prepended to the Brooklyn classpath.
+
+
+## Cloud Explorer
+
+The `brooklyn` command line tool includes support for querying (and managing) cloud
+compute resources and blob-store resources.
+
+For example, `brooklyn cloud-compute list-instances --location aws-ec2:eu-west-1`
+will use the AWS credentials from `brooklyn.properties` and list the VM instances
+running in the given EC2 region.
+
+Use `brooklyn help` and `brooklyn help cloud-compute` to find out more information.
+
+This functionality is not intended as a generic cloud management CLI, but instead
+solves specific Brooklyn use-cases. The main use-case is discovering the valid
+configuration options on a given cloud, such as for `imageId` and `hardwareId`.
+
+
+### Cloud Compute
+
+The command `brooklyn cloud-compute` has the following options:
+
+* `list-images`: lists VM images within the given cloud, which can be chosen when
+ provisioning new VMs.
+ This is useful for finding the possible values for the `imageId` configuration.
+
+* `get-image <imageId1> <imageId2> ...`: retrieves metadata about the specific images.
+
+* `list-hardware-profiles`: lists the ids and the details of the hardware profiles
+ available when provisioning.
+ This is useful for finding the possible values for the `hardwareId` configuration.
+
+* `default-template`: retrieves metadata about the image and hardware profile that will
+ be used by Brooklyn for that location, if no additional configuration options
+ are supplied.
+
+* `list-instances`: lists the VM instances within the given cloud.
+
+* `terminate-instances <instanceId1> <instanceId2> ...`: Terminates the instances with
+ the given ids.
+
+
+## Blob Store
+
+The command `brooklyn cloud-blobstore` is used to access a given object store, such as S3
+or Swift. It has the following options:
+
+* `list-containers`: lists the containers (i.e. buckets in S3 terminology) within the
+ given object store.
+
+* `list-container <containerName>`: lists all the blobs (i.e. objects) contained within
+ the given container.
+
+* `blob --container <containerName> --blob <blobName>`: retrieves the given blob
+ (i.e. object), including metadata and its contents.
+
+
+## Other Topics
+
+The CLI arguments for [persistence and HA](persistence/)
+are described separately,
+as is [detailed configuration](brooklyn_properties.html).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/index.md b/docs/guide/ops/index.md
index b224852..6b523f6 100644
--- a/docs/guide/ops/index.md
+++ b/docs/guide/ops/index.md
@@ -2,11 +2,12 @@
title: Operations
layout: website-normal
children:
+- cli.md
+- brooklyn_properties.md
- locations/
- persistence/
-- launching/
- catalog/
-- runtime-management/
+- logging.md
---
{% include list-children.html %}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/launching/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/launching/index.md b/docs/guide/ops/launching/index.md
deleted file mode 100644
index c35281e..0000000
--- a/docs/guide/ops/launching/index.md
+++ /dev/null
@@ -1,143 +0,0 @@
----
-title: Launching Brooklyn
-layout: website-normal
----
-
-There are several ways to launch applications with brooklyn, and useful configuration options,
-as well as a debug-view web console.
-
-This chapter describes how to launch brooklyn.
-
-
-Startup Configuration
----------------------
-
-brooklyn can read configuration from a variety of places:
-
-* the file ``~/.brooklyn/brooklyn.properties``
-* ``-D`` defines on the brooklyn (java) command-line
-* shell environment variables
-
-Default properties are described in the Javadoc and code of the class ``BrooklynProperties``,
-but some of the most common ones are:
-
-{% highlight properties %}
-brooklyn.location.jclouds.aws-ec2.identity=AKA50M30N3S1DFR0MAW55
-brooklyn.location.jclouds.aws-ec2.credential=aT0Ps3cr3tC0D3wh1chAW5w1llG1V3y0uTOus333
-brooklyn.location.jclouds.aws-ec2.privateKeyFile=~/path/to/id_rsa # use specified key (default is ~/.ssh/id_rsa)
-brooklyn.location.jclouds.aws-ec2.publicKeyFile=~/path/to/id_rsa.pub # (optional, inferred from previous if omitted)
-{% endhighlight %}
-
-These can be specified as a shell environment variable or as a Java system property,
-although in those contexts the conventional format ``BROOKLYN_JCLOUDS_AWS_EC2_IDENTITY``
-is supported and recommended.
-
-The recommended approach is to use the properties file, with permissions 600
-(i.e. readable and writable only by the file's owner).
-
-
-Command Line Interface
-----------------------
-
-Brooklyn comes with a Command Line Interface (cli) that makes it easier to launch an application.
-
-In order to have easy access to the cli it is useful to configure the PATH environment variable to also point to the cli's bin directory:
-
-{% highlight bash %}
-BROOKLYN_HOME=/path/to/brooklyn/
-export PATH=$PATH:$BROOKLYN_HOME/usage/dist/target/brooklyn-dist/bin/
-{% endhighlight %}
-
-If you have set this up correctly you should be able to invoke the ```brooklyn``` command:
-
-{% highlight bash %}
-brooklyn
-{% endhighlight %}
-
-To get information about all the supported cli options just run:
-
-{% highlight bash %}
-brooklyn help
-usage: brooklyn [(-q | --quiet)] [(-v | --verbose)] <command> [<args>]
-
-The most commonly used brooklyn commands are:
- help Display help information about brooklyn
- info Display information about brooklyn
- launch Starts a brooklyn application. Note that a BROOKLYN_CLASSPATH environment variable needs to be set up beforehand to point to the user application classpath.
-
-See 'brooklyn help <command>' for more information on a specific command.
-{% endhighlight %}
-
-Here is an example of the commands you might run to get the Brooklyn code, compile it and launch an application:
-
-{% highlight bash %}
-git clone https://github.com/apache/incubator-brooklyn.git
-cd brooklyn
-mvn clean install -DskipTests
-BROOKLYN_HOME=$(pwd)
-export PATH=${PATH}:${BROOKLYN_HOME}/usage/dist/target/brooklyn-dist/bin/
-export BROOKLYN_CLASSPATH=${BROOKLYN_HOME}/examples/simple-web-cluster/target/classes
-brooklyn launch --app brooklyn.demo.SingleWebServerExample --location localhost
-{% endhighlight %}
-
-You can add things to the brooklyn classpath in a number of ways:
-
-* Add ``.jar`` files to brooklyn's ``./lib/dropins/`` directory. These are added at the end of the classpath.
-* Add ``.jar`` files to brooklyn's ``./lib/patch/`` directory. These are added at the front of the classpath.
-* Add resources to brooklyn's ``./conf/`` directory. This directory is at the very front of the classpath.
-* Use the ``BROOKLYN_CLASSPATH`` environment variable. If set, this is prepended to the brooklyn classpath.
-
-
-### Cloud Explorer
-
-The `brooklyn` command line tool includes support for querying (and managing) cloud
-compute resources and blob-store resources.
-
-For example, `brooklyn cloud-compute list-instances --location aws-ec2:eu-west-1`
-will use the AWS credentials from brooklyn.properties, and will list the VM instances
-running in the given EC2 region.
-
-Use `brooklyn help` and `brooklyn help cloud-compute` to find out more information.
-
-This functionality is not intended as a generic cloud management CLI, but instead
-solves specific brooklyn use-cases. The main use-case is discovering the valid
-configuration options on a given cloud, such as for `imageId` and `hardwareId`.
-
-
-#### Cloud Compute
-
-The command `brooklyn cloud-compute` has the following options:
-
-* `list-images`: lists VM images within the given cloud, which can be chosen when
- provisioning new VMs.
- This is useful for finding the possible values for the `imageId` configuration.
-
-* `get-image <imageId1> <imageId2> ...`: retrieves metadata about the specific images.
-
-* `list-hardware-profiles`: lists the ids and the details of the hardware profiles
- available when provisioning.
- This is useful for finding the possible values for the `hardwareId` configuration.
-
-* `default-template`: retrieves metadata about the image and hardware profile that will
- be used by Brooklyn for that location, if no additional configuration options
- are supplied.
-
-* `list-instances`: lists the VM instances within the given cloud.
-
-* `terminate-instances <instanceId1> <instanceId2> ...`: Terminates the instances with
- the given ids.
-
-
-#### Blob Store
-
-The command `brooklyn cloud-blobstore` is used to access a given object store, such as S3
-or Swift. It has the following options:
-
-* `list-containers`: lists the containers (i.e. buckets in S3 terminology) within the
- given object store.
-
-* `list-container <containerName>`: lists all the blobs (i.e. objects) contained within
- the given container.
-
-* `blob --container <containerName> --blob <blobName>`: retrieves the given blob
- (i.e. object), including metadata and its contents.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/locations/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/index.md b/docs/guide/ops/locations/index.md
index b5e5afd..810f7b8 100644
--- a/docs/guide/ops/locations/index.md
+++ b/docs/guide/ops/locations/index.md
@@ -60,7 +60,7 @@ brooklyn.location.jclouds.aws-ec2.credential=s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1
And in this case you can reference the location in YAML with `location: jclouds:aws-ec2`.
-The Getting Started [template brooklyn.properties](../start/brooklyn.properties) contains more examples
+The Getting Started [template brooklyn.properties]({{ site.path.guide }}/start/brooklyn.properties) contains more examples
of configuring cloud endpoints, including information on credential types used in different clouds.
@@ -264,5 +264,5 @@ brooklyn.location.named.On-Prem\ Iron\ Example.privateKeyPassphrase=s3cr3tpassph
### Other Location Topics
-* [More Locations](more-locations.md)
-* [SSH Keys](ssh-keys.md)
+* [More Locations](more-locations.html)
+* [SSH Keys](ssh-keys.html)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/locations/more-locations.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/more-locations.md b/docs/guide/ops/locations/more-locations.md
index 35e2398..994eaf7 100644
--- a/docs/guide/ops/locations/more-locations.md
+++ b/docs/guide/ops/locations/more-locations.md
@@ -50,6 +50,6 @@ and then to `acct2`.
### The Server Pool
-The {% include java_link.html package_path="brooklyn/entity/pool" project_subpath="software/base" %}
+The {% include java_link.html class_name="ServerPool" package_path="brooklyn/entity/pool" project_subpath="software/base" %}
entity type allows defining an entity which becomes available as a location.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/locations/ssh-keys.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/ssh-keys.md b/docs/guide/ops/locations/ssh-keys.md
index 6839f62..f805253 100644
--- a/docs/guide/ops/locations/ssh-keys.md
+++ b/docs/guide/ops/locations/ssh-keys.md
@@ -40,18 +40,43 @@ and that your key is authorized for ssh access:
$ cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
{% endhighlight %}
-You should be able to run `ssh localhost` without any password required.
+Now verify that your setup by running the command: `ssh localhost echo hello world`
+
+If your setup is correct, you should see `hello world` printed back at you.
+
+On the first connection, you may see a message similar to this:
+
+<pre>
+The authenticity of host 'localhost (::1)' can't be established.
+RSA key fingerprint is 7b:e3:8e:c6:5b:2a:05:a1:7c:8a:cf:d1:6a:83:c2:ad.
+Are you sure you want to continue connecting (yes/no)?
+</pre>
+
+Simply answer 'yes' and then repeat the command again.
+
+If this isn't the case, see below.
-**Got a passphrase?** Set `brooklyn.location.localhost.privateKeyPassphrase`
-as described [here](index.html#os-setup)
-**MacOS user?** In addition to the above, enable "Remote Login" in "System Preferences > Sharing".
### Potential Problems
-* `~/.ssh/` or files in that directory too open: they should be visible only to the user (apart from public keys),
- both on the source machine and the target machine
+* **MacOS user?** In addition to the above, enable "Remote Login" in "System Preferences > Sharing".
+
+* **Got a passphrase?** Set `brooklyn.location.localhost.privateKeyPassphrase`
+ as described [here](index.html#os-setup).
+ If you're not sure, or you don't know what a passphrase is, you can test this by executing `ssh-keygen -y`.
+ If it does *not* ask for a passphrase, then your key has no passphrase.
+ If your key does have a passphrase, you can remove it by running `ssh-keygen -p`.
+
+* Check that you have an `~/.ssh/id_rsa` file (or `id_dsa`) and a corresponding public key with a `.pub` extension;
+ if not, create one as described above
+
+* `~/.ssh/` or files in that directory may have permissions they shouldn't:
+ they should be visible only to the user (apart from public keys),
+ both on the source machine and the target machine.
+ You can verify this with `ls -l ~/.ssh/`: lines should start with `-rw-------` or `-r--------` (or `-rwx------` for directories).
+ If it does not, execute `chmod go-rwx ~/.ssh ~/.ssh/*`.
* Sometimes machines are configured with different sets of support SSL/TLS versions and ciphers;
if command-line `ssh` and `scp` work, but Brooklyn/java does not, check the versions enabled in Java and on both servers.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/logging.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/logging.md b/docs/guide/ops/logging.md
new file mode 100644
index 0000000..fc1da3c
--- /dev/null
+++ b/docs/guide/ops/logging.md
@@ -0,0 +1,46 @@
+---
+title: Logging
+layout: website-normal
+---
+
+
+Brooklyn uses the SLF4J logging facade, which allows use of many popular frameworks including `logback`,
+`java.util.logging` and `log4j`.
+
+The convention for log levels is as follows:
+
+* `ERROR` and above: exceptional situations which indicate that something has unexpectedly failed or
+some other problem has occured which the user is expected to attend to
+* `WARN`: exceptional situations which the user may which to know about but which do not necessarily indicate failure or require a response
+* `INFO`: a synopsis of activity, but which should not generate large volumes of events nor overwhelm a human observer
+* `DEBUG` and lower: detail of activity which is not normally of interest, but which might merit closer inspection under certain circumstances.
+
+Loggers follow the ``package.ClassName`` naming standard.
+
+## Standard Configuration
+
+A `logback.xml` file is included in the `conf/` directly of the Brooklyn distro;
+this is read by `brooklyn` at launch time. Changes to the logging configuration,
+such as new appenders or different log levels, can be made directly in this file
+or in a new file included from this.
+
+
+## Advanced Configuration
+
+The default `logback.xml` file references a collection of other log configuration files
+included in the Brooklyn jars. It is necessary to understand the source structure
+in the [logback-includes]({{ site.brooklyn.url.git }}/usage/logback-includes) project.
+
+For example, to change the debug log inclusions, create a folder `brooklyn` under `conf`
+and create a file `logback-debug.xml` based on the
+[brooklyn/logback-debug.xml]({{ site.brooklyn.url.git }}/usage/logback-includes/src/main/resources/brooklyn/logback-debug.xml)
+from that project.
+
+
+## For More Information
+
+The following resources may be useful when configuring logging:
+
+* The [logback-includes]({{ site.brooklyn.url.git }}/usage/logback-includes) project
+* [Brooklyn Developer Guide]({{ site.path.guide }}/dev/tips/logging.html) logging tips
+* The [Logback Project](http://logback.qos.ch/) home page
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/runtime-management/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/runtime-management/index.md b/docs/guide/ops/runtime-management/index.md
deleted file mode 100644
index dd825dd..0000000
--- a/docs/guide/ops/runtime-management/index.md
+++ /dev/null
@@ -1,325 +0,0 @@
----
-title: Runtime Management
-layout: website-normal
----
-
-brooklyn uses many of the ideas from autonomic computing to implement management of entities in a
-structured and reusable fashion (including provisioning, healing, and optimising).
-
-Each external system, process or service is represented as an entity within brooklyn, with
-collections of these being represented and managed by other entities, and so forth through
-a hierarchy rooted in entities referred to as "Applications". Each entity has:
-
-- provisioning and tear-down logic for the external system(s) it represents
-- sensors which it publishes to report on its state and activity
-- effectors which can be invoked to change it
-- policies which perform analysis, enrichment (sensors), and execution (effectors). It is the
- policies in brooklyn which perform the self-management (in autonomic terms) by monitoring sensors
- and invoking effectors.
-
-This chapter describes these high-level runtime concepts, as well as presenting more
-detailed information on the underlying implementation of management within brooklyn.
-
-
-
-
-Management Web Console
-----------------------
-
-The web-based management console that comes with brooklyn serves as a way to observe and manage brooklyn entities.
-It provides low-level details of activity (including stack-traces), sensor values, and policies,
-and some visual widgets for observing what is happening.
-This console is not designed as a management dashboard or portal --
-many good options exist in that space --
-but what could be useful is to embed widgets from the brooklyn portal for selected high-level views.
-
-<!-- FIXME Update to use new construction pattern, rather than calling app's constructor -->
-To start a management console from your own code, use ``BrooklynLaucher.launch``:
-{% highlight java %}
-public static void main(String[] argv) {
- Application app = new MyApplicationExample(displayName:"myapp")
- BrooklynServerDetails server = BrooklynLauncher.newLauncher()
- .managing(app)
- .launch();
- // ...
-}
-{% endhighlight %}
-
-This will start an embedded brooklyn management node, including the web console.
-The URL for the web console defaults to http://127.0.0.1:8081, .
-
-The mechanism for launching brooklyn management will change in a future release. For this release, the brooklyn management node is embedded.
-
-The console contains two main views: Dashboard and Detail. These update in real-time.
-
-**Dashboard**
-
-The dashboard is a high level overview of the state of the application:
-
-[](webconsole-dashboard.png)
-
-
-**Detail**
-
-The Detail view gives an in-depth view of the application and its entities.
-Child-parent relationships between entities are navigable using the entity tree;
-each entity is shown with its children (or, in the case of childless group entities, the members).
-Selecting a specific entity allows you to access detailed information about that entity.
-
-[](webconsole-detail.png)
-
-The Detail view contains a breadcrumb trail, showing the current entitiy's position in the heirarchy, and six tabs:
-
-**Summary:** Description of the selected entity.
-
-**Sensors:** Lists the attribute sensors that the entity has and their values.
-
-**Effectors:** Lists the effectors that can be invoked on the selected entity.
-
-**Activity:** Current and historic activity of the entity, currently running effectors, finished effectors.
-
-**Location:** The geographical location of the selected entity.
-
-**Policies:** Lists the policies associated with the current entity. Policies can be suspended, resumed and removed through the UI.
-
-### Security
-
-Security providers can be configured by specifying `brooklyn.webconsole.security.provider` equal
-to the name of a class implementing `SecurityProvider`.
-An implementation of this could point to Spring, LDAP, OpenID or another identity management system.
-
-The default implementation, `ExplicitUsersSecurityProvider`, reads from a list of users and passwords
-which should be specified as configuration parameters e.g. in `brooklyn.properties`.
-This configuration could look like:
-
-{% highlight properties %}
-brooklyn.webconsole.security.users=admin
-brooklyn.webconsole.security.user.admin.salt=OHDf
-brooklyn.webconsole.security.user.admin.sha256=91e16f94509fa8e3dd21c43d69cadfd7da6e7384051b18f168390fe378bb36f9
-{% endhighlight %}
-
-The `users` line should contain a comma-separated list. The special value `*` is accepted to permit all users.
-
-To generate this, the brooklyn CLI can be used:
-{% highlight bash %}
-brooklyn generate-password --user admin
-
-Enter password:
-Re-enter password:
-
-Please add the following to your brooklyn.properies:
-
-brooklyn.webconsole.security.users=admin
-brooklyn.webconsole.security.user.admin.salt=OHDf
-brooklyn.webconsole.security.user.admin.sha256=91e16f94509fa8e3dd21c43d69cadfd7da6e7384051b18f168390fe378bb36f9
-{% endhighlight %}
-
-For legacy and dev purposes, the password can also be stored in plain text:
-
-{% highlight properties %}
-brooklyn.webconsole.security.users=admin
-brooklyn.webconsole.security.user.admin.password=mypassword
-{% endhighlight %}
-
-If not using the web console, you can specify
-`brooklyn.webconsole.security.provider=brooklyn.rest.security.provider.BlackholeSecurityProvider` to prevent inadvertant logins.
-During dev/test you can specify `brooklyn.webconsole.security.provider=brooklyn.rest.security.provider.AnyoneSecurityProvider`
-to allow logins with no credentials.
-
-To enable https, you will need a server certificate in a java keystore. To create a self-signed certificate, you can use the
-following command:
-
-`keytool -genkey -keyalg RSA -alias brooklyn -keystore <path-to-keystore-directory>/server.key -storepass mypassword -validity 360 -keysize 2048`
-
-You will then be prompted to enter you name and organization details. This will create a keystore with the password `mypassword`
-- you should use your own secure password, which will be the same password used in your brooklyn.properties (below).
-You will also need to replace `<path-to-keystore-directory>` with the full path of the folder where you wish to store your
-keystore.
-
-The certificate generated will be a self-signed certificate and will not have a CN field identifying the website server
-name, which will cause a warning to be displayed by the browser when viewing the page. For production servers, a valid signed
-certificate from a trusted certifying authority should be used instead
-
-To enable HTTPS in Brooklyn, add the following to your brooklyn.properties:
-
-```
-# HTTPS
-brooklyn.webconsole.security.https.required=true
-brooklyn.webconsole.security.keystore.url=<path-to-keystore-directory>/server.key
-brooklyn.webconsole.security.keystore.password=mypassword
-brooklyn.webconsole.security.keystore.certificate.alias=brooklyn
-```
-
-In order to access the Brooklyn console, you will also need to enable security, and setup a user as described above
-
-Other Ways to Observe Activity
-------------------------------
-
-### Java API
-
-``ManagementContext`` provides a Java programmatic API.
-
-More information can be found in the javadoc for ``ManagementContext``.
-
-### Command-line Console
-
-*Not available yet.*
-
-### Management REST API
-
-Brooklyn's REST API supports a wide range of queries and operations. All information
-and operations shown in the web-console is performed via the REST API.
-
-The REST API can be explored through the Brooklyn web-console, via the menu Script -> REST API.
-
-### Logging
-
-Brooklyn uses the SLF4J logging facade, which allows use of many popular frameworks including logback, java.util.logging and log4j.
-
-The convention for log levels is as follows:
-* ERROR and above: exceptional situations which indicate that something has unexpectedly failed or
-some other problem has occured which the user is expected to attend to
-* WARN: exceptional situations which the user may which to know about but which do not necessarily indicate failure or require a response
-* INFO: a synopsis of activity, but which should not generate large volumes of events nor overwhelm a human observer
-* DEBUG and lower: detail of activity which is not normally of interest, but which might merit closer inspection under certain circumstances.
-
-Loggers follow the ``package.ClassName`` naming standard.
-
-It is possible for entities to emit logging activity sensors so that an operator can observe what is occurring within their application through the web console or via programmatic means.
-
-Examples for testing can be found in some of the poms.
-
-
-<!---
-
-<a name="distributed-management"></a>
-Distributed Management
-----------------------
-
-TODO Describe how and when objects become "live", pushed out to other nodes.
--->
-
-<!---
-
-<a name="resilience"></a>
-Resilience
-----------
-TODO
-*This section still needs to be written. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
--->
-
-
-Key APIs
---------
-<!---
-TODO - brief overview of key APIs
--->
-*This section still needs to be written. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
-
-- ``ManagementContext`` (Java management API)
-- ``EntityLocal`` (used by policies)
-
-
-<!---
-TODO - describe how to simply configure logging slf4j
--->
-
-Sensors and Effectors
----------------------
-
-### Sensors
-
-Sensors are typically defined as static named fields on the Entity subclass. These define the channels of events and activity that interested parties can track remotely. For example:
-{% highlight java %}
-/** a sensor for saying hi (illustrative), carrying a String value
- which is typically the name of the person to whom we are saying hi */
-public static final Sensor<String> HELLO_SENSOR = ...
-
-{% endhighlight %}
-
-If the entity is local (e.g. to a policy) these can be looked up using ``get(Sensor)``. If it may be remote, you can subscribe to it through various APIs.
-
-<!---
-TODO probably say about events now, quick reference about SubscriptionManager (either here or in next section on management context)
-TODO remaining section on Sensors perhaps should be moved to Writing Entities section? as reader won't need to know too much detail of sensor types to understand policies... though perhaps saying some is right. (Talking about JSON is almost certainly overkill...)
--->
-
-Sensors are used by operators and policies to monitor health and know when to invoke the effectors. The sensor data forms a nested map (i.e. JSON), which can be subscribed to through the ``ManagementContext``.
-
-Often ``Policy`` instances will subscribe to sensor events on their associated entity or its children; these events might be an ``AttributeValueEvent`` – an attribute value being reported on change or periodically – or something transient such as ``LogMessage`` or a custom ``Event`` such as "TOO_HOT".
-
-<!---
-TODO check classes above; is this much detail needed here?
--->
-
-Sensor values form a map-of-maps. An example of some simple sensor information is shown below in JSON:
-
- {
- config : {
- url : "jdbc:mysql://ec2-50-17-19-65.compute-1.amazonaws.com:3306/mysql"
- status : "running"
- }
- workrate : {
- msgsPerSec : 432
- }
- }
-
-Sensor values are defined as statics, which can be used to programmatically drive the subscription.
-<!---
-TODO , etc., example
--->
-
-### SubscriptionManager
-
-*This section is not complete. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
-
-*See the* ``SubscriptionManager`` *class.*
-<!---
-TODO
--->
-
-### Effectors
-
-Like sensors and config info, effectors are also static fields on the Entity class. These describe actions available on the entity, similar to methods. Their implementation includes details of how to invoke them, typically this is done by calling a method on the entity. Effectors are typically defined as follows:
-
-{% highlight java %}
-/** an effector which returns no value,
- but which causes the entity to emit a HELLO sensor event */
-public static Effector<Void> SAY_HI = ...
-
-{% endhighlight %}
-
-Effectors are invoked by calling ``invoke(SAY_HI, name:"Bob")`` or similar. The method may take an entity if context is not clear, and it takes parameters as named parameters or a Map.
-
-Invocation returns a ``Task`` object (extending ``Future``). This allows the caller to understand progress and errors on the task, as well as ``Task.get()`` the return value. Be aware that ``task.get()`` is a blocking function that will wait until a value is available before returning.
-
-The management framework ensures that execution occurs on the machine where the ``Entity`` is mastered, with progress, result, and/or any errors reported back to the caller. It does this through the ``ExecutionManager`` which, where necessary, creates proxy ``Task`` instances. The ``ExecutionManager`` associates ``Tasks`` with the corresponding ``Entity`` so that these can be tracked externally (and relocated if the Entity is remastered to a different location).
-
-It is worth noting that where a method corresponds to an effector, direct invocation of that method on an ``Entity`` will implicitly generate the ``Task`` object as though the effector had been invoked. For example, invoking ``Cluster.resize(int)``, where ``resize`` provides an ``Effector RESIZE``, will generate a ``Task`` which can be observed remotely.
-
-### ExecutionManager
-
-The ``ExecutionManager`` is responsible for tracking simultaneous executing tasks and associating these with given **tags**.
-Arbitrary tasks can be run by calling ``Task submit(Runnable)`` (similarly to the standard ``Executor``, although it also supports ``Callable`` arguments including Groovy closures, and can even be passed ``Task`` instances which have not been started). ``submit`` also accepts a few other named parameters, including ``description``, which allow additional metadata to be kept on the ``Task``. The main benefit then is to have rich metadata for executing tasks, which can be inspected through methods on the ``Task`` interface.
-
-By using the ``tag`` or ``tags`` named parameters on ``submit`` (or setting ``tags`` in a ``Task`` that is submitted), execution can be associated with various categories. This allows easy viewing can be examined by calling
-``ExecutionManager.getTasksWithTag(...)``.
-
-The following example uses Groovy, with time delays abused for readability. brooklyn's test cases check this using mutexes, which is recommended.
-
- ExecutionManager em = []
- em.submit(tag:"a", description:"One Mississippi", { Thread.sleep(1000) })
- em.submit(tags:["a","b"], description:"Two Mississippi", { Thread.sleep(1000) })
- assert em.getTasksWithTag("a").size()==2
- assert em.getTasksWithTag("a").every { Task t -> !t.isDone() }
- Thread.sleep(1500)
- assert em.getTasksWithTag("a").size()==2
- assert em.getTasksWithTag("a").every { Task t -> t.isDone() }
-
-It is possible to define ParallelTasks and SequentialTasks and to specify inter-task relationships with TaskPreprocessors. This allows building quite sophisticated workflows relatively easily.
-
-Continuing the example above, submitting a SequentialTasks or specifying ``em.setTaskPreprocessorForTag("a", SingleThreadedExecution.class)`` will cause ``Two Mississippi`` to run after ``One Mississippi`` completes.
-
-For more information consult the javadoc on these classes and associated tests.
-
-Note that it is currently necessary to prune dead tasks, either periodically or by the caller. By default they are kept around for reference. It is expected that an enhancement in a future release will allow pruning completed and failed tasks after a specified amount of time.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/runtime-management/webconsole-dashboard-w400.png
----------------------------------------------------------------------
diff --git a/docs/guide/ops/runtime-management/webconsole-dashboard-w400.png b/docs/guide/ops/runtime-management/webconsole-dashboard-w400.png
deleted file mode 100644
index 6364dc5..0000000
Binary files a/docs/guide/ops/runtime-management/webconsole-dashboard-w400.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/runtime-management/webconsole-dashboard.png
----------------------------------------------------------------------
diff --git a/docs/guide/ops/runtime-management/webconsole-dashboard.png b/docs/guide/ops/runtime-management/webconsole-dashboard.png
deleted file mode 100644
index cac5567..0000000
Binary files a/docs/guide/ops/runtime-management/webconsole-dashboard.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/runtime-management/webconsole-detail-w400.png
----------------------------------------------------------------------
diff --git a/docs/guide/ops/runtime-management/webconsole-detail-w400.png b/docs/guide/ops/runtime-management/webconsole-detail-w400.png
deleted file mode 100644
index b372e55..0000000
Binary files a/docs/guide/ops/runtime-management/webconsole-detail-w400.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/ops/runtime-management/webconsole-detail.png
----------------------------------------------------------------------
diff --git a/docs/guide/ops/runtime-management/webconsole-detail.png b/docs/guide/ops/runtime-management/webconsole-detail.png
deleted file mode 100644
index 17829cd..0000000
Binary files a/docs/guide/ops/runtime-management/webconsole-detail.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/start/_my-web-cluster.yaml
----------------------------------------------------------------------
diff --git a/docs/guide/start/_my-web-cluster.yaml b/docs/guide/start/_my-web-cluster.yaml
index 3b6134b..7862c6b 100644
--- a/docs/guide/start/_my-web-cluster.yaml
+++ b/docs/guide/start/_my-web-cluster.yaml
@@ -1,8 +1,10 @@
name: My Web Cluster
-location: location
+
+location: localhost
+
services:
-- serviceType: brooklyn.entity.webapp.ControlledDynamicWebAppCluster
+- type: brooklyn.entity.webapp.ControlledDynamicWebAppCluster
name: My Web
brooklyn.config:
wars.root: http://search.maven.org/remotecontent?filepath=io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/{{ site.data.brooklyn.version }}/brooklyn-example-hello-world-sql-webapp-{{ site.data.brooklyn.version }}.war
@@ -12,7 +14,7 @@ services:
component("db").attributeWhenReady("datastore.url"),
"visitors", "brooklyn", "br00k11n")
-- serviceType: brooklyn.entity.database.mysql.MySqlNode
+- type: brooklyn.entity.database.mysql.MySqlNode
id: db
name: My DB
brooklyn.config:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/start/blueprints.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/blueprints.md b/docs/guide/start/blueprints.md
index 9657d0d..d50cd94 100644
--- a/docs/guide/start/blueprints.md
+++ b/docs/guide/start/blueprints.md
@@ -1,57 +1,63 @@
---
-title: Launching Applications
-title_in_menu: Launching Applications
+title: Deploying Blueprints
layout: website-normal
menu_parent: index.md
+children:
+- { section: Launching from a Blueprint, title: Blueprint }
+- { section: Launching from the Catalog, title: Catalog }
---
{% include fields.md %}
-### Launching from the Catalog
+## Launching from a Blueprint
-Download the template [catalog.xml](catalog.xml) to your `~/.brooklyn/` folder, and relaunch Brooklyn.
+We'll start by deploying an application from a YAML blueprint.
-Now when we open the web console, two applications are displayed from the catalog.
+
-Select the 'Demo Web Cluster with DB' and click 'Next'.
+Copy the blueprint below into the large text box on the YAML tab.
+But *before* you submit it, we need to make a modification.
-[](add-application-catalog-web-cluster-with-db-large.png)
+{% highlight yaml %}
+{% readj _my-web-cluster.yaml %}
+{% endhighlight %}
-Select the Location that Brooklyn should deploy to, and name your application then click 'Finish' to launch the application as before.
+Find the line near the top of the blueprint that starts `location:`.
+Change this to have the right values for your preferred target; for example:
-## Launching from a blueprint
+{% highlight yaml %}
+location:
+ jclouds:aws-ec2:
+ identity: ABCDEFGHIJKLMNOPQRST
+ credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
+{% endhighlight %}
-There are several ways to deploy a YAML blueprint (including specifying the blueprint on the command line or submitting it via the REST API).
+(Alternatively, if you have `ssh localhost` [configured](../ops/locations/#localhost) you can leave it as is.
+See [Locations](../ops/locations) in the Operations section of the User Guide for detail on setting up
+cloud providers, including putting credentials in a file on disk rather than in the blueprint.)
-For now, we will simply copy-and-paste the raw YAML blueprint into the web console.
+With the modified YAML in the dialog, click "Finish". The dialog will close and Brooklyn will begin deploying your
+application. Your application will be shown as "Starting" on the web console's front page.
-Open the web console ([127.0.0.1:8081](http://127.0.0.1:8081)). As Brooklyn is not currently managing any applications the 'Create Application' dialog opens automatically. Select the YAML tab.
-
+### Launching from the Catalog
-Copy this document into the large text box on the YAML tab, labelled `Enter CAMP Plan YAML code here`. But *before* you
-submit it, we need to make a modification.
+Instead of pasting the YAML blueprint each time,
+this blueprint can be [added to the catalog](../ops/catalog/).
+Or, even easier, you can download a sample [catalog.xml](catalog.xml).
+Install this to your `~/.brooklyn/` folder and relaunch Brooklyn
+(navigating to the "Help" tab in order to shutdown Brooklyn *and* the application you launched in the previous step).
-{% highlight yaml %}
-{% readj _my-web-cluster.yaml %}
-{% endhighlight %}
+Now when the web console is re-opened, the catalog contains our blueprints.
+Select the "Demo Web Cluster with DB" and click "Next".
-Find the line near the top of the blueprint that starts `location:`. Change the line to name a location. For example,
-one of these lines:
-
-{% highlight yaml %}
-location: aws-ec2:us-east-1
-location: rackspace-cloudservers-us:ORD
-location: google-compute-engine:europe-west1-a
-location: localhost
-{% endhighlight %}
+[](images/add-application-catalog-web-cluster-with-db-large.png)
-**My Web Cluster Blueprint**
+Select the location to use, give your application a name, and then click "Finish".
-With the modified YAML in the dialog, click 'Finish'. The dialog will close and Brooklyn will begin deploying your
-application. Your application will be shown as 'Starting' on the web console's front page.
-### Next
+## Next
-So far we have touched on Brooklyn's ability to *deploy* an application blueprint to a cloud provider, but this a very small part of Brooklyn's capabilities!
+So far we have touched on Brooklyn's ability to *deploy* an application blueprint to a cloud provider,
+but this just the beginning. **[Start managing this application.](managing.html)**
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/start/config.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/config.md b/docs/guide/start/config.md
deleted file mode 100644
index 10895d6..0000000
--- a/docs/guide/start/config.md
+++ /dev/null
@@ -1,52 +0,0 @@
----
-title: Configuring Brooklyn
-title_in_menu: Configuring Brooklyn
-layout: website-normal
-menu_parent: index.md
----
-
-{% include fields.md %}
-
-Brooklyn reads startup configuration from a file `~/.brooklyn/brooklyn.properties`, by default.
-You can create this from a template [brooklyn.properties]({{brooklyn_properties_url_path}}) file which you edit.
-
-## Configuring Security
-
-To configure Brooklyn to run on a public IP address, security should be enabled.
-The simplest way is to define a user and password in `~/.brooklyn/brooklyn.properties`
-(described above):
-
- brooklyn.webconsole.security.users=admin
- brooklyn.webconsole.security.user.admin.password=s3cr3t
-
-Other modes, including LDAP, are described in this file.
-
-The other common setting is to run under https (on port 8443 by default):
-
- brooklyn.webconsole.security.https.required=true
-
-## Configuring a Location
-
-Brooklyn deploys applications to locations. These locations
-can be clouds, machines with fixed IPs or localhost (for testing).
-Their configuration can be specified in `~/.brooklyn/brooklyn.properties` (described above),
-and then these locations can be easily selected within Brooklyn.
-Alternatively this information can be specified in the YAML when applications are deployed,
-without needing to set it in `brooklyn.properties`.
-
-Some sample settings for this are:
-
- brooklyn.location.jclouds.aws-ec2.identity = AKA_YOUR_ACCESS_KEY_ID
- brooklyn.location.jclouds.aws-ec2.credential = <access-key-hex-digits>
- brooklyn.location.named.aws-california = jclouds:aws-ec2:us-west-1
- brooklyn.location.named.aws-california.displayName = AWS US West 1 (CA)
-
- brooklyn.location.jclouds.softlayer.identity = username
- brooklyn.location.jclouds.softlayer.credential = <private-key-hex-digits>
- brooklyn.location.named.softlayer-dal05 = jclouds:softlayer:dal05
- brooklyn.location.named.softlayer-dal05.displayName = Softlayer Dallas
-
-If you want to test Brooklyn on localhost, follow [these instructions]({{site.path.guide}}/ops/locations/)
-to ensure that your Brooklyn can access your machine.
-
-Once updated, restart Brooklyn (or reload the properties within the web GUI).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/start/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/index.md b/docs/guide/start/index.md
index 3bc9f92..41ab28b 100644
--- a/docs/guide/start/index.md
+++ b/docs/guide/start/index.md
@@ -4,7 +4,6 @@ title: Getting Started
menu_parent: ../index.md
children:
- running.md
-- config.md
- blueprints.md
- managing.md
- policies.md
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/start/managing.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/managing.md b/docs/guide/start/managing.md
index b36bcaf..e01edbf 100644
--- a/docs/guide/start/managing.md
+++ b/docs/guide/start/managing.md
@@ -17,24 +17,40 @@ We can explore the management hierarchy of the application, which will show us t
-Clicking on the 'My Web' entity will show the Summary tab. Here we can see if the cluster is ready to serve and, when ready, grab the web address for the front of the loadbalancer.
+Clicking on the "My Web" entity will show the "Summary" tab,
+giving a very high level of what that component is doing.

-The Activity tab allows us to drill down into what activities each entity is currently doing or has recently done. It is possible to drill down to all child tasks, and view the commands issued, and any errors or warnings that occured.
+## Sensors
-Drill into the 'My DB' start operation. Working down through 'Start (processes)', then 'launch', we can discover the ssh command used including the stdin, stdout and stderr.
+Now click on the "Sensors" tab:
+these data feeds drive the real-time picture of the application.
+As you navigate in the tree at the left, you can see more targeted statistics coming in in real-time.
+
+Explore the sensors and the tree to find a URL where the webapp we just deployed is running
+and open that in a new tab. Quickly return to the "Sensors" tab and observe the requests-per-second sensor increase.
+
+
+## Activities
+
+The Activity tab allows us to drill down into the activities each entity is currently doing or has recently done.
+It is possible to drill down to all child tasks, and view the commands issued, and any errors or warnings that occured.
+
+Drill into the "My DB" start operation.
+Working down through "Start (processes)", then "launch", we can discover the ssh command used including the stdin, stdout and stderr.
[](images/my-db-activities-large.png)
## Stopping the Application
-To stop an application, select the application in the tree view (the top/root entity), click on the Effectors tab, and invoke the 'Stop' effector. This will cleanly shutdown all components in the application and return any cloud machines that were being used.
+To stop an application, select the application in the tree view (the top/root entity), click on the Effectors tab, and invoke the "Stop" effector. This will cleanly shutdown all components in the application and return any cloud machines that were being used.
[](images/my-web-cluster-stop-confirm-large.png)
+
### Next
-Brooklyn's real power is in using [Policies](policies.html) to automatically *manage* applications.
+Brooklyn's real power is in using **[Policies](policies.html)** to automatically *manage* applications.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md
index 17e3d934..965272d 100644
--- a/docs/guide/start/running.md
+++ b/docs/guide/start/running.md
@@ -31,65 +31,19 @@ $ tar -zxf brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz
This will create a `brooklyn-{{ site.data.brooklyn.version }}` folder.
-Note: You'll need a Java JRE or SDK installed (version 6 or later), as Brooklyn is Java under the covers.
-
-## Verify SSH
-
-Brooklyn uses SSH extensively and therefore it is worth making sure that you have a known working SSH setup before
-starting.
-
-Please check the following items:
-
-- If you are using Mac OSX, open System Preferences, go to the Sharing item, and enable 'Remote Login'.
-- You have two files named `~/.ssh/id_rsa` and `~/.ssh/id_rsa.pub`.
- - If these files do not exist, they can be created with `ssh-keygen -t rsa -N "" -f ~/.ssh/id_rsa`.
-- `~/.ssh/id_rsa` is NOT readable by any other user.
- - You can verify this with `ls -l ~/.ssh/id_rsa` - the line should start with `-rw-------` or `-r--------`. If it
- does not, execute `chmod 0600 ~/.ssh/id_rsa`.
-- The file `~/.ssh/authorized_keys` exists and contains a copy of your public key from `~/.ssh/id_rsa.pub`.
- - Note that it is normal for it to contain other items as well.
-- The key in `~/.ssh/id_rsa` does *not* have a passphrase.
- - You can test this by executing `ssh-keygen -y`. If it does *not* ask for a passphrase, then your key is OK.
- - If your key does have a passphrase, remove it. You can do this by running `ssh-keygen -p`. Enter the passphrase,
- then when prompted for the new passphrase, hit Enter.
-
-Now verify your setup by running the command: `ssh localhost echo hello world`
-
-If you see a message similar to this:
-
-<pre>
-The authenticity of host 'localhost (::1)' can't be established.
-RSA key fingerprint is 7b:e3:8e:c6:5b:2a:05:a1:7c:8a:cf:d1:6a:83:c2:ad.
-Are you sure you want to continue connecting (yes/no)?
-</pre>
-
-then answer 'yes', and then repeat the command run again.
-
-If the response is `hello world`, with no other output or prompts, then your SSH setup is good and Brooklyn should be
-able to use it without a problem.
-
-If these steps are not working, [these instructions]({{ site.path.guide }}/ops/locations/) may be
-useful.
-
+**Note**: You'll need a Java JRE or SDK installed (version 6 or later), as Brooklyn is Java under the covers.
+**Node #2**: If you want to test Brooklyn on localhost, follow [these instructions]({{site.path.guide}}/ops/locations/#localhost)
+to ensure that your Brooklyn can access your machine.
## Launch Brooklyn
-Let's setup some paths for easy commands.
-
-(Click the clipboard on these code snippets for easier c&p.)
-
-{% highlight bash %}
-$ cd brooklyn-{{ site.data.brooklyn.version }}
-$ BROOKLYN_DIR="$(pwd)"
-$ export PATH=$PATH:$BROOKLYN_DIR/bin/
-{% endhighlight %}
-
-We can do a quick test drive by launching Brooklyn:
+Now start Brooklyn with the following command:
{% highlight bash %}
-$ brooklyn launch
+$ cd brooklyn-{{ site.brooklyn.version }}
+$ bin/brooklyn launch
{% endhighlight %}
Brooklyn will output the address of the management interface:
@@ -99,6 +53,16 @@ INFO Starting brooklyn web-console on loopback interface because no security co
INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and []
</pre>
+
### Next
-Now that Brooklyn is up and running we can look at getting it to manage some applications.
+Next, open the web console on [127.0.0.1:8081](http://127.0.0.1:8081).
+No application shave been deployed yet, so the "Create Application" dialog opens automatically:
+let's remedy this by **[deploying a blueprint](blueprints.html)**.
+
+It is not necessary at this time, but depending on what you are going to do,
+you may wish to set up other configuration options first:
+
+* [Security](../ops/brooklyn_properties.html)
+* [Persistence](../ops/persistence/)
+* [Cloud credentials](../ops/locations/)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/yaml/chef/advanced-chef-integration.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/chef/advanced-chef-integration.md b/docs/guide/yaml/chef/advanced-chef-integration.md
index 18a4ff9..0d65286 100644
--- a/docs/guide/yaml/chef/advanced-chef-integration.md
+++ b/docs/guide/yaml/chef/advanced-chef-integration.md
@@ -30,7 +30,7 @@ indicated earlier. If you'd like to work with us to implement these, please let
A general schema for the supported YAML is below:
-```
+{% highlight yaml %}
- type: chef:cookbook_name
cookbook_urls:
cookbook_name: url://for/cookbook.tgz
@@ -39,7 +39,7 @@ A general schema for the supported YAML is below:
launch_attributes: # map of arguments to set in the chef node
service_name: cookbook_service
pid_file: /var/run/cookbook.pid
-```
+{% endhighlight %}
If you are interested in exploring the Java code for creating blueprints,
start with the `TypedToyMySqlEntiyChef` class, which essentially does what this tutorial has shown;
[08/13] incubator-brooklyn git commit: lots more tidy-up of docs,
esp in ops
Posted by he...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/yaml/configuring-vms.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/configuring-vms.md b/docs/guide/yaml/configuring-vms.md
index 709746c..97fb9d0 100644
--- a/docs/guide/yaml/configuring-vms.md
+++ b/docs/guide/yaml/configuring-vms.md
@@ -28,4 +28,4 @@ including:
* `machineCreateAttempts` (for dodgy clouds, and they nearly all fail occasionally!)
* and things like `imageId` and `userMetadata` and disk and networking options (e.g. `autoAssignFloatingIp` for private clouds)
-For more information, see the javadoc on `JcloudsLocationConfig`.
+For more information, see [Operations: Locations](../ops/locations/).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/yaml/creating-yaml.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/creating-yaml.md b/docs/guide/yaml/creating-yaml.md
index 6141a18..8c6b31f 100644
--- a/docs/guide/yaml/creating-yaml.md
+++ b/docs/guide/yaml/creating-yaml.md
@@ -25,7 +25,7 @@ Here's a very simple YAML blueprint plan, to explain the structure:
* The `name` is just for the benefit of us humans.
* The `location` specifies where this should be deployed.
- If you've [set up passwordless localhost SSH access](setting-locations.html#localhost)
+ If you've [set up passwordless localhost SSH access](../ops/locations/#localhost)
you can use `localhost` as above, but if not, just wait ten seconds for the next example.
* The `services` block takes a list of the typed services we want to deploy.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/yaml/multiple-services.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/multiple-services.md b/docs/guide/yaml/multiple-services.md
index a6816e6..0f443dd 100644
--- a/docs/guide/yaml/multiple-services.md
+++ b/docs/guide/yaml/multiple-services.md
@@ -1,10 +1,44 @@
---
title: Multiple Services and Dependency Injection
layout: website-normal
-toc: ../guide_toc.json
-categories: [use, guide, defining-applications]
---
+We've seen the configuration of machines and how to build up clusters.
+Now let's return to our app-server example and explore how more interesting
+services can be configured, composed, and combined.
+
+
+### Service Configuration
+
+We'll begin by using more key-value pairs to configure the JBoss server to run a real app:
+
+{% highlight yaml %}
+{% readj example_yaml/appserver-configured.yaml %}
+{% endhighlight %}
+
+(As before, you'll need to add the `location` info; `localhost` will work for these and subsequent examples.)
+
+When this is deployed, you can see management information in the Brooklyn Web Console,
+including a link to the deployed application (downloaded to the target machine from the `hello-world` URL),
+running on port 8080.
+
+**Tip**: If port 8080 might be in use, you can specify `8080+` to take the first available port >= 8080;
+the actual port will be reported as a sensor by Brooklyn.
+
+It's also worth indicating an alternate, more formal syntax.
+Not all configuration on entities is supported at the top level of the service specification
+(only those which are defined as "flags" in the underlying blueprint,
+e.g. the `@SetFromFlag("war")` in the `WebAppServiceConstants` parent of `JBoss7Server`).
+All configuration has a formal qualified name, and this can be supplied even where flags or config keys are not
+explicitly defined, by placing it into a `brooklyn.config` section:
+
+{% highlight yaml %}
+{% readj example_yaml/appserver-configured-in-config.yaml %}
+{% endhighlight %}
+
+
+### Multiple Services
+
If you explored the `hello-world-sql` application we just deployed,
you'll have noticed it tries to access a database.
And it fails, because we have not set one up. Let's do that now:
@@ -45,7 +79,6 @@ At that point the URL is injected, first passing it through `formatString`
to include the credentials for the database (which are defined in the database creation script).
-
### An Aside: Substitutability
Don't like JBoss? Is there something about Maria?
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/yaml/mutlitple-services.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/mutlitple-services.md b/docs/guide/yaml/mutlitple-services.md
deleted file mode 100644
index 24f7b1d..0000000
--- a/docs/guide/yaml/mutlitple-services.md
+++ /dev/null
@@ -1,100 +0,0 @@
----
-title: Multiple Services and Dependency Injection
-layout: website-normal
-toc: ../guide_toc.json
-categories: [use, guide, defining-applications]
----
-We've seen the configuration of machines and how to build up clusters.
-Now let's return to our app-server example and explore how more interesting
-services can be configured, composed, and combined.
-
-Also note there are some good overview materials [here]({{site.path.guide}}//use/guide/defining-applications/basic-concepts.html)
-covering clusters, sensors, effectors and more,
-if you're the kind of person who likes to learn more about concepts before seeing them in action.
-
-
-### Service Configuration
-
-We'll begin by using more key-value pairs to configure the JBoss server to run a real app:
-
-{% highlight yaml %}
-{% readj example_yaml/appserver-configured.yaml %}
-{% endhighlight %}
-
-(As before, you'll need to add the `location` info; `localhost` will work for these and subsequent examples.)
-
-When this is deployed, you can see management information in the Brooklyn Web Console,
-including a link to the deployed application (downloaded to the target machine from the `hello-world` URL),
-running on port 8080.
-
-**Top tip**: If port 8080 might be in use, you can specify `8080+` to take the first available port >= 8080;
-the actual port will be reported as a sensor by Brooklyn.
-
-It's also worth indicating an alternate, more formal syntax.
-Not all configuration on entities is supported at the top level of the service specification
-(only those which are defined as "flags" in the underlying blueprint,
-e.g. the `@SetFromFlag("war")` in the `WebAppServiceConstants` parent of `JBoss7Server`).
-All configuration has a formal qualified name, and this can be supplied even where flags or config keys are not
-explicitly defined, by placing it into a `brooklyn.config` section:
-
-{% highlight yaml %}
-{% readj example_yaml/appserver-configured-in-config.yaml %}
-{% endhighlight %}
-
-If you explored the `hello-world-sql` application we just deployed,
-you'll have noticed it tries to access a database.
-And it fails, because we have not set one up. Let's do that now:
-
-{% highlight yaml %}
-{% readj example_yaml/appserver-w-db.yaml %}
-{% endhighlight %}
-
-Here there are a few things going on:
-
-* We've added a second service, which will be the database;
- you'll note the database has been configured to run a custom setup script
-* We've injected the URL of the second service into the appserver as a Java system property
- (so our app knows where to find the database)
-
-**Caution: Be careful if you write your YAML in an editor which attempts to put "smart-quotes" in.
-All quote characters must be plain ASCII, not fancy left-double-quotes and right-double-quotes!**
-
-There are as many ways to do dependency injection as there are developers,
-it sometimes seems; our aim in Brooklyn is not to say this has to be done one way,
-but to support the various mechanisms people might need to do, for whatever reasons.
-(We each have our opinions about what works well, of course;
-the one thing we do want to call out is that being able to dynamically update
-the injection is useful in a modern agile application -- so we are definitively **not**
-recommending this Java system property approach ... but it is an easy one to demo!)
-
-The way the dependency injection works is again by using the `$brooklyn:` DSL,
-this time referring to the `component("db")` (looked up by the `id` field on our DB component),
-and then to a sensor emitted by that component.
-All the database entities emit a `database.url` sensor when they are up and running;
-the `attributeWhenReady` DSL method will store a pointer to that sensor (a Java Future under the covers)
-in the Java system properties map which the JBoss entity reads at launch time, blocking if needed.
-
-This means that the deployment occurs in parallel, and if the database comes up first,
-there is no blocking; but if the JBoss entity completes its installation and
-downloading the WAR, it will wait for the database before it launches.
-At that point the URL is injected, first passing it through `formatString`
-to include the credentials for the database (which are defined in the database creation script).
-
-
-
-### An Aside: Substitutability
-
-Don't like JBoss? Is there something about Maria?
-One of the modular principles we follow in Brooklyn is substitutability:
-in many cases, the config keys, sensors, and effectors are defined
-in superclasses and are portable across multiple implementations.
-
-Here's an example deploying the same application but with different flavors of the components:
-
-{% highlight yaml %}
-{% readj example_yaml/appserver-w-db-other-flavor.yaml %}
-{% endhighlight %}
-
-We've also brought in the `provisioning.properties` from the VM example earlier
-so our database has 8GB RAM.
-Any of those properties, including `imageId` and `user`, can be defined on a per-entity basis.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/guide/yaml/setting-locations.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/setting-locations.md b/docs/guide/yaml/setting-locations.md
index 4924557..7f5dfc4 100644
--- a/docs/guide/yaml/setting-locations.md
+++ b/docs/guide/yaml/setting-locations.md
@@ -32,13 +32,12 @@ depending on the blueprint):
{% readj example_yaml/simple-appserver-with-location-byon.yaml %}
{% endhighlight %}
-You'll also note in this example that we've used JSON-style notation in the second `location` block.
+Note in this example that we've used JSON-style notation in the second `location` block.
YAML supports this, and sometimes that makes more readable plans.
-(Although in this case a simple `location: localhost` is equivalent and even more succinct, but this is a tutorial.)
-
-For more information see the Locations section of the [YAML reference](yaml-reference.html)
-and in the [Operations]({{ site.path.guide }}/ops/locations) section of the User Guide.
-Another good reference is the [template brooklyn.properties]({{ brooklyn_properties_url_path }}),
-which if you install in `~/.brooklyn/brooklyn.properties` and edit with your credentials,
-allows you to refer to clouds simply as `location: jclouds:aws-ec2:eu-west-1` or
-set up "named locations" you can use as `location: named:my_cloudstack`.
+(Although in this case a simple `location: localhost` is equivalent and even more succinct,
+but this is a tutorial.)
+
+For more information see the [Operations: Locations]({{ site.path.guide }}/ops/locations) section of the User Guide.
+This includes support for defining locations externally in a [brooklyn.properties]({{ brooklyn_properties_url_path }}) file,
+after which you can deploy to clouds or bring-your-own-nodes
+simply as `location: jclouds:aws-ec2:eu-west-1` or `location: named:my_cloudstack`.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/style/css/_basic.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_basic.scss b/docs/style/css/_basic.scss
index 2f5a989..ff0f060 100644
--- a/docs/style/css/_basic.scss
+++ b/docs/style/css/_basic.scss
@@ -20,12 +20,6 @@ img {border: 0;}
a {color: $a_color;}
a:hover {text-decoration: none; color: $a_hover_color;}
-/* Offset link anchors so they are not hidden by the header */
-a[id]:empty, a[name]:empty {
- padding-top: 60px;
- margin-top: -60px;
- display: block;
-}
.dropdown-menu > li > a {
font-weight: 300;
}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/style/css/_main_container.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_main_container.scss b/docs/style/css/_main_container.scss
index 09e2634..0ce2fcc 100644
--- a/docs/style/css/_main_container.scss
+++ b/docs/style/css/_main_container.scss
@@ -10,23 +10,29 @@
/* HEADER LINKS
----------------------------------------------------------------------- */
-/* this causes jumps to anchors to show the anchor below the navbar */
-#content_container { h1, h2, h3, h4, h5, h6 {
- margin-top: -64px;
- padding-top: 64px;
-}}
-
#content_container h1 {
max-width: 95%;
font-variant: normal;
margin-top: -16px;
padding-bottom: 6px;
+ margin-top: 64px;
margin-bottom: 24px;
border-bottom: 1px dotted $gray_aa;
font-weight: 300;
font-size: 36px;
text-transform: uppercase;
}
+h4, h5, h6 {
+ margin-top: 20px;
+ margin-bottom: 8px;
+}
+h5 {
+ font-size: 18px;
+ font-weight: 300;
+}
+h6 {
+ font-size: 16px;
+}
/* headings get a tooltip showing the permalink URL, a la github jekyll */
/* install subset of font-awesome */
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/community/index.md
----------------------------------------------------------------------
diff --git a/docs/website/community/index.md b/docs/website/community/index.md
index 6ba4000..29fe46c 100644
--- a/docs/website/community/index.md
+++ b/docs/website/community/index.md
@@ -60,7 +60,7 @@ Find us on `#brooklyncentral` on Freenode, or click below for more information.
<div class="panel panel-default">
<div class="panel-heading" markdown="1">
-#### [Developer community](../developers/index.md)
+#### [Developer community](../developers/)
</div>
<div class="panel-body" markdown="1">
Want to contribute code to our project? Head over to our developer's section. Warning, bleeding edge code ahead!
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/developers/index.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/index.md b/docs/website/developers/index.md
index 2edae18..1d3ac4a 100644
--- a/docs/website/developers/index.md
+++ b/docs/website/developers/index.md
@@ -31,7 +31,7 @@ and are comfortable doing so.
Firstly, please see our [community resources](../community/index.html), in particular:
-- [Mailing lists](../community/mailist-lists.html)
+- [Mailing lists](../community/mailing-lists.html)
- [IRC channel](../community/irc.html)
- [JIRA for bug tracking](https://issues.apache.org/jira/browse/BROOKLYN)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/documentation/index.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/index.md b/docs/website/documentation/index.md
index 13f4d3d..03f96b7 100644
--- a/docs/website/documentation/index.md
+++ b/docs/website/documentation/index.md
@@ -4,13 +4,14 @@ title: Documentation
children:
- /guide/
- /guide/dev/
-- faq.md
- other-docs.md
---
{% comment %}
-This is redundant with versions page. Link to versions page? List more things including other docs?
+TODO This is redundant with versions page. Link to versions page? List more things including other docs?
Basically make this page pretty...
+
+TODO also add FAQ
{% endcomment %}
## Official User Guide
@@ -24,8 +25,10 @@ Our main user manual is organised by release version. Please pick the version th
Please note that this release was made prior to entering the Apache Incubator,
and therefore it is not endorsed by Apache.
-From the links above you can also access the Developer Guide for the relevant versions.
+- [Other versions]({{ site.path.website }}/meta/versions.html)
+
## Other Docs
-Many other mini-docs are available [here](other-docs.html).
+Other mini-docs are available [here](other-docs.html),
+or see the [Learn More]({{ site.path.website }}/learnmore) section of the site.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/documentation/install-on-server.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/install-on-server.md b/docs/website/documentation/install-on-server.md
index aeb44bf..defef7e 100644
--- a/docs/website/documentation/install-on-server.md
+++ b/docs/website/documentation/install-on-server.md
@@ -16,7 +16,9 @@ There is a simple bash script available to help with the installation process.
#### Script prerequisites
The script assumes that the server is a recent *RHEL/CentOS 6.x Linux* or *Ubuntu 12.04* installation, but other Linux variants have been tested successfully.
-The script will install Java 7 and other required packages if they are not present. You must have root access over [passwordless SSH]({{ site.path.website }}/documentation/passwordless-ssh.html) to install brooklyn, but the service runs as an ordinary user once installed.
+The script will install Java 7 and other required packages if they are not present.
+You must have root access over [passwordless SSH]({{ site.path.guide }}/ops/locations/ssh-keys.html)
+to install brooklyn, but the service runs as an ordinary user once installed.
To manage the brooklyn service you must also be able to connect to port 8081 remotely.
@@ -37,18 +39,19 @@ $ ./brooklyn-install.sh -s -r <your-server-ip>
### <a id="prerequisites"></a>Set up the prerequisites
-Before installing Apache Brooklyn, you will need to configure the host as follows.
+Before installing Apache Brooklyn, it is recommented to configure the host as follows.
* install Java JRE or SDK (version 6 or later)
-* install [SSH key]({{ site.path.website }}/documentation//ssh-key.html), if not available.
-* enable [passwordless ssh login]({{ site.path.website }}/documentation/passwordless-ssh.html).
+* install an [SSH key]({{ site.path.guide }}/ops/locations/ssh-keys.html), if not available
+* enable [passwordless ssh login]({{ site.path.guide }}/ops/locations/ssh-keys.html)
* create a `~/.brooklyn` directory on the host with `$ mkdir ~/.brooklyn`
-* Check your iptables service, and if enabled, make sure that it accepts all incoming connections to 8443+ ports.
-* [optional] Increase [linux kernel entropy]({{ site.path.website }}/documentation//increase-entropy.html) for faster ssh connections.
+* check your `iptables` or other firewall service, making sure that incoming connections on port 8443 is not blocked
+* check that the [linux kernel entropy](increase-entropy.html) is sufficient
+
## <a id="download"></a>Download Brooklyn
-Download Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download.html).
+Download Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download/).
{% if brooklyn_version contains 'SNAPSHOT' %}
Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different):
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/documentation/passwordless-ssh.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/passwordless-ssh.md b/docs/website/documentation/passwordless-ssh.md
deleted file mode 100644
index 6cd3e5a..0000000
--- a/docs/website/documentation/passwordless-ssh.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-title: Passwordless SSH login
-layout: website-normal
----
-To enable passwordless SSH login to a *nix server, first you will need a pair of keys. If you don't already have a keypair generated you'll first of all need to create one.
-To generate a new keypair you run the following command:
-
- your-user@host1:~$ ssh-keygen -t rsa
-
-This will prompt you for a location to save the keys, and a pass-phrase:
-
- Generating public/private rsa key pair.
- Enter file in which to save the key (/home/skx/.ssh/id_rsa):
- Enter passphrase (empty for no passphrase):
- Enter same passphrase again:
- Your identification has been saved in /home/skx/.ssh/id_rsa.
- Your public key has been saved in /home/skx/.ssh/id_rsa.pub.
-
-Then, assuming that you want to enable passwordless SSH login to the `host2` server from `host1` with the `id_rsa` and `id_rsa.pub` files you've just generated you should run the following command:
-
- your-user@host1:~$ ssh-copy-id -i ~/.ssh/id_rsa.pub username@host2
-
-If `host1` doesn't have `ssh-copy-id` installed, you can either install `ssh-copy-id` or manually copy the `id_rsa.pub` key to the `host2` by issuing the following commands:
-
- host1# cat ~/.ssh/id_rsa.pub | ssh user@host2 'cat >> .ssh/authorized_keys'
-
-or if you need to make a `.ssh` directory on `host2`
-
- host1#cat ~/.ssh/id_rsa.pub | ssh user@host2 'mkdir .ssh; chmod 700 .ssh; cat >> .ssh/authorized_keys; chmod 644 .ssh/authorized_keys'
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/documentation/ssh-key.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/ssh-key.md b/docs/website/documentation/ssh-key.md
deleted file mode 100644
index 9082af1..0000000
--- a/docs/website/documentation/ssh-key.md
+++ /dev/null
@@ -1,9 +0,0 @@
----
-title: SSH keys
-layout: website-normal
----
-Brooklyn requires an SSH key, which will be used to connect to cloud VMs. By default Brooklyn will look for SSH keys named `~/.ssh/id_rsa` or `~/.ssh/id_dsa`. If you do not already have an SSH key installed, create a new key.
-
-{% highlight bash %}
-$ ssh-keygen -t rsa -N "" -f ~/.ssh/id_rsa
-{% endhighlight %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/documentation/todo.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/todo.md b/docs/website/documentation/todo.md
deleted file mode 100644
index 724cb8c..0000000
--- a/docs/website/documentation/todo.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: TODO
-layout: website-normal
----
-
-TODO
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/learnmore/blueprint-tour.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/blueprint-tour.md b/docs/website/learnmore/blueprint-tour.md
index 04ce5d2..e13fcd8 100644
--- a/docs/website/learnmore/blueprint-tour.md
+++ b/docs/website/learnmore/blueprint-tour.md
@@ -23,7 +23,7 @@ title_in_menu: Blueprint Tour
optionally adding a version and other metadata.
The format is YAML -- a human-friendly extension to JSON --
following the
- <a href="{{ site.path.guide }}/learnmore/theory.html">CAMP</a> standard.
+ <a href="{{ site.path.website }}/learnmore/theory.html#standards">CAMP</a> standard.
</p><p>
Treat it like source code: use comments, version control it, test it with CI.
</p></div>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3add5d21/docs/website/learnmore/theory.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/theory.md b/docs/website/learnmore/theory.md
index 4f0e6a8..eddb2f8 100644
--- a/docs/website/learnmore/theory.md
+++ b/docs/website/learnmore/theory.md
@@ -122,9 +122,8 @@ managing complex software to be codified as part of the software development
process.
-<a id="benefits"></a>
-### 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
[07/13] incubator-brooklyn git commit: fixes requested on #456
Posted by he...@apache.org.
fixes requested on #456
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/a24f148d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/a24f148d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/a24f148d
Branch: refs/heads/master
Commit: a24f148da04ca2258f4c4843b8c021252af08766
Parents: 5cf0666
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Jan 19 23:30:07 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Mon Jan 19 23:30:07 2015 +0000
----------------------------------------------------------------------
docs/guide/ops/catalog/index.md | 97 ++++++++++++++++++++----------------
1 file changed, 54 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/a24f148d/docs/guide/ops/catalog/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/catalog/index.md b/docs/guide/ops/catalog/index.md
index 8b14b65..123cc40 100644
--- a/docs/guide/ops/catalog/index.md
+++ b/docs/guide/ops/catalog/index.md
@@ -1,28 +1,32 @@
---
title: Catalog
layout: website-normal
+children:
+- { section: Catalog Items }
+- { section: Adding to the Catalog, title: Adding and Deleting }
+- { section: Versioning }
+- { section: special-reqs, title: Wizard }
---
-Brooklyn has a 'catalog', which is a collection of versioned blueprints.
+Brooklyn provides a **catalog**, which is a persisted collection of versioned blueprints.
These can be deployed directly or referenced by other blueprints.
Blueprints in the catalog can be deployed via the Brooklyn REST API, or from
-the web-console's 'Catalog' section of the 'Create Application' dialog box.
+the web-console's "Catalog" tab of the "Create Application" wizard dialog box.
<!--
TODO: Clean up confusion in terminology between Catalog item and Blueprint (and Java blueprint?)?
-->
-### Catalog items
+### Catalog Items
-An item to be added to the catalog is defined in YAML. This looks like any other
-YAML blueprint, but also has a `brooklyn.catalog` section giving appropriate metadata.
-
-An example is shown below.
+An item to be added to the catalog is defined in YAML. This follows the syntax of a
+YAML blueprint with an addition `brooklyn.catalog` section giving
+the metadata needed to register the blueprint in the catalog:
{% highlight yaml %}
brooklyn.catalog:
- id: org.example.MySQL
+ id: my-MySQL
version: 1.0
iconUrl: classpath://mysql.png
description: MySql is an open source relational database management system (RDBMS)
@@ -34,55 +38,60 @@ services:
- type: brooklyn.entity.database.mysql.MySqlNode
{% endhighlight %}
-To explain the `brooklyn.catalog` section:
+To explain the `brooklyn.catalog` fields:
-- The `id: MySQL` section specifies a unique ID used by Brooklyn to identify the catalog item.
+- The `id: MySQL` line specifies a unique ID used by Brooklyn to identify the catalog item.
Other blueprints can reference the catalog item using this id.
-- The `version: 1.0` section provides a unique version for the *blueprint*. NOTE: This is *not* the version of the software
-being installed (in this case MySQL).
-- The `iconUrl: classpath://...` is an optional, but recommended, section that allows you to provide the URL of a graphic to be
-displayed in the 'Add Application' dialog alongside the blueprint name. If using a URL of the form `classpath://...`, then
-the image should be on Brooklyn's classpath (e.g. in the `conf` folder of the Brooklyn distro).
-- The `description: ...` section allows you to give a free-format description of the blueprint, which is displayed in the
-'Add Application' dialog.
-
-The `libraries` section references OSGi bundles required for the blueprint. It can be omitted if everything
-required by the blueprint is already on the Brooklyn classpath. The URLs should be to stable OSGi bundles -
-if the bundle at this URL changes then this could impact applications if the Brooklyn server is restarted
-or fails over to a standby node.
+- The `version: 1.0` line provides a unique version for the *blueprint*.
+ Note that this is typically *not* the version of the software being installed (in this case MySQL).
+- The `iconUrl: classpath://...` is an optional line where an icon can be specified
+ for use with the item (in the "Add Application" dialog and elsewhere).
+ Note that `classpath` URLs *cannot* refer to items in the OSGi bundle
+ (to prevent requiring all OSGi bundles to be loaded at launch);
+ use the server supplying the OSGi bundles or the `conf` folder of the Brooklyn distro instead.
+- The `description: ...` line, also optional, allows supplying a free-format description of the blueprint.
-To reference a catalog item in another blueprint, simply use its id and optionally its version number.
+The `libraries` section references OSGi bundles required for the blueprint. It can be omitted if everything
+required by the blueprint is already on the Brooklyn classpath.
+These URL's should be to stable OSGi bundles;
+if the contents at any of these URLs changes, the behaviour of the blueprint may change
+whenever a bundle is reloaded in a Brooklyn server,
+and if entities have been deployed against that version, their behavior may change in subtle or potentially incompatible ways.
+To avoid this situation, it is highly recommended to use OSGi version stamps as part of the URL.
+
+To reference a catalog item in another blueprint, simply reference its ID and optionally its version number.
For example:
{% highlight yaml %}
services:
-- type: org.example.MySQL:1.0
+- type: my-MySQL:1.0
{% endhighlight %}
### Adding to the Catalog
-To add a catalog item to the catalog, post the YAML file to Brooklyn's REST API by using the `curl` command as
-follows (substituting your own usename:password, URL and file path):
+To add a catalog item to the catalog, `POST` the YAML file to `/v1/catalog` endpoint in
+Brooklyn's REST API.
+To do this using `curl`:
{% highlight bash %}
-curl -u admin:password http://127.0.0.1:8081/v1/catalog --data-binary @/path/to/mysql-catalog.yaml
+curl http://127.0.0.1:8081/v1/catalog --data-binary @/path/to/mysql-catalog.yaml
{% endhighlight %}
### Deleting from the Catalog
-You can delete a versioned item from the catalog using the REST API. For example, to delete
-the item with id `org.example.MySQL` and version `1.0`:
+You can delete a versioned item from the catalog using the same endpoint at the REST API.
+For example, to delete the item with id `my-MySQL` and version `1.0` with `curl`:
{% highlight bash %}
-curl -u admin:password -X DELETE http://127.0.0.1:8081/v1/catalog/entities/MySQL/1.0
+curl -X DELETE http://127.0.0.1:8081/v1/catalog/entities/MySQL/1.0
{% endhighlight %}
-**Note** Catalog items should not be deleted if there are running apps which were created using the same item. During
-rebinding the catalog item is used to reconstruct the entity.
+**Note:** Catalog items should not be deleted if there are running apps which were created using the same item.
+During rebinding the catalog item is used to reconstruct the entity.
### Versioning
@@ -90,19 +99,21 @@ rebinding the catalog item is used to reconstruct the entity.
Version numbers follow the OSGi convention. This can have a major, minor, micro and qualifier part.
For example, `1.0`. `1.0.1` or `1.0.1-20150101`.
-If you attempt to deploy the same version of a catalog item a second time, you will receive an
-error stating `Updating existing catalog entries is forbidden`.
-To update the blueprint, you will need to change the version number in your yaml file and then
-POST the new YAML file.
+The combination of `id:version` strings must be unique across the catalog.
+It is an error to deploy the same version of an existing item:
+to update a blueprint, it is recommended to increase its version number;
+alternatively in some cases it is permitted to delete an `id:version` instance
+and then re-deploy.
+If no version is specified, re-deploying will automatically
+increment an internal version number for the catalog item.
-An exception to this rule is when no version is specified. Re-deploying will automatically
-increment an internal version number for that catalog item.
+When referencing a blueprint, if a version number is not specified
+the latest non-snapshot version will be loaded when an entity is instantiated.
-When referencing a blueprint, if a version number is not specified then the latest version will
-be used when the application is deployed.
+<a id="special-reqs"/>
-### Special requirements for 'Create Application' dialog
+### Special Requirements for the "Create Application" Wizard Dialog
For a blueprint in the catalog to be accessible via the 'Create Application' dialog, it must be an Application
(i.e. the entity at the root of the blueprint must implement `brooklyn.entity.Application`).
@@ -115,7 +126,7 @@ the `MySqlNode` is added as a child of the `BasicApplication`.
{% highlight yaml %}
brooklyn.catalog:
- id: org.example.MySQL
+ id: my-MySQL
version: 1.0
iconUrl: classpath://mysql.png
description: MySql is an open source relational database management system (RDBMS)
@@ -127,7 +138,7 @@ services:
- type: brooklyn.entity.database.mysql.MySqlNode
{% endhighlight %}
-When added to the catalog via the HTTP POST command, the blueprint will appear in the 'Create Application' dialog
+When added to the catalog via the HTTP `POST` command, the blueprint will appear in the 'Create Application' dialog
as shown here:
[](mysql-in-catalog.png)
[11/13] incubator-brooklyn git commit: fix margin for headers on
community page, and feature list now styled the same
Posted by he...@apache.org.
fix margin for headers on community page, and feature list now styled the same
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/e3b40c43
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/e3b40c43
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/e3b40c43
Branch: refs/heads/master
Commit: e3b40c43725574b67b80b7408c7e380905fc682b
Parents: 48c6326
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Jan 20 15:16:13 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Jan 20 15:16:13 2015 +0000
----------------------------------------------------------------------
docs/style/css/_basic.scss | 2 ++
docs/style/css/_feature_list.scss | 24 +++++++++++++++---------
2 files changed, 17 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e3b40c43/docs/style/css/_basic.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_basic.scss b/docs/style/css/_basic.scss
index ff0f060..05fe469 100644
--- a/docs/style/css/_basic.scss
+++ b/docs/style/css/_basic.scss
@@ -34,6 +34,8 @@ a:hover {text-decoration: none; color: $a_hover_color;}
h4 {
padding-bottom: 0px;
margin-bottom: 0px;
+ padding-top: 8px;
+ margin-top: 0px;
}
}
.panel-body {
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e3b40c43/docs/style/css/_feature_list.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/_feature_list.scss b/docs/style/css/_feature_list.scss
index f21dc2a..32d3913 100644
--- a/docs/style/css/_feature_list.scss
+++ b/docs/style/css/_feature_list.scss
@@ -1,13 +1,19 @@
#content_container .feature-list {
h3 {
- border: 1px solid $gray_aa;
+ border: 1px solid $white_dd;
margin-top: 48px;
- padding: 16px 8px 12px 8px;
+ padding: 20px 12px 12px 12px;
margin-bottom: 0;
- background-color: $white_ee;
- border-top-right-radius: 8px;
- border-top-left-radius: 8px;
+ background-color: $white_f5;
+ border-top-right-radius: 5px;
+ border-top-left-radius: 5px;
+
+// from bootstrap for panel
+background-image: -webkit-linear-gradient(top, #f5f5f5 0%, #e8e8e8 100%);
+background-image: linear-gradient(to bottom, #f5f5f5 0%, #e8e8e8 100%);
+filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff5f5f5', endColorstr='#ffe8e8e8', GradientType=0);
+background-repeat: repeat-x;
}
}
@@ -24,7 +30,7 @@
}
img {
max-width: 200px;
- border: 1px solid #aaa;
+ border: 1px solid $white_dd;
border-radius: 2px;
}
div.feature-title {
@@ -43,12 +49,12 @@
}
- border: 1px solid $gray_aa;
+ border: 1px solid $white_dd;
margin-top: -1px;
margin-bottom: 0;
font-size: 90%;
- padding: 8px;
- padding-bottom: 12px;
+ padding: 12px;
+ padding-top: 8px;
background-color: $white_fa;
}