You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by tb...@apache.org on 2018/02/16 10:26:50 UTC
[11/25] brooklyn-docs git commit: Delete all the guide files
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/entity-configuration.md
----------------------------------------------------------------------
diff --git a/guide/blueprints/entity-configuration.md b/guide/blueprints/entity-configuration.md
deleted file mode 100644
index 25827ad..0000000
--- a/guide/blueprints/entity-configuration.md
+++ /dev/null
@@ -1,548 +0,0 @@
----
-title: Entity Configuration
-layout: website-normal
-toc: ../guide_toc.json
-categories: [use, guide, defining-applications]
----
-
-Within a blueprint or catalog item, entities can be configured. The rules for setting this
-configuration, including when composing and extending existing entities, is described in this
-section.
-
-
-### Basic Configuration
-
-Within a YAML file, entity configuration should be supplied within a `brooklyn.config` map. It is
-also possible to supply configuration at the top-level of the entity. However, that approach is
-discouraged as it can sometimes be ambiguous (e.g. if the config key is called "name" or "type"),
-and also it does not work in all contexts such as for an enricher's configuration.
-
-A simple example is shown below:
-
-{% highlight yaml %}
-services:
-- type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
- brooklyn.config:
- webapp.enabledProtocols: http
- http.port: 9080
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-webapp/0.9.0/brooklyn-example-hello-world-webapp-0.9.0.war
-{% endhighlight %}
-
-If no config value is supplied, the default for that config key will be used. For example,
-`http.port` would default to 8080 if not explicitly supplied.
-
-Some config keys also have a short-form (e.g. `httpPort` instead of `http.port` would also work
-in the YAML example above). However, that approach is discouraged as it does not work in all contexts
-such as for inheriting configuration from a parent entity.
-
-
-### Configuration in a Catalog Item
-
-When defining an entity in the catalog, it can include configuration values like any other
-blueprint (i.e. inside the `brooklyn.config` block).
-
-It can also explicitly declare config keys, using the `brooklyn.parameters` block. The example
-below illustrates the principle:
-
-{% highlight yaml %}
-brooklyn.catalog:
- items:
- - id: entity-config-example
- itemType: entity
- name: Entity Config Example
- item:
- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- brooklyn.parameters:
- - name: custom.message
- type: string
- description: Message to be displayed
- default: Hello
- brooklyn.config:
- shell.env:
- MESSAGE: $brooklyn:config("custom.message")
- launch.command: |
- echo "My example launch command: $MESSAGE"
- checkRunning.command: |
- echo "My example checkRunning command: $MESSAGE"
-{% endhighlight %}
-
-Once added to the catalog, it can be used with the simple blueprint below (substituting the location
-of your choice). Because no configuration has been overridden, this will use the default value
-for `custom.message`, and will use the given values for `launch.command` and `checkRunning.command`:
-
-{% highlight yaml %}
-location: aws-ec2:us-east-1
-services:
-- type: entity-config-example
-{% endhighlight %}
-
-For details of how to write and add catalog items, see [Catalog]({{ site.path.guide }}/blueprints/catalog/).
-
-
-#### Config Key Constraints
-
-The config keys in the `brooklyn.parameters` can also have constraints defined, for what values
-are valid. If more than one constraint is defined, then they must all be satisfied. The constraints
-can be any of:
-
-* `required`: deployment will fail if no value is supplied for this config key.
-* `regex: ...`: the value will be compared against the given regular expression.
-* A predicate, declared using the DSL `$brooklyn:object`.
-
-This is illustrated in the example below:
-
-{% highlight yaml %}
-brooklyn.catalog:
- items:
- - id: entity-constraint-example
- itemType: entity
- name: Entity Config Example
- item:
- type: org.apache.brooklyn.entity.stock.BasicEntity
- brooklyn.parameters:
- - name: compulsoryExample
- type: string
- constraints:
- - required
- - name: addressExample
- type: string
- constraints:
- - regex: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
- - name: numberExample
- type: double
- constraints:
- - $brooklyn:object:
- type: org.apache.brooklyn.util.math.MathPredicates
- factoryMethod.name: greaterThan
- factoryMethod.args:
- - 0.0
- - $brooklyn:object:
- type: org.apache.brooklyn.util.math.MathPredicates
- factoryMethod.name: lessThan
- factoryMethod.args:
- - 256.0
-{% endhighlight %}
-
-An example usage of this toy example, once added to the catalog, is shown below:
-
-{% highlight yaml %}
-services:
-- type: entity-constraint-example
- brooklyn.config:
- compulsoryExample: foo
- addressExample: 1.1.1.1
- numberExample: 2.0
-{% endhighlight %}
-
-
-### Inheriting Configuration
-
-Configuration can be inherited from a super-type, and from a parent entity in the runtime
-management hierarchy. This applies to entities and locations. In a future release, this will be
-extended to also apply to policies and enrichers.
-
-When a blueprint author defines a config key, they can explicitly specify the rules for inheritance
-(both for super/sub-types, and for the runtime management hiearchy). This gives great flexibilty,
-but should be used with care so as not to surprise users of the blueprint.
-
-The default behaviour is outlined below, along with examples and details of how to explilcitly
-define the desired behaviour.
-
-
-#### Normal Configuration Precedence
-
-There are several places that a configuration value can come from. If different values are
-specified in multiple places, then the order of precedence is as listed below:
-
-1. Configuration on the entity itself
-2. Inherited configuration from the super-type
-3. Inherited configuration from the runtime type hierarchy
-4. The config key's default value
-
-
-#### Inheriting Configuration from Super-type
-
-When using an entity from the catalog, its configuration values can be overridden. For example,
-consider the `entity-config-example` added to the catalog in the section
-[Configuration in a Catalog Item](#configuration-in-a-catalog-item).
-We can override these values. If not overridden, then the existing values from the super-type will be used:
-
-{% highlight yaml %}
-location: aws-ec2:us-east-1
-services:
-- type: entity-config-example
- brooklyn.config:
- custom.message: Goodbye
- launch.command: |
- echo "Sub-type launch command: $MESSAGE"
-{% endhighlight %}
-
-
-
-In this example, the `custom.message` overrides the default defined on the config key.
-The `launch.command` overrides the original command. The other config (e.g. `checkRunning.command`)
-is inherited unchanged.
-
-It will write out: `Sub-type launch command: Goodbye`.
-
-
-#### Inheriting Configuration from a Parent in the Runtime Management Hieararchy
-
-Configuration passed to an entity is inherited by all child entities, unless explicitly overridden.
-
-In the example below, the `wars.root` config key is inherited by all TomcatServer entities created
-under the cluster, so they will use that war:
-
-{% highlight yaml %}
-services:
-- type: org.apache.brooklyn.entity.group.DynamicCluster
- brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-webapp/0.9.0/brooklyn-example-hello-world-webapp-0.9.0.war
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
-{% endhighlight %}
-
-In the above example, it would be better to have specified the `wars.root` configuration in the
-`TomcatServer` entity spec, rather than at the top level. This would make it clearer for the reader
-what is actually being configured.
-
-The technique of inherited config can simplify some blueprints, but care should be taken.
-For more complex (composite) blueprints, this can be difficult to use safely; it relies on
-knowledge of the internals of the child components. For example, the inherited config
-may impact multiple sub-components, rather than just the specific entity to be changed.
-This is particularly true when using complex items from the catalog, and when using common config
-values (e.g. `install.version`).
-
-An alternative approach is to declare the expected configuration options at the top level of the
-catalog item, and then (within the catalog item) explicitly inject those values into the correct
-sub-components. Users of this catalog item would set only those exposed config options, rather
-than trying to inject config directly into the nested entities.
-
-
-#### DSL Evaluation of Inherited Config
-
-When writing blueprints that rely on inheritance from the runtime management hierarchy, it is
-important to understand how config keys that use DSL will be evaluated. In particular, when
-evaluating a DSL expression, it will be done in the context of the entity declaring the config
-value (rather than on the entity using the config value).
-
-For example, consider the config value `$brooklyn:attributeWhenReady("host.name")`
-declared on entity X, and inherited by child entity Y. If entity Y uses this config value,
-it will get the "host.name" attribute of entity X.
-
-Below is another (contrived!) example of this DSL evaluation. When evaluating `refExampleConfig`,
-it retrievies the value of `exampleConfig` which is the DSL expression, and evaluates this in the
-context of the parent entity that declares it. Therefore `$brooklyn:config("ownConfig")` returns
-the parent's `ownConfig` value, and the final result for `refExampleConfig` is set to "parentValue":
-
-{% highlight yaml %}
-services:
-- type: org.apache.brooklyn.entity.stock.BasicApplication
- brooklyn.config:
- ownConfig: parentValue
- exampleConfig: $brooklyn:config("ownConfig")
-
- brooklyn.children:
- - type: org.apache.brooklyn.entity.stock.BasicEntity
- brooklyn.config:
- ownConfig: childValue
- refExampleConfig: $brooklyn:config("exampleConfig")
-{% endhighlight %}
-
-_However, the web-console also shows other misleading (incorrect!) config values for the child
-entity. It shows the inherited config value of `exampleConfig` as "childValue" (because the
-REST api did not evaluate the DSL in the correct context, when retrieving the value!
-See https://issues.apache.org/jira/browse/BROOKLYN-455._
-
-
-#### Merging Configuration Values
-
-For some configuration values, the most logical behaviour is to merge the configuration value
-with that in the super-type. This depends on the type and meaning of the config key, and is thus
-an option when defining the config key.
-
-Currently it is only supported for merging config keys of type Map.
-
-Some common config keys will default to merging the values from the super-type. These config keys
-include those below. The value is merged with that of its super-type (but will not be merged with
-the value on a parent entity):
-
-* `shell.env`: a map of environment variables to pass to the runtime shell
-* `files.preinstall`: a mapping of files, to be copied before install, to destination name relative to installDir
-* `templates.preinstall`: a mapping of templates, to be filled in and copied before pre-install, to destination name relative to installDir
-* `files.install`: a mapping of files, to be copied before install, to destination name relative to installDir
-* `templates.install`: a mapping of templates, to be filled in and copied before install, to destination name relative to installDir
-* `files.runtime`: a mapping of files, to be copied before customisation, to destination name relative to runDir
-* `templates.runtime`: a mapping of templates, to be filled in and copied before customisation, to destination name relative to runDir
-* `provisioning.properties`: custom properties to be passed in when provisioning a new machine
-
-A simple example of merging `shell.env` is shown below (building on the `entity-config-example` in
-the section [Configuration in a Catalog Item](#configuration-in-a-catalog-item)).
-The environment variables will include the `MESSAGE`
-set in the super-type and the `MESSAGE2` set here:
-
-{% highlight yaml %}
-location: aws-ec2:us-east-1
-services:
-- type: entity-config-example
- brooklyn.config:
- shell.env:
- MESSAGE2: Goodbye
- launch.command: |
- echo "Different example launch command: $MESSAGE and $MESSAGE2"
-{% endhighlight %}
-
-To explicitly remove a value from the super-type's map (rather than adding to it), a blank entry
-can be defined.
-
-
-#### Entity provisioning.properties: Overriding and Merging
-
-An entity (which extends `SoftwareProcess`) can define a map of `provisioning.properties`. If
-the entity then provisions a location, it passes this map of properties to the location for
-obtaining the machine. These properties will override and augment the configuration on the location
-itself.
-
-When deploying to a jclouds location, one can specify `templateOptions` (of type map). Rather than
-overriding, these will be merged with any templateOptions defined on the location.
-
-In the example below, the VM will be provisioned with minimum 2G ram and minimum 2 cores. It will
-also use the merged template options value of
-`{placementGroup: myPlacementGroup, securityGroupIds: sg-000c3a6a}`:
-
-{% highlight yaml %}
-location:
- aws-ec2:us-east-1:
- minRam: 2G
- templateOptions:
- placementGroup: myPlacementGroup
-services:
-- type: org.apache.brooklyn.entity.machine.MachineEntity
- brooklyn.config:
- provisioning.properties:
- minCores: 2
- templateOptions:
- securityGroupIds: sg-000c3a6a
-{% endhighlight %}
-
-The merging of `templateOptions` is shallow (i.e. maps within the `templateOptions` are not merged).
-In the example below, the `userMetadata` value within `templateOptions` will be overridden by the
-entity's value, rather than the maps being merged; the value used when provisioning will be
-`{key2: val2}`:
-
-{% highlight yaml %}
-location:
- aws-ec2:us-east-1:
- templateOptions:
- userMetadata:
- key1: val1
-services:
-- type: org.apache.brooklyn.entity.machine.MachineEntity
- brooklyn.config:
- provisioning.properties:
- userMetadata:
- key2: val2
-{% endhighlight %}
-
-
-#### Re-inherited Versus not Re-inherited
-
-For some configuration values, the most logical behaviour is for an entity to "consume" the config
-key's value, and thus not pass it down to children in the runtime type hierarchy. This is called
-"not re-inherited".
-
-Some common config keys that will not re-inherited include:
-
-* `install.command` (and the `pre.install.command` and `post.install.command`)
-* `customize.command` (and the `pre.customize.command` and `post.customize.command`)
-* `launch.command` (and the ``pre.launch.command` and `post.launch.command`)
-* `checkRunning.command`
-* `stop.command`
-* The similar commands for `VanillaWindowsProcess` powershell.
-* The file and template install config keys (e.g. `files.preinstall`, `templates.preinstall`, etc)
-
-An example is shown below. Here, the "logstash-child" is a sub-type of `VanillaSoftwareProcess`,
-and is co-located on the same VM as Tomcat. We don't want the Tomcat's configuration, such as
-`install.command`, to be inherited by the logstash child. If it was inherited, the logstash-child
-entity might re-execute the Tomcat's install command! Instead, the `install.command` config is
-"consumed" by the Tomcat instance and is not re-inherited:
-
-{% highlight yaml %}
-services:
-- type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
- brooklyn.config:
- children.startable.mode: background_late
- brooklyn.children:
- - type: logstash-child
- brooklyn.config:
- logstash.elasticsearch.host: $brooklyn:entity("es").attributeWhenReady("urls.http.withBrackets")
-...
-{% endhighlight %}
-
-"Not re-inherited" differs from "never inherited". The example below illustrates the difference,
-though this use is discouraged (it is mostly for backwards compatibility). The `post.install.command`
-is not consumed by the `BasicApplication`, so will be inherited by the `Tomcat8Server` which will
-consume it. The config value will therefore not be inherited by the `logstash-child`.
-
-{% highlight yaml %}
-services:
-- type: org.apache.brooklyn.entity.stock.BasicApplication
- brooklyn.config:
- post.install.command: echo "My post.install command"
- brooklyn.children:
- - type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
- brooklyn.config:
- children.startable.mode: background_late
- brooklyn.children:
- - type: logstash-child
- brooklyn.config:
- logstash.elasticsearch.host: $brooklyn:entity("es").attributeWhenReady("urls.http.withBrackets")
-...
-{% endhighlight %}
-
-
-#### Never Inherited
-
-For some configuration values, the most logical behaviour is for the value to never be inherited
-in the runtime management hiearchy.
-
-Some common config keys that will never inherited include:
-
-* `defaultDisplayName`: this is the name to use for the entity, if an explicit name is not supplied.
- This is particularly useful when adding an entity in a catalog item (so if the user does not give
- a name, it will get a sensible default). It would not be intuitive for all the children of that
- entity to also get that default name.
-
-* `id`: the id of an entity (as supplied in the YAML, to allow references to that entity) is not
- inherited. It is the id of that specific entity, so must not be shared by all its children.
-
-
-#### Inheritance Modes: Deep Dive
-
-The javadoc in the code is useful for anyone who wants to go deep! See
-`org.apache.brooklyn.config.BasicConfigInheritance` and `org.apache.brooklyn.config.ConfigInheritances`
-in the repo https://github.com/apache/brooklyn-server.
-
-When defining a new config key, the exact semantics for inheritance can be defined. There are
-separate options to control config inheritance from the super-type, and config inheritance from the
-parent in the runtime management hierarchy.
-
-The possible modes are:
-
-* `NEVER_INHERITED`: indicates that a key's value should never be inherited (even if defined on
- an entity that does not know the key). Most usages will prefer `NOT_REINHERITED`.
-
-* `NOT_REINHERITED`: indicates that a config key value (if used) should not be passed down to
- children / sub-types. Unlike `NEVER_INHERITED`, these values can be passed down if they are not
- used by the entity (i.e. if the entity does not expect it). However, when used by a child,
- it will not be passed down any further. If the inheritor also defines a value the parent's
- value is ignored irrespective (as in `OVERWRITE`; see `NOT_REINHERITED_ELSE_DEEP_MERGE` if merging
- is desired).
-
-* `NOT_REINHERITED_ELSE_DEEP_MERGE`: as `NOT_REINHERITED` but in cases where a value is inherited
- because a parent did not recognize it, if the inheritor also defines a value the two values should
- be merged.
-
-* `OVERWRITE`: indicates that if a key has a value at both an ancestor and a descendant, the
- descendant and his descendants will prefer the value at the descendant.
-
-* `DEEP_MERGE`: indicates that if a key has a value at both an ancestor and a descendant, the
- descendant and his descendants should attempt to merge the values. If the values are not mergable,
- behaviour is undefined (and often the descendant's value will simply overwrite).
-
-
-#### Explicit Inheritance Modes
-
-_The YAML support for explicitly defining the inheritance mode is still work-in-progress. The options
-documented below will be enhanced in a future version of Brooklyn, to better support the modes described
-above._
-
-In a YAML blueprint, within the `brooklyn.parameters` section for declaring new config keys, one can
-set the mode for `inheritance.type` and `inheritance.parent` (i.e. for inheritance from the super-type, and
-inheritance in the runtime management hierarchy). The possible values are:
-
-* `deep_merge`: the inherited and the given value should be merged; maps within the map will also be merged
-* `always`: the inherited value should be used, unless explicitly overridden by the entity
-* `none`: the value should not be inherited; if there is no explicit value on the entity then the default value will be used
-
-Below is a (contrived!) example of inheriting the `example.map` config key. When using this entity
-in a blueprint, the entity's config will be merged with that defined in the super-type, and the
-parent entity's value will never be inherited:
-
-{% highlight yaml %}
-brooklyn.catalog:
- items:
- - id: entity-config-inheritance-example
- version: "1.1.0-SNAPSHOT"
- itemType: entity
- name: Entity Config Inheritance Example
- item:
- type: org.apache.brooklyn.entity.machine.MachineEntity
- brooklyn.parameters:
- - name: example.map
- type: java.util.Map
- inheritance.type: deep_merge
- inheritance.parent: none
- default:
- MESSAGE_IN_DEFAULT: InDefault
- brooklyn.config:
- example.map:
- MESSAGE: Hello
-{% endhighlight %}
-
-The blueprints below demonstrate the various permutations for setting configuration for the
-config `example.map`. This can be inspected by looking at the entity's config. The config
-we see for app1 is the inherited `{MESSAGE: "Hello"}`; in app2 we define additional configuration,
-which will be merged to give `{MESSAGE: "Hello", MESSAGE_IN_CHILD: "InChild"}`; in app3, the
-config from the parent is not inherited because there is an explicit inheritance.parent of "none",
-so it just has the value `{MESSAGE: "Hello"}`; in app4 again the parent's config is ignored,
-with the super-type and entity's config being merged to give `{MESSAGE: "Hello", MESSAGE_IN_CHILD: "InChild"}`.
-
-{% highlight yaml %}
-location: aws-ec2:us-east-1
-services:
-- type: org.apache.brooklyn.entity.stock.BasicApplication
- name: app1
- brooklyn.children:
- - type: entity-config-inheritance-example
-
-- type: org.apache.brooklyn.entity.stock.BasicApplication
- name: app2
- brooklyn.children:
- - type: entity-config-inheritance-example
- brooklyn.config:
- example.map:
- MESSAGE_IN_CHILD: InChild
-
-- type: org.apache.brooklyn.entity.stock.BasicApplication
- name: app3
- brooklyn.config:
- example.map:
- MESSAGE_IN_PARENT: InParent
- brooklyn.children:
- - type: entity-config-inheritance-example
-
-- type: org.apache.brooklyn.entity.stock.BasicApplication
- name: app4
- brooklyn.config:
- example.map:
- MESSAGE_IN_PARENT: InParent
- brooklyn.children:
- - type: entity-config-inheritance-example
- brooklyn.config:
- example.map:
- MESSAGE_IN_CHILD: InChild
-{% endhighlight %}
-
-A limitations of `inheritance.parent` is when inheriting values from parent and grandparent
-entities: a value specified on the parent will override (rather than be merged with) the
-value on the grandparent.
-
-
-#### Merging Policy and Enricher Configuration Values
-
-A current limitation is that sub-type inheritance is not supported for configuration of
-policies and enrichers. The current behaviour is that config is not inherited. The concept of
-inheritance from the runtime management hierarchy does not apply for policies and enrichers
-(they do not have "parents"; they are attached to an entity).
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/appserver-clustered-w-db-concise.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/appserver-clustered-w-db-concise.yaml b/guide/blueprints/example_yaml/appserver-clustered-w-db-concise.yaml
deleted file mode 100644
index 1905352..0000000
--- a/guide/blueprints/example_yaml/appserver-clustered-w-db-concise.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-name: appserver-clustered-w-db-concise
-services:
-- type: org.apache.brooklyn.entity.webapp.ControlledDynamicWebAppCluster
- brooklyn.config:
- cluster.initial.size: 2
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war
- http.port: 8080+
- java.sysprops:
- brooklyn.example.db.url: $brooklyn:formatString("jdbc:%s%s?user=%s\\&password=%s", component("db").attributeWhenReady("datastore.url"), "visitors", "brooklyn", $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password"))
-- type: org.apache.brooklyn.entity.database.mysql.MySqlNode
- id: db
- name: DB HelloWorld Visitors
- brooklyn.config:
- creation.script.password: $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
- datastore.creation.script.url: https://github.com/apache/brooklyn-library/blob/master/examples/simple-web-cluster/src/main/resources/visitors-creation-script.sql
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/appserver-clustered-w-db.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/appserver-clustered-w-db.yaml b/guide/blueprints/example_yaml/appserver-clustered-w-db.yaml
deleted file mode 100644
index 04c8519..0000000
--- a/guide/blueprints/example_yaml/appserver-clustered-w-db.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-name: appserver-clustered-w-db
-services:
-- type: org.apache.brooklyn.entity.webapp.ControlledDynamicWebAppCluster
- brooklyn.config:
- cluster.initial.size: 2
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.entity.webapp.jboss.JBoss7Server
- brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war
- http.port: 8080+
- java.sysprops:
- brooklyn.example.db.url:
- $brooklyn:formatString:
- - jdbc:%s%s?user=%s\\&password=%s
- - $brooklyn:component("db").attributeWhenReady("datastore.url")
- - visitors
- - brooklyn
- - $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
-- type: org.apache.brooklyn.entity.database.mysql.MySqlNode
- id: db
- name: DB HelloWorld Visitors
- brooklyn.config:
- creation.script.password: $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
- datastore.creation.script.url: https://github.com/apache/brooklyn-library/blob/master/examples/simple-web-cluster/src/main/resources/visitors-creation-script.sql
-
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/appserver-configured.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/appserver-configured.yaml b/guide/blueprints/example_yaml/appserver-configured.yaml
deleted file mode 100644
index 5d85edd..0000000
--- a/guide/blueprints/example_yaml/appserver-configured.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-name: appserver-configured
-services:
-- type: org.apache.brooklyn.entity.webapp.jboss.JBoss7Server
- brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war
- http.port: 8080
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/appserver-w-db-other-flavor.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/appserver-w-db-other-flavor.yaml b/guide/blueprints/example_yaml/appserver-w-db-other-flavor.yaml
deleted file mode 100644
index 14d9f44..0000000
--- a/guide/blueprints/example_yaml/appserver-w-db-other-flavor.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-name: appserver-w-db-other-flavor
-services:
-- type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
- name: AppServer HelloWorld
- brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war
- http.port: 8080+
- java.sysprops:
- brooklyn.example.db.url:
- $brooklyn:formatString:
- - jdbc:%s%s?user=%s\\&password=%s
- - $brooklyn:component("db").attributeWhenReady("datastore.url")
- - visitors
- - brooklyn
- - $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
-- type: org.apache.brooklyn.entity.database.mariadb.MariaDbNode
- id: db
- name: DB HelloWorld Visitors
- brooklyn.config:
- creation.script.password: $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
- datastore.creation.script.url: https://github.com/apache/brooklyn-library/raw/master/examples/simple-web-cluster/src/main/resources/visitors-creation-script.sql
- provisioning.properties:
- minRam: 8192
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/appserver-w-db.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/appserver-w-db.yaml b/guide/blueprints/example_yaml/appserver-w-db.yaml
deleted file mode 100644
index 768ba64..0000000
--- a/guide/blueprints/example_yaml/appserver-w-db.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-name: appserver-w-db
-services:
-- type: org.apache.brooklyn.entity.webapp.jboss.JBoss7Server
- name: AppServer HelloWorld
- brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war
- http.port: 8080+
- java.sysprops:
- brooklyn.example.db.url:
- $brooklyn:formatString:
- - jdbc:%s%s?user=%s\\&password=%s
- - $brooklyn:component("db").attributeWhenReady("datastore.url")
- - visitors
- - brooklyn
- - $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
-- type: org.apache.brooklyn.entity.database.mysql.MySqlNode
- id: db
- name: DB HelloWorld Visitors
- brooklyn.config:
- creation.script.password: $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
- datastore.creation.script.url: https://github.com/apache/brooklyn-library/raw/master/examples/simple-web-cluster/src/main/resources/visitors-creation-script.sql
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/appserver-w-policy.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/appserver-w-policy.yaml b/guide/blueprints/example_yaml/appserver-w-policy.yaml
deleted file mode 100644
index 4e193c6..0000000
--- a/guide/blueprints/example_yaml/appserver-w-policy.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-name: appserver-w-policy
-services:
-- type: org.apache.brooklyn.entity.webapp.ControlledDynamicWebAppCluster
- brooklyn.config:
- cluster.initial.size: 1
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.entity.webapp.jboss.JBoss7Server
- brooklyn.config:
- wars.root: http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war
- http.port: 8080+
- java.sysprops:
- brooklyn.example.db.url:
- $brooklyn:formatString:
- - jdbc:%s%s?user=%s\\&password=%s
- - $brooklyn:component("db").attributeWhenReady("datastore.url")
- - visitors
- - brooklyn
- - $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
- brooklyn.policies:
- - type: org.apache.brooklyn.policy.autoscaling.AutoScalerPolicy
- brooklyn.config:
- metric: $brooklyn:sensor("brooklyn.entity.webapp.DynamicWebAppCluster", "webapp.reqs.perSec.windowed.perNode")
- metricLowerBound: 10
- metricUpperBound: 100
- minPoolSize: 1
- maxPoolSize: 5
-- type: org.apache.brooklyn.entity.database.mysql.MySqlNode
- id: db
- name: DB HelloWorld Visitors
- brooklyn.config:
- creation.script.password: $brooklyn:external("brooklyn-demo-sample", "hidden-brooklyn-password")
- datastore.creation.script.url: https://github.com/apache/brooklyn-library/raw/master/examples/simple-web-cluster/src/main/resources/visitors-creation-script.sql
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/brooklyn-elasticsearch-catalog.bom
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/brooklyn-elasticsearch-catalog.bom b/guide/blueprints/example_yaml/brooklyn-elasticsearch-catalog.bom
deleted file mode 100644
index bcfaa1d..0000000
--- a/guide/blueprints/example_yaml/brooklyn-elasticsearch-catalog.bom
+++ /dev/null
@@ -1,125 +0,0 @@
-brooklyn.catalog:
- id: elasticsearch
- version: 1.0.0-SNAPSHOT
- iconUrl: https://static-www.elastic.co/assets/bltfdc1abb6ea9e2157/icon-elasticsearch.svg
- name: Elasticsearch
- license: Apache-2.0
- issues_url: https://github.com/brooklyncentral/brooklyn-elk/issues
- item:
- type: brooklyn.entity.group.DynamicCluster
- initialSize: $brooklyn:config("elasticsearch.cluster.initial.size")
- name: Elasticsearch Cluster
- id: elasticsearch-cluster
- description: A cluster of Elasticsearch nodes
-
- brooklyn.config:
- install.version: 2.4.0
- elasticsearch.http.port: 9220
- elasticsearch.tcp.port: 9330
-
- brooklyn.enrichers:
- - type: org.apache.brooklyn.enricher.stock.Aggregator
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("url.tcp")
- enricher.targetSensor: $brooklyn:sensor("urls.tcp.list")
- enricher.aggregating.fromMembers: true
- - type: org.apache.brooklyn.enricher.stock.Joiner
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.tcp.list")
- enricher.targetSensor: $brooklyn:sensor("urls.tcp.string")
- uniqueTag: urls.quoted.string
- - type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.tcp.string")
- enricher.targetSensor: $brooklyn:sensor("urls.tcp.withBrackets")
- enricher.targetValue: $brooklyn:formatString("[%s]", $brooklyn:attributeWhenReady("urls.tcp.string"))
- - type: org.apache.brooklyn.enricher.stock.Aggregator
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("url.http")
- enricher.targetSensor: $brooklyn:sensor("urls.http.list")
- enricher.aggregating.fromMembers: true
- - type: org.apache.brooklyn.enricher.stock.Joiner
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.http.list")
- enricher.targetSensor: $brooklyn:sensor("urls.http.string")
- uniqueTag: urls.http.quoted.string
- minimum: $brooklyn:config("elasticsearch.cluster.initial.size")
- - type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.http.string")
- enricher.targetSensor: $brooklyn:sensor("urls.http.withBrackets")
- enricher.targetValue: $brooklyn:formatString("[%s]", $brooklyn:attributeWhenReady("urls.http.string"))
- - type: org.apache.brooklyn.enricher.stock.Aggregator
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("host.subnet.address")
- enricher.targetSensor: $brooklyn:sensor("host.address.first")
- enricher.aggregating.fromMembers: true
- enricher.transformation:
- $brooklyn:object:
- type: "org.apache.brooklyn.util.collections.CollectionFunctionals$FirstElementFunction"
-
- memberSpec:
- $brooklyn:entitySpec:
- - type: brooklyn.entity.basic.VanillaSoftwareProcess
- name: Elasticsearch Node
-
- provisioning.properties:
- minRam: 7gb
- minDisk: 100gb
- minCores: 4
- osFamily: ubuntu
- imageNameRegex: .*16.04.*
- templateOptions:
- portSpeed: 1000
- diskType: "LOCAL"
- domainName: example.com
- groupId: elasticsearch
-
- shell.env:
- ELASTICSEARCH_VERSION: $brooklyn:config("install.version")
- URLS_WITH_BRACKETS: $brooklyn:component("parent", "").attributeWhenReady("urls.tcp.withBrackets")
- ES_HTTP_PORT: $brooklyn:config("elasticsearch.http.port")
- ES_TCP_PORT: $brooklyn:config("elasticsearch.tcp.port")
- IP_ADDRESS: $brooklyn:attributeWhenReady("host.subnet.address")
-
- install.command: |
- sudo apt-get update
- #sudo apt-get install -y openjdk-7-jdk wget
-
- wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
- echo "deb https://packages.elastic.co/elasticsearch/2.x/debian stable main" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-2.x.list
- sudo apt-get update && sudo apt-get -y install wget openjdk-8-jre elasticsearch=${ELASTICSEARCH_VERSION}
- sudo update-rc.d elasticsearch defaults 95 10
- sudo /bin/systemctl daemon-reload
- sudo /bin/systemctl enable elasticsearch.service
-
- customize.command: |
- sudo rm -fr sudo tee /etc/elasticsearch/elasticsearch.yml
- echo discovery.zen.ping.multicast.enabled: false | sudo tee -a /etc/elasticsearch/elasticsearch.yml
- echo discovery.zen.ping.unicast.enabled: true | sudo tee -a /etc/elasticsearch/elasticsearch.yml
- echo discovery.zen.ping.unicast.hosts: ${URLS_WITH_BRACKETS} | sudo tee -a /etc/elasticsearch/elasticsearch.yml
- echo http.port: ${ES_HTTP_PORT} | sudo tee -a /etc/elasticsearch/elasticsearch.yml
- echo transport.tcp.port: ${ES_TCP_PORT} | sudo tee -a /etc/elasticsearch/elasticsearch.yml
- echo network.host: ${IP_ADDRESS} | sudo tee -a /etc/elasticsearch/elasticsearch.yml
-
- launch.command: sudo systemctl start elasticsearch.service
-
- stop.command: sudo systemctl stop elasticsearch.service
-
- checkRunning.command: |
- sudo systemctl status elasticsearch.service
- #$brooklyn:formatString("counter=`wget -T 15 -q -O- %s:%s | grep -c \"status. : 200\"`; if [ $counter -eq 0 ]; then exit 1; fi",
- #$brooklyn:attributeWhenReady("host.address"),
- #$brooklyn:config("elasticsearch.http.port"))
-
- brooklyn.enrichers:
- - type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("host.subnet.address")
- enricher.targetSensor: $brooklyn:sensor("url.tcp")
- enricher.targetValue: $brooklyn:formatString("%s:%s", $brooklyn:attributeWhenReady("host.subnet.address"), $brooklyn:config("elasticsearch.tcp.port"))
- - type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("host.subnet.address")
- enricher.targetSensor: $brooklyn:sensor("url.http")
- enricher.targetValue: $brooklyn:formatString("%s:%s", $brooklyn:attributeWhenReady("host.subnet.address"), $brooklyn:config("elasticsearch.http.port"))
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/brooklyn-elk-catalog.bom
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/brooklyn-elk-catalog.bom b/guide/blueprints/example_yaml/brooklyn-elk-catalog.bom
deleted file mode 100644
index c3c3e60..0000000
--- a/guide/blueprints/example_yaml/brooklyn-elk-catalog.bom
+++ /dev/null
@@ -1,94 +0,0 @@
-brooklyn.catalog:
- version: 1.0.0-SNAPSHOT
- iconUrl: https://avatars0.githubusercontent.com/u/6764390?v=3&s=400
- license: Apache-2.0
- issues_url: https://github.com/brooklyncentral/brooklyn-elk/issues # TODO move this there
- itemType: template
- item:
- type: org.apache.brooklyn.entity.stock.BasicApplication
- name: ELK Stack
- id: ELK-Stack
- description: |
- Simple ELK stack deployment: provisions Elasticsearch, Kibana and Logstash as a child of Apache Tomcat 8
-
- brooklyn.parameters:
- - name: elasticsearch.cluster.initial.size
- type: integer
- label: Initial Size of the ElasticSearch Cluster
- description: The initial size of the cluster of ElasticSearch nodes
- default: 5
-
- services:
- - type: elasticsearch
- id: es
- name: Elasticsearch Cluster
- brooklyn.config:
- install.version: 2.4.0
-
- - type: kibana-standalone
- id: kibana
- name: Kibana Server
- latch.customize: $brooklyn:component("es").attributeWhenReady("service.isUp")
- brooklyn.config:
- kibana.elasticsearch.ip: $brooklyn:component("es").attributeWhenReady("host.address.first")
- kibana.elasticsearch.port: $brooklyn:component("es").config("elasticsearch.http.port")
-
- provisioning.properties:
- minRam: 8gb
- minDisk: 100gb
- minCores: 4
- osFamily: ubuntu
- imageNameRegex: .*16.04.*
- templateOptions:
- portSpeed: 1000
- diskType: "LOCAL"
- domainName: example.com
- groupId: kibana
-
- - type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
- id: tomcat
- latch.customize: $brooklyn:entity("es").attributeWhenReady("service.isUp")
- brooklyn.config:
- wars.root: "http://search.maven.org/remotecontent?filepath=org/apache/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.8.0-incubating/brooklyn-example-hello-world-sql-webapp-0.8.0-incubating.war"
- children.startable.mode: background_late
-
- provisioning.properties:
- minRam: 8gb
- minDisk: 100gb
- minCores: 4
- osFamily: ubuntu
- imageNameRegex: .*16.04.*
- templateOptions:
- portSpeed: 1000
- diskType: "LOCAL"
- domainName: example.com
- groupId: logstash
-
- brooklyn.children:
- - type: logstash-child
- name: Logstash
- brooklyn.config:
- logstash.elasticsearch.hosts: $brooklyn:entity("es").attributeWhenReady("urls.http.withBrackets")
- logstash.config.input:
- $brooklyn:formatString:
- - |
- input {
- file {
- path => "%s/logs/localhost_access_log.*"
- start_position => "beginning"
- }
- }
- - $brooklyn:entity("tomcat").attributeWhenReady("run.dir")
- logstash.config.filter: |
- filter {
- grok {
- match => { "message" => "%{COMBINEDAPACHELOG}" }
- }
- date {
- match => [ "timestamp" , "dd/MMM/yyyy:HH:mm:ss Z" ]
- }
- }
-
-
-
-
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/brooklyn-kibana-catalog.bom
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/brooklyn-kibana-catalog.bom b/guide/blueprints/example_yaml/brooklyn-kibana-catalog.bom
deleted file mode 100644
index 8aba455..0000000
--- a/guide/blueprints/example_yaml/brooklyn-kibana-catalog.bom
+++ /dev/null
@@ -1,58 +0,0 @@
-brooklyn.catalog:
- version: 1.0.0-SNAPSHOT
- iconUrl: https://static-www.elastic.co/assets/blt6c40e42f467aa55c/icon-kibana.svg
- items:
- - id: kibana-standalone
- name: "Kibana server"
- description: Kibana server. Callers should configure 'kibana.elasticsearch.ip'
- item:
- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- provisioning.properties:
- osFamily: ubuntu
-
- brooklyn.config:
- install.version: "4.6.1"
- kibana.elasticsearch.ip: 127.0.0.1 # must be supplied by caller!
- kibana.elasticsearch.port: 9200 # must be supplied by caller!
- kibana.port: 5601
-
- shell.env:
- KIBANA_VERSION: $brooklyn:config("install.version")
- ELASTICSEARCH_IP: $brooklyn:config("kibana.elasticsearch.ip")
- ELASTICSEARCH_PORT: $brooklyn:config("kibana.elasticsearch.port")
- KIBANA_PORT: $brooklyn:config("kibana.port")
-
- install.command: |
- #Update the system
- sudo apt-get update
-
- # Download the cert and repository
- wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
- echo "deb https://packages.elastic.co/kibana/4.6/debian stable main" | sudo tee -a /etc/apt/sources.list.d/kibana.list
-
- # Install pre-reqs and kibana
- sudo apt-get update && sudo apt-get -y install kibana=${KIBANA_VERSION}
-
-
- # customize config file for kibana
- sudo sed -i 's|# elasticsearch.url: "http://localhost:9200"|elasticsearch.url: "http://'"${ELASTICSEARCH_IP}"':'"${ELASTICSEARCH_PORT}"'"|g' /opt/kibana/config/kibana.yml
- sudo sed -i 's|5601|'"${KIBANA_PORT}"'|g' /opt/kibana/config/kibana.yml
- sudo sed -i 's|# log_file: ./kibana.log|log_file: ./kibana.log|g' /opt/kibana/config/kibana.yml
-
- sudo update-rc.d kibana defaults 95 10
- sudo /bin/systemctl daemon-reload
- sudo /bin/systemctl enable kibana.service
- #sudo systemctl start kibana.service
-
- launch.command: sudo systemctl start kibana.service
-
- stop.command: sudo systemctl stop kibana.service
-
- checkRunning.command: sudo systemctl status kibana.service
-
- brooklyn.enrichers:
- - type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("host.address")
- enricher.targetSensor: $brooklyn:sensor("main.uri")
- enricher.targetValue: $brooklyn:formatString("http://%s:%s", $brooklyn:attributeWhenReady("host.address"), $brooklyn:config("kibana.port"))
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/brooklyn-logstash-catalog.bom
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/brooklyn-logstash-catalog.bom b/guide/blueprints/example_yaml/brooklyn-logstash-catalog.bom
deleted file mode 100644
index 95f2f4f..0000000
--- a/guide/blueprints/example_yaml/brooklyn-logstash-catalog.bom
+++ /dev/null
@@ -1,66 +0,0 @@
-brooklyn.catalog:
- version: 1.0.0-SNAPSHOT
- iconUrl: https://static-www.elastic.co/assets/blte39224bc57d3e015/icon-logstash.svg
- items:
- - id: logstash-standalone
- name: "Logstash server"
- description: "Single Logstash server"
- item:
- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- provisioning.properties:
- osFamily: ubuntu
-
- brooklyn.config:
- install.version: "2.4.0"
- logstash.config.input: input { file { path => "/var/log/*" } }
- logstash.config.filter: ''
- logstash.config.output:
- $brooklyn:formatString:
- - |
- output {
- elasticsearch {
- hosts => %s
- }
- }
- - $brooklyn:config("logstash.elasticsearch.hosts")
- logstash.config.dir: /etc/logstash/conf.d
-
- shell.env:
- LOGSTASH_VERSION: $brooklyn:config("install.version")
- INPUT_CONFIG: $brooklyn:config("logstash.config.input")
- FILTER_CONFIG: $brooklyn:config("logstash.config.filter")
- OUTPUT_CONFIG: $brooklyn:config("logstash.config.output")
- CONFIG_DIR: $brooklyn:config("logstash.config.dir")
- ELASTICSEARCH_HOSTS: $brooklyn:config("logstash.elasticsearch.hosts")
-
- install.command: |
- #Update the system
- sudo apt-get update
-
- # Download the cert and repository
- wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
- echo "deb https://packages.elastic.co/logstash/2.4/debian stable main" | sudo tee -a /etc/apt/sources.list
- sudo apt-get update && sudo apt-get -y install openjdk-8-jre logstash
-
- # add a config file for logstash
- sudo mkdir -p ${CONFIG_DIR}
- echo "${INPUT_CONFIG} ${FILTER_CONFIG} ${OUTPUT_CONFIG}" | sudo tee ${CONFIG_DIR}/01-basic.conf
-
- launch.command: sudo systemctl start logstash.service
-
- stop.command: sudo systemctl stop logstash.service
-
- checkRunning.command: sudo systemctl status logstash.service
-
- - id: logstash-child
- name: "Logstash Child"
- description: |
- Logstash server to be embedded as a child of a SoftwareProcess that
- publishes its 'log.location' as a sensor.
- Callers should configure 'logstash.elasticsearch.hosts' (if using ES)
- or 'logstash.config.output'.
-
- item:
- type: logstash-standalone
- brooklyn.config:
- logstash.elasticsearch.host: 127.0.0.1:9200 # must be supplied by caller!
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/cluster-vm.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/cluster-vm.yaml b/guide/blueprints/example_yaml/cluster-vm.yaml
deleted file mode 100644
index e21977a..0000000
--- a/guide/blueprints/example_yaml/cluster-vm.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-name: cluster-vm
-services:
-- type: org.apache.brooklyn.entity.group.DynamicCluster
- brooklyn.config:
- cluster.initial.size: 5
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess
- name: VM
- provisioning.properties:
- minRam: 8g
- minCores: 4
- minDisk: 100g
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/enricher-aggregator.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/enricher-aggregator.yaml b/guide/blueprints/example_yaml/enricher-aggregator.yaml
deleted file mode 100644
index af78c28..0000000
--- a/guide/blueprints/example_yaml/enricher-aggregator.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-brooklyn.enrichers:
-- type: org.apache.brooklyn.enricher.stock.Aggregator
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("webapp.reqs.perSec.windowed")
- enricher.targetSensor: $brooklyn:sensor("webapp.reqs.perSec.perNode")
- enricher.aggregating.fromMembers: true
- transformation: average
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/enricher-joiner.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/enricher-joiner.yaml b/guide/blueprints/example_yaml/enricher-joiner.yaml
deleted file mode 100644
index 670d4f2..0000000
--- a/guide/blueprints/example_yaml/enricher-joiner.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-brooklyn.enrichers:
-- type: org.apache.brooklyn.enricher.stock.Joiner
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.tcp.list")
- enricher.targetSensor: $brooklyn:sensor("urls.tcp.string")
- uniqueTag: urls.quoted.string
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/enricher-propagator.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/enricher-propagator.yaml b/guide/blueprints/example_yaml/enricher-propagator.yaml
deleted file mode 100644
index 88c3f6e..0000000
--- a/guide/blueprints/example_yaml/enricher-propagator.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-brooklyn.enrichers:
-- type: org.apache.brooklyn.enricher.stock.Propagator
- brooklyn.config:
- enricher.producer: $brooklyn:entity("cluster")
-- type: org.apache.brooklyn.enricher.stock.Propagator
- brooklyn.config:
- sensorMapping:
- $brooklyn:sensor("url"): $brooklyn:sensor("org.apache.brooklyn.core.entity.Attributes", "main.uri")
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/enricher-time-weighted-delta.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/enricher-time-weighted-delta.yaml b/guide/blueprints/example_yaml/enricher-time-weighted-delta.yaml
deleted file mode 100644
index 2c38dee..0000000
--- a/guide/blueprints/example_yaml/enricher-time-weighted-delta.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-brooklyn.enrichers:
-- type: org.apache.brooklyn.enricher.stock.YamlTimeWeightedDeltaEnricher
- brooklyn.config:
- enricher.sourceSensor: reqs.count
- enricher.targetSensor: reqs.per_sec
- enricher.delta.period: 1s
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/enricher-transformer.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/enricher-transformer.yaml b/guide/blueprints/example_yaml/enricher-transformer.yaml
deleted file mode 100644
index 06e5a67..0000000
--- a/guide/blueprints/example_yaml/enricher-transformer.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-brooklyn.enrichers:
-- type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.tcp.string")
- enricher.targetSensor: $brooklyn:sensor("urls.tcp.withBrackets")
- enricher.targetValue: $brooklyn:formatString("[%s]", $brooklyn:attributeWhenReady("urls.tcp.string"))
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/fabric-with-multiple-locations.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/fabric-with-multiple-locations.yaml b/guide/blueprints/example_yaml/fabric-with-multiple-locations.yaml
deleted file mode 100644
index d923025..0000000
--- a/guide/blueprints/example_yaml/fabric-with-multiple-locations.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-name: fabric-of-app-server-clusters
-locations:
-- aws-ec2:us-east-1
-- aws-ec2:us-west-1
-services:
-- type: org.apache.brooklyn.entity.group.DynamicFabric
- brooklyn.config:
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.entity.group.DynamicCluster
- brooklyn.config:
- cluster.initial.size: 3
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/simple-appserver-with-location-byon.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/simple-appserver-with-location-byon.yaml b/guide/blueprints/example_yaml/simple-appserver-with-location-byon.yaml
deleted file mode 100644
index 7e4c0ca..0000000
--- a/guide/blueprints/example_yaml/simple-appserver-with-location-byon.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-name: simple-appserver-with-location-byon
-location:
- byon:
- user: brooklyn
- privateKeyFile: ~/.ssh/brooklyn.pem
- hosts:
- - 192.168.0.18
- - 192.168.0.19
-services:
-- type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/simple-appserver-with-location-per-entity.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/simple-appserver-with-location-per-entity.yaml b/guide/blueprints/example_yaml/simple-appserver-with-location-per-entity.yaml
deleted file mode 100644
index a39e27d..0000000
--- a/guide/blueprints/example_yaml/simple-appserver-with-location-per-entity.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-name: simple-appserver-with-location-per-entity
-services:
-- type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
- location:
- byon(hosts="192.168.0.18",user="brooklyn",privateKeyFile="~/.ssh/brooklyn.pem")
-- type: org.apache.brooklyn.entity.webapp.jboss.JBoss7Server
- location:
- byon(hosts="192.168.0.19",user="brooklyn",privateKeyFile="~/.ssh/brooklyn.pem")
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/simple-appserver-with-location.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/simple-appserver-with-location.yaml b/guide/blueprints/example_yaml/simple-appserver-with-location.yaml
deleted file mode 100644
index 764eaac..0000000
--- a/guide/blueprints/example_yaml/simple-appserver-with-location.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-name: simple-appserver-with-location
-location:
- jclouds:aws-ec2:
- region: us-east-1
- identity: AKA_YOUR_ACCESS_KEY_ID
- credential: <access-key-hex-digits>
-services:
-- type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/simple-appserver.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/simple-appserver.yaml b/guide/blueprints/example_yaml/simple-appserver.yaml
deleted file mode 100644
index 8e9d76a..0000000
--- a/guide/blueprints/example_yaml/simple-appserver.yaml
+++ /dev/null
@@ -1,4 +0,0 @@
-name: simple-appserver
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.webapp.jboss.JBoss7Server
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/simple-vm.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/simple-vm.yaml b/guide/blueprints/example_yaml/simple-vm.yaml
deleted file mode 100644
index 141c7e8..0000000
--- a/guide/blueprints/example_yaml/simple-vm.yaml
+++ /dev/null
@@ -1,9 +0,0 @@
-name: simple-vm
-services:
-- type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess
- name: VM
- brooklyn.config:
- provisioning.properties:
- minRam: 8192mb
- minCores: 4
- minDisk: 100gb
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/test-app-with-enrichers-slightly-simpler.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/test-app-with-enrichers-slightly-simpler.yaml b/guide/blueprints/example_yaml/test-app-with-enrichers-slightly-simpler.yaml
deleted file mode 100644
index f1bc25e..0000000
--- a/guide/blueprints/example_yaml/test-app-with-enrichers-slightly-simpler.yaml
+++ /dev/null
@@ -1,58 +0,0 @@
-#
-# example showing how enrichers can be set
-#
-name: test-app-with-enrichers
-description: Testing many enrichers
-services:
-- type: org.apache.brooklyn.entity.group.DynamicCluster
- id: cluster
- location: localhost
- brooklyn.config:
- cluster.initial.size: 3
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: org.apache.brooklyn.core.test.entity.TestEntity
- brooklyn.enrichers:
- - type: org.apache.brooklyn.enricher.stock.Transformer
- # transform "ip" (which we expect a feed, not shown here, to set) to a URL;
- # you can curl an address string to the sensors/ip endpoint an entity to trigger these enrichers
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("ip")
- enricher.targetSensor: $brooklyn:sensor("url")
- enricher.targetValue: $brooklyn:formatString("http://%s/", $brooklyn:attributeWhenReady("ip"))
- - type: org.apache.brooklyn.enricher.stock.Propagator
- # use propagator to duplicate one sensor as another, giving the supplied sensor mapping;
- # the other use of Propagator is where you specify a producer (using $brooklyn:entity(...) as below)
- # from which to take sensors; in that mode you can specify `propagate` as a list of sensors whose names are unchanged,
- # instead of (or in addition to) this map
- brooklyn.config:
- sensorMapping:
- $brooklyn:sensor("url"): $brooklyn:sensor("org.apache.brooklyn.core.entity.Attributes", "main.uri")
- brooklyn.enrichers:
- - type: org.apache.brooklyn.enricher.stock.Aggregator
- # aggregate `url` sensors from children into a list
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("url")
- enricher.targetSensor: $brooklyn:sensor("urls.list")
- enricher.aggregating.fromMembers: true
- - type: org.apache.brooklyn.enricher.stock.Joiner
- # create a string from that list, for use e.g. in bash scripts
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.list")
- enricher.targetSensor: $brooklyn:sensor("urls.list.comma_separated.max_2")
- maximum: 2
- # TODO infer uniqueTag, name etc
- uniqueTag: urls.list.comma_separated.max_2
- - type: org.apache.brooklyn.enricher.stock.Joiner
- # pick one uri as the main one to use
- brooklyn.config:
- enricher.sourceSensor: $brooklyn:sensor("urls.list")
- enricher.targetSensor: $brooklyn:sensor("org.apache.brooklyn.core.entity.Attributes", "main.uri")
- quote: false
- maximum: 1
-brooklyn.enrichers:
-- type: org.apache.brooklyn.enricher.stock.Propagator
- # if nothing specified for `propagating` or `sensorMapping` then
- # Propagator will do all but the usual lifecycle defaults, handy at the root!
- brooklyn.config:
- enricher.producer: $brooklyn:entity("cluster")
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-catalog.bom
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-catalog.bom b/guide/blueprints/example_yaml/vanilla-bash-netcat-catalog.bom
deleted file mode 100644
index 1dfcc34..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-catalog.bom
+++ /dev/null
@@ -1,37 +0,0 @@
-brooklyn.catalog:
- id: netcat-example
- version: "1.0"
- itemType: entity
- item:
- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
-
- brooklyn.config:
- launch.command: |
- echo $MESSAGE | nc -l $NETCAT_PORT &
- echo $! > $PID_FILE
-
- shell.env:
- MESSAGE: $brooklyn:config("message")
- NETCAT_PORT: $brooklyn:attributeWhenReady("netcat.port")
-
- brooklyn.parameters:
- - name: message
- description: a message to send to the caller
- default: hello
- - name: netcat.port
- type: port
- description: the port netcat should run on
- default: 4321+
-
- brooklyn.enrichers:
- - type: org.apache.brooklyn.enricher.stock.Transformer
- brooklyn.config:
- uniqueTag: main-uri-generator
- enricher.sourceSensor: $brooklyn:sensor("host.address")
- enricher.targetSensor: $brooklyn:sensor("main.uri")
- enricher.targetValue:
- $brooklyn:formatString:
- - "http://%s:%s/"
- - $brooklyn:attributeWhenReady("host.address")
- - $brooklyn:attributeWhenReady("netcat.port")
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-cluster.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-cluster.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-cluster.yaml
deleted file mode 100644
index 1686f29..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-cluster.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-name: Netcat Cluster Example
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.group.DynamicCluster
- brooklyn.config:
- dynamiccluster.memberspec:
- $brooklyn:entitySpec:
- type: netcat-example
- message: hello from cluster member
- netcat.port: 8000+
- cluster.initial.size: 3
- dynamiccluster.restartMode: parallel
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-env.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-env.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-env.yaml
deleted file mode 100644
index 3f04a3b..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-env.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-name: Netcat Example with Environment Vars
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
-
- brooklyn.config:
- launch.command: |
- echo $MESSAGE | nc -l $NETCAT_PORT &
- echo $! > $PID_FILE
-
- shell.env:
- MESSAGE: hello
- NETCAT_PORT: 4321
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-file.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-file.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-file.yaml
deleted file mode 100644
index 1c4612b..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-file.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-name: Simple Netcat Example From File
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
- brooklyn.config:
- download.url: file:///tmp/netcat-server.tgz
- launch.command: |
- ./start.sh &
- echo $! > $PID_FILE
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-more-commands.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-more-commands.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-more-commands.yaml
deleted file mode 100644
index 05b2ee4..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-more-commands.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-name: Netcat Example with Explicit Check and Stop Commands
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
- brooklyn.config:
- launch.command: |
- echo hello | nc -l 4321 &
- echo $! > $PID_FILE
-
- # The following overrides demonstrate the use of a custom shell environment as well as
- # check-running and stop commands. These are optional; default behavior will "do the
- # right thing" with the pid file automatically.
-
- shell.env:
- CHECK_MARKER: "checkRunning"
- STOP_MARKER: "stop"
- checkRunning.command: |
- echo $CHECK_MARKER >> DATE && test -f "$PID_FILE" && ps -p `cat $PID_FILE` >/dev/null
- stop.command: |
- echo $STOP_MARKER >> DATE && test -f "$PID_FILE" && { kill -9 `cat $PID_FILE`; rm $PID_FILE; }
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-port-parameter.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-port-parameter.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-port-parameter.yaml
deleted file mode 100644
index d7a999d..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-port-parameter.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-name: Netcat Example with Parameter
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
- brooklyn.config:
- launch.command: |
- echo $MESSAGE | nc -l $NETCAT_PORT &
- echo $! > $PID_FILE
-
- shell.env:
- MESSAGE: $brooklyn:config("message")
- NETCAT_PORT: $brooklyn:attributeWhenReady("netcat.port")
-
- brooklyn.parameters:
- - name: message
- description: a message to send to the caller
- default: hello
- - name: netcat.port
- type: port
- description: the port netcat should run on
- default: 4321+
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-port.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-port.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-port.yaml
deleted file mode 100644
index 822f509..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-port.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-name: Netcat Example with Port Opened
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
-
- brooklyn.config:
- # matching the regex `.*\.port` will cause the port to be opened
- # if in a cloud where configurable security groups are available
- netcat.port: 4321
-
- launch.command: |
- echo hello | nc -l 4321 &
- echo $! > $PID_FILE
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-reference.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-reference.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-reference.yaml
deleted file mode 100644
index 0f10c55..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-reference.yaml
+++ /dev/null
@@ -1,5 +0,0 @@
-name: Netcat Type Reference Example
-location: localhost
-services:
-- type: netcat-example
- message: hello from netcat using a registered type
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-restarter.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-restarter.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-restarter.yaml
deleted file mode 100644
index 9acbf54..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-restarter.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-name: Netcat Example with Restarter Policy
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- id: netcat-server
- name: Simple Netcat Server
- brooklyn.config:
- launch.command: |
- echo hello | nc -l 4321 &
- echo $! > $PID_FILE
- brooklyn.enrichers:
- - type: org.apache.brooklyn.policy.ha.ServiceFailureDetector
- brooklyn.config:
- # wait 15s after service fails before propagating failure
- serviceFailedStabilizationDelay: 15s
- brooklyn.policies:
- - type: org.apache.brooklyn.policy.ha.ServiceRestarter
- brooklyn.config:
- # repeated failures in a time window can cause the restarter to abort,
- # propagating the failure; a time window of 0 will mean it always restarts!
- failOnRecurringFailuresInThisDuration: 0
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml
deleted file mode 100644
index 64377b2..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat-w-client.yaml
+++ /dev/null
@@ -1,80 +0,0 @@
-name: Netcat Example with Client
-
-location: localhost
-
-services:
-
-# the netcat server instance, running in listener mode (-l)
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- id: netcat-server
- name: Simple Netcat Server
- brooklyn.config:
- launch.command: |
- echo hello | nc -l 4321 >> server-input &
- echo $! > $PID_FILE
-
- # a failure detector and a service restarter work together
- brooklyn.enrichers:
- - type: org.apache.brooklyn.policy.ha.ServiceFailureDetector
- brooklyn.config:
- # wait 15s after service fails before propagating failure
- serviceFailedStabilizationDelay: 15s
-
- brooklyn.policies:
- - type: org.apache.brooklyn.policy.ha.ServiceRestarter
- brooklyn.config:
- # repeated failures in a time window can cause the restarter to abort,
- # propagating the failure; a time window of 0 will mean it always restarts!
- failOnRecurringFailuresInThisDuration: 0
-
- brooklyn.initializers:
- # two sensors, recording the data sent to this netcat server:
-
- - type: org.apache.brooklyn.core.sensor.ssh.SshCommandSensor
- brooklyn.config:
- name: output.last
- period: 1s
- command: tail -1 server-input
-
- - type: org.apache.brooklyn.core.sensor.ssh.SshCommandSensor
- brooklyn.config:
- name: output.all
- period: 1s
- command: cat server-input
-
-# a client to hit netcat
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Pinger
-
- brooklyn.config:
- # set the hostname of the netcat instance as an env var for the scripts
- shell.env:
- TARGET_HOSTNAME:
- $brooklyn:entity("netcat-server").
- attributeWhenReady("host.name")
-
- # start/check/stop are no-op
- launch.command: ""
- checkRunning.command: ""
- stop.command: ""
-
- brooklyn.initializers:
- # but there is a sample effector which runs nc in client mode
-
- - type: org.apache.brooklyn.core.effector.ssh.SshCommandEffector
- brooklyn.config:
- name: sayHiNetcat
- description: Echo a small hello string to the netcat entity
- command: |
- echo $message | nc $TARGET_HOSTNAME 4321
- parameters:
- message:
- description: The string to pass to netcat
- defaultValue: hi netcat
-
-# and add an enricher at the root so all sensors from netcat-server are visible on the root
-brooklyn.enrichers:
-- enricherType: org.apache.brooklyn.enricher.stock.Propagator
- brooklyn.config:
- enricher.producer: $brooklyn:entity("netcat-server")
- enricher.propagating.propagatingAll: true
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/example_yaml/vanilla-bash-netcat.yaml
----------------------------------------------------------------------
diff --git a/guide/blueprints/example_yaml/vanilla-bash-netcat.yaml b/guide/blueprints/example_yaml/vanilla-bash-netcat.yaml
deleted file mode 100644
index 011d45e..0000000
--- a/guide/blueprints/example_yaml/vanilla-bash-netcat.yaml
+++ /dev/null
@@ -1,9 +0,0 @@
-name: Simple Netcat Server Example
-location: localhost
-services:
-- type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
- name: Simple Netcat Server
- brooklyn.config:
- launch.command: |
- echo hello | nc -l 4321 &
- echo $! > $PID_FILE
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/index.md
----------------------------------------------------------------------
diff --git a/guide/blueprints/index.md b/guide/blueprints/index.md
deleted file mode 100644
index 01ab184..0000000
--- a/guide/blueprints/index.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-title: Writing Blueprints
-layout: website-normal
-children:
-- creating-yaml.md
-- entity-configuration.md
-- setting-locations.md
-- configuring-vms.md
-- multiple-services.md
-- custom-entities.md
-- catalog/
-- clusters.md
-- enrichers.md
-- policies.md
-- effectors.md
-- clusters-and-policies.md
-- java/
-- winrm/
-- test/
-- ansible/
-- chef/
-- salt/
-- advanced-example.md
-- blueprinting-tips.md
-- { path: yaml-reference.md, title: YAML Blueprint Reference }
----
-
-
-{% include list-children.html %}
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/java/archetype.md
----------------------------------------------------------------------
diff --git a/guide/blueprints/java/archetype.md b/guide/blueprints/java/archetype.md
deleted file mode 100644
index f9acac8..0000000
--- a/guide/blueprints/java/archetype.md
+++ /dev/null
@@ -1,114 +0,0 @@
----
-title: Creating from a Maven Archetype
-layout: website-normal
-toc: ../guide_toc.json
-categories: [use, guide, defining-applications]
----
-
-### Maven Archetype
-
-Brooklyn includes a maven archetype, which can be used to create the project structure for
-developing a new Java entity, and generating the OSGi bundle for it.
-
-
-#### Generating the Project
-
-The archetype can be used interactively, by running:
-{% highlight bash %}
-$ mvn archetype:generate
-{% endhighlight %}
-
-The user will be prompted for the archetype to use (i.e. group "org.apache.brooklyn"
-and artifact "brooklyn-archetype-quickstart"), as well as options for the project
-to be created.
-
-Alternatively, all options can be supplied at the command line. For example,
-if creating a project named "autobrick" for "com.acme":
-
-{% highlight bash %}
-$ BROOKLYN_VERSION={{ site.brooklyn-version }}
-$ mvn archetype:generate \
- -DarchetypeGroupId=org.apache.brooklyn \
- -DarchetypeArtifactId=brooklyn-archetype-quickstart \
- -DarchetypeVersion=${BROOKLYN_VERSION} \
- -DgroupId=com.acme \
- -DartifactId=autobrick \
- -Dversion=0.1.0-SNAPSHOT \
- -DpackageName=com.acme.autobrick \
- -DinteractiveMode=false
-{% endhighlight %}
-
-This will create a directory with the artifact name (e.g. "autobrick" in the example above).
-Note that if run from a directory containing a pom, it will also modify that pom to add this as
-a module!
-
-The project will contain an example Java entity. You can test this using the supplied unit tests,
-and also replace it with your own code.
-
-The `README.md` file within the project gives further guidance.
-
-
-#### Building
-
-To build, run the commands:
-
-{% highlight bash %}
-$ cd autobrick
-$ mvn clean install
-{% endhighlight %}
-
-
-#### Adding to the Catalog
-
-The build will produce an OSGi bundle in `target/autobrick-0.1.0-SNAPSHOT.jar`, suitable for
-use in the [Brooklyn catalog]({{ site.path.guide }}/blueprints/catalog/) (using `brooklyn.libraries`).
-
-To use this in your Brooklyn catalog you will first have to copy the target jar to a suitable location.
-For developing/testing purposes storing on the local filesystem is fine.
-For production use, we recommend uploading to a remote maven repository or similar.
-
-Once your jar is in a suitable location the next step is to add a new catalog item to Brooklyn.
-The project comes with a `catalog.bom` file, located in `src/main/resources`.
-Modify this file by adding a 'brooklyn.libraries' statement to the bom pointing to the jar.
-For example:
-
-{% highlight yaml %}
-brooklyn.catalog:
- brooklyn.libraries:
- - file:///path/to/jar/autobrick-0.1.0-SNAPSHOT.jar
- version: "0.1.0-SNAPSHOT"
- itemType: entity
- items:
- - id: com.acme.autobrick.MySample
- item:
- type: com.acme.autobrick.MySample
-{% endhighlight %}
-
-The command below will use the CLI to add this to the catalog of a running Brooklyn instance:
-
-{% highlight bash %}
- br catalog add catalog.bom
-{% endhighlight %}
-
-After running that command, the OSGi bundle will have been added to the OSGi container, and the
-entity will have been added to your catalog. It can then be used in the same way as regular Brooklyn
-entities.
-
-For example, you can use the blueprint:
-
-{% highlight yaml %}
-services:
-- type: com.acme.autobrick.MySample
-{% endhighlight %}
-
-
-### Testing Entities
-
-The project comes with unit tests that demonstrate how to test entities, both within Java and
-also using YAML-based blueprints.
-
-A strongly recommended way is to write a YAML test blueprint using the test framework, and making
-this available to anyone who will use your entity. This will allow users to easily run the test
-blueprint in their own environment (simply by deploying it to their own Brooklyn server) to confirm
-that the entity is working as expected. An example is contained within the project at
-`src/test/resources/sample-test.yaml`.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/58bb3aa0/guide/blueprints/java/bundle-dependencies.md
----------------------------------------------------------------------
diff --git a/guide/blueprints/java/bundle-dependencies.md b/guide/blueprints/java/bundle-dependencies.md
deleted file mode 100644
index 0f07fb6..0000000
--- a/guide/blueprints/java/bundle-dependencies.md
+++ /dev/null
@@ -1,135 +0,0 @@
----
-title: Handling Bundle Dependencies
-layout: website-normal
----
-
-Some Java blueprints will require third party libraries. These need to be made available to the
-Apache Brooklyn runtime. There are a number of ways this can be achieved.
-
-### Classic Mode: Dropins Folder
-
-In Brooklyn classic mode (i.e. when not using Karaf), jars can be added to `./lib/dropins/`.
-After restarting Brooklyn, these will be available on the classpath.
-
-In Brooklyn classic mode, there is an embedded OSGi container. This is used for installing
-libraries referenced in catalog items.
-
-### OSGi Bundles
-
-#### Introduction to OSGi Bundles
-
-An [OSGi bundle](https://en.wikipedia.org/wiki/OSGi#Bundles) is a jar file with additional
-metadata in its manifest file. The `MANIFEST.MF` file contains the symbolic name and version
-of the bundle, along with details of its dependencies and of the packages it exports
-(which are thus visible to other bundles).
-
-The [maven-bundle-plugin](http://felix.apache.org/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html)
-is a convenient way of building OSGi bundles.
-
-#### OSGi Bundles Declared in Catalog Items
-
-Within a [catalog item]({{ site.path.guide}}/blueprints/catalog/), a list of URLs can be supplied under
-`brooklyn.libraries`. Each URL should point to an OSGi bundle. This list should include the OSGi
-bundle that has the Java code for your blueprint, and also the OSGi bundles that it depends
-on (including all transitive dependencies).
-
-It is vital that these jars are built correctly as OSGi bundles, and that all transitive
-dependencies are included. The bundles will be added to Karaf in the order given, so a bundle's
-dependencies should be listed before the bundle(s) that depend on them.
-
-In the [GistGenerator example]({{ site.path.guide}}/blueprints/java/defining-and-deploying.html), the
-[catalog.bom file]({{ site.path.guide}}/blueprints/java/gist_generator/gist_generator.bom) included
-the URL of the dependency `org.eclipse.egit.github.core`. It also (before that line) included
-its transitive dependency, which is a specific version of `gson`.
-
-For Java blueprint developers, this is often the most convenient way to share a blueprint.
-
-Similarly for those wishing to use a new blueprint, this is often the simplest mechanism: the
-dependencies are fully described in the catalog item, which makes it convenient for deploying
-to Apache Brooklyn instances where there is not direct access to Karaf or the file system.
-
-
-#### Adding Bundles and Features Directly to Karaf
-
-Bundles and features can be added manually, directly to Karaf.
-
-However, note this only affects the single Karaf instance. If running in HA mode or if provisioning
-a new instance of Apache Brooklyn, the bundles will also need to be added to these Karaf instances.
-
-
-##### Karaf Console
-
-Login to the [Karaf console](https://karaf.apache.org/manual/latest/#_shell_console_basics)
-using `./bin/client`, and add the bundles and features as desired.
-
-Examples of some useful commands are shown below:
-
-{% highlight bash %}
-karaf@amp> bundle:install -s http://repo1.maven.org/maven2/org/apache/servicemix/bundles/org.apache.servicemix.bundles.egit.github.core/2.1.5_1/org.apache.servicemix.bundles.egit.github.core-2.1.5_1.jar
-Bundle ID: 316
-
-karaf@amp> bundle:list -t 0 -s | grep github
-318 | Active | 80 | 2.1.5.1 | org.apache.servicemix.bundles.egit.github.core
-
-karaf@amp> bundle:headers org.apache.servicemix.bundles.egit.github.core
-...
-
-karaf@amp> bundle:uninstall org.apache.servicemix.bundles.egit.github.core
-{% endhighlight %}
-
-
-##### Karaf Deploy Folder
-
-Karaf support [hot deployment](https://karaf.apache.org/manual/latest/#_deployers). There are a
-set of deployers, such as feature and KAR deployers, that handle deployment of artifacts added
-to the `deploy` folder.
-
-Note that the Karaf console can give finer control (including for uninstall).
-
-
-### Karaf KAR files
-
-[Karaf KAR](https://karaf.apache.org/manual/latest/kar) is an archive format (Karaf ARchive).
-A KAR is a jar file (so a zip file), which contains a set of feature descriptors and bundle jar files.
-
-This can be a useful way to bundle a more complex Java blueprint (along with its dependencies), to
-make it easier for others to install.
-
-A KAR file can be built using the
-[maven plugin org.apache.karaf.tooling:features-maven-plugin](https://karaf.apache.org/manual/latest/#_maven).
-
-
-### Karaf Features
-
-A [karaf feature.xml](https://karaf.apache.org/manual/latest/#_create_a_features_xml_karaf_feature_archetype)
-defines a set of bundles that make up a feature. Once a feature is defined, one can add it to a Karaf instance:
-either directly (e.g. using the [Karaf console](https://karaf.apache.org/manual/latest/#_shell_console_basics)), or
-by referencing it in another feature.xml file.
-
-
-### Embedded Dependencies
-
-An OSGi bundle can
-[embed jar dependencies](http://felix.apache.org/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html#embedding-dependencies)
-within it. This allows dependencies to be kept private within a bundle, and easily shipped with that bundle.
-
-To keep these private, it is vital that the OSGi bundle does not import or export the packages
-contained within those embedded jars, and does not rely on any of those packages in the public
-signatures of any packages that are exported or imported.
-
-
-### Converting Non-OSGi Dependencies to Bundles
-
-If a dependencies is not available as an OSGi bundle (and you don't want to just [embed the jar](#embedded-dependencies)),
-there are a few options for getting an equivalent OSGi bundle:
-
-* Use a ServiceMix re-packaged jar, if available. ServiceMix have re-packed many common dependencies as
- OSGi bundles, and published them on [Maven Central](https://search.maven.org).
-
-* Use the `wrap:` prefix. The [PAX URL Wrap protocol](https://ops4j1.jira.com/wiki/display/paxurl/Wrap+Protocol)
- is an OSGi URL handler that can process your legacy jar at runtime and transform it into an OSGi bundle.
- This can be used when declaring a dependency in your feature.xml, and when using the Karaf console's
- `bundle:install`. Note that it is not yet supported in Brooklyn's `brooklyn.libraries` catalog items.
-
-* Re-package the bundle yourself, offline, to produce a valid OSGi bundle.
-