Repository: incubator-brooklyn Updated Branches: refs/heads/master d8ce6cf2a -> 80bf72873
Add a "quick overview of concepts" page to Getting Started. Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/477da362 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/477da362 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/477da362 Branch: refs/heads/master Commit: 477da362760eca04ad78e8e59971b31581e95118 Parents: 388668a Author: Geoff Macartney <[email protected]> Authored: Mon Oct 19 16:36:03 2015 +0100 Committer: Geoff Macartney <[email protected]> Committed: Mon Oct 19 16:36:03 2015 +0100 ---------------------------------------------------------------------- docs/guide/concepts/execution.md | 2 +- docs/guide/java/policies.md | 2 +- docs/guide/start/concept-quickstart.md | 35 +++++++++++++++++++++++++++++ docs/guide/start/index.md | 1 + docs/website/index.md | 4 ++-- 5 files changed, 40 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/477da362/docs/guide/concepts/execution.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/execution.md b/docs/guide/concepts/execution.md index 7b81fd0..9762005 100644 --- a/docs/guide/concepts/execution.md +++ b/docs/guide/concepts/execution.md @@ -10,7 +10,7 @@ All processing, whether an effector invocation or a policy cycle, are tracked as hierarchical causal chain even when operations are run in parallel * processing can be managed across multiple management nodes -Some executions create new entities, which can then have tasks associated with them, and the system will record, for example, that a start efector on the new entity is a task associated with that entity, with that task +Some executions create new entities, which can then have tasks associated with them, and the system will record, for example, that a start effector on the new entity is a task associated with that entity, with that task created by a task associated with a different entity. The execution of a typical overall start-up sequence is shown below: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/477da362/docs/guide/java/policies.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/policies.md b/docs/guide/java/policies.md index aee2766..4eb50fb 100644 --- a/docs/guide/java/policies.md +++ b/docs/guide/java/policies.md @@ -16,7 +16,7 @@ When a policy runs it can: * perform calculations, * look up other values, -* invoke efectors (management policies) or, +* invoke effectors (management policies) or, * cause the entity associated with the policy to emit sensor values (enricher policies). Entities can have zero or more ``Policy`` instances attached to them. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/477da362/docs/guide/start/concept-quickstart.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/concept-quickstart.md b/docs/guide/start/concept-quickstart.md new file mode 100644 index 0000000..5ef6477 --- /dev/null +++ b/docs/guide/start/concept-quickstart.md @@ -0,0 +1,35 @@ +--- +title: Brooklyn Concepts Quickstart +layout: website-normal +menu_parent: index.md +--- + +The following section gives a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For later investigation of these concepts see [The Theory Behind Brookln]({{site.path.website}}/learnmore/theory.html), and the detailed description in [Brooklyn Concepts]({{site.path.guide}}/concepts/). + +Having examined the concepts below, get started by **[installing and launching](running.html)** Brooklyn. + + +***Deployment and Management*** Brooklyn is built for agile deployment of applications across cloud and other targets, and real-time autonomic management. "Autonomics" is the concept of components looking after themselves where possible (self-healing, self-optimizing, etc). + +***Blueprints*** A blueprint defines an application by specifying its components, such as processes, or combinations of processes across multiple machines and services. The blueprint also specifies the inter-relationships between the configurations of the components. + +***Entities*** The central concept in a Brooklyn deployment is that of an entity. An entity represents a resource under management (individual machines or software processes) or logical collections of these. Entities are arranged hierarchically. They can have events, operations, and processing logic associated with them, and it is through this mechanism that the active management is delivered. + +***Applications*** are the top level entities that are the parents of all other entities. + +***Configuration*** Entities can have arbitrary configuration values, which get inherited by their child entities. You can set global (Brooklyn-wide) properties in (``~/.brooklyn/brooklyn.properties``). Common configuration keys have convenient aliases called "flags". + +***Sensors*** are the mechanism for entities to expose information for other entities to see. Sensors from an entity can be subscribed to by other entities to track changes in the entityâs activity. + +***Effectors*** are the mechanism for entities to expose the operations that can be invoked on it by other entities. The invoker is able to track the execution of that effector. + + +***Lifecycle*** The management context of Brooklyn associates a "lifecycle" with Brooklyn entities. Common operations are start, stop, and restart (whose meaning differs slightly for applications and processes; the details are in the concepts guide linked above). Starting an application results in the start() operation being performed recursively (typically in parallel) on the application's children. + +***Tasks*** Lifecycle and other operations in Brooklyn are tracked as tasks. This allows current and past processing to be observed by operators, and processing to be managed across multiple management nodes. + + +***Locations*** can be defined in order to specify where the processes of an application will run. Brooklyn supports different cloud providers and pre-prepared machines, known as "BYON" (Bring Your Own Nodes). + +***Policies*** Policies perform the active management enabled by Brooklyn. Entities can have Policy instances attached to them, which can subscribe to sensors from other entities or run periodically. When they run they can perform calculations, look up other values, invoke effectors or emit sensor values from the entity with which they are associated. + http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/477da362/docs/guide/start/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/index.md b/docs/guide/start/index.md index 41ab28b..12e56b0 100644 --- a/docs/guide/start/index.md +++ b/docs/guide/start/index.md @@ -3,6 +3,7 @@ layout: website-normal title: Getting Started menu_parent: ../index.md children: +- concept-quickstart.md - running.md - blueprints.md - managing.md http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/477da362/docs/website/index.md ---------------------------------------------------------------------- diff --git a/docs/website/index.md b/docs/website/index.md index f3843d6..374a6e9 100644 --- a/docs/website/index.md +++ b/docs/website/index.md @@ -5,7 +5,7 @@ landing: true children: - learnmore/ - { path: download/, menu: null } -- { path: /guide/start/running.md, title: Get Started } +- { path: /guide/start/concept-quickstart.md, title: Get Started } - path: documentation/ menu: - { path: /guide/index.md, title_in_menu: "User Guide", @@ -70,7 +70,7 @@ View and modify using the *web console* or automate using the *REST API* <div style="text-align: center" markdown="1"> <a class="btn btn-primary btn-lg" role="button" href="learnmore/">learn more</a> -<a class="btn btn-primary btn-lg" role="button" href="{{ site.path.guide }}/start/running.html">get started</a> +<a class="btn btn-primary btn-lg" role="button" href="{{ site.path.guide }}/start/concept-quickstart.html">get started</a> </div>
