brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aleds...@apache.org
Subject [1/2] brooklyn-docs git commit: :component(ID) is deprecated, remove it from documentation
Date Mon, 06 Jun 2016 21:44:40 GMT
Repository: brooklyn-docs
Updated Branches:
  refs/heads/master 74a25d1e5 -> 78ee70537


:component(ID) is deprecated, remove it from documentation


Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/1ee3c3ba
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/1ee3c3ba
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/1ee3c3ba

Branch: refs/heads/master
Commit: 1ee3c3ba0b0069581c756f89f51d5228e917b9f4
Parents: a67a284
Author: Svetoslav Neykov <svetoslav.neykov@cloudsoftcorp.com>
Authored: Tue May 31 15:40:17 2016 +0300
Committer: Svetoslav Neykov <svetoslav.neykov@cloudsoftcorp.com>
Committed: Tue May 31 15:40:17 2016 +0300

----------------------------------------------------------------------
 guide/yaml/advanced-example.md                        |  2 +-
 guide/yaml/ansible/creating-ansible-blueprints.md     |  2 +-
 guide/yaml/chef/example_yaml/mysql-chef-2.yaml        |  6 +++---
 guide/yaml/chef/writing-chef.md                       |  2 +-
 guide/yaml/custom-entities.md                         |  2 +-
 guide/yaml/example_yaml/brooklyn-elk-catalog.bom      | 10 +++++-----
 .../example_yaml/vanilla-bash-netcat-w-client.yaml    |  4 ++--
 .../entities/loopovergroupmembers-entity.yaml         |  2 +-
 .../example_yaml/entities/testeffector-entity.yaml    |  2 +-
 .../example_yaml/entities/testhttpcall-entity.yaml    |  2 +-
 .../test/example_yaml/entities/testsensor-entity.yaml |  2 +-
 .../example_yaml/testcases/effector-test-snippet.yaml |  4 ++--
 .../testcases/getting-started-test-example.yaml       | 14 +++++++-------
 guide/yaml/test/test-entities.md                      |  8 ++++----
 guide/yaml/yaml-reference.md                          |  4 ++--
 15 files changed, 33 insertions(+), 33 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/advanced-example.md
----------------------------------------------------------------------
diff --git a/guide/yaml/advanced-example.md b/guide/yaml/advanced-example.md
index b66a3fb..e9aa617 100644
--- a/guide/yaml/advanced-example.md
+++ b/guide/yaml/advanced-example.md
@@ -160,7 +160,7 @@ In the ELK blueprint, there is a good example of a latch. Latches are
used to fo
 - type: kibana-standalone
   ...
   name: Kibana Server
-  customize.latch: $brooklyn:component("es").attributeWhenReady("service.isUp")
+  customize.latch: $brooklyn:entity("es").attributeWhenReady("service.isUp")
 ~~~
 
 This latch is used to stop Kibana customizing until the Elasticsearch cluster is up. We do
this to ensure that the URL sensors have been setup, so that they can be passed into Kibana
during the customization phase.

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/ansible/creating-ansible-blueprints.md
----------------------------------------------------------------------
diff --git a/guide/yaml/ansible/creating-ansible-blueprints.md b/guide/yaml/ansible/creating-ansible-blueprints.md
index 1df1277..845f542 100644
--- a/guide/yaml/ansible/creating-ansible-blueprints.md
+++ b/guide/yaml/ansible/creating-ansible-blueprints.md
@@ -151,7 +151,7 @@ There is no specific configuration in AnsibleEntity for Ansible [Roles](http://d
               - command: unzip -o -d /etc/ansible/playbooks /tmp/master.zip
     
       - serviceType: org.apache.brooklyn.entity.stock.BasicApplication
-        start.latch: $brooklyn:component("bootstrap").attributeWhenReady("service.isUp")
+        start.latch: $brooklyn:entity("bootstrap").attributeWhenReady("service.isUp")
         brooklyn.children:
         - type: org.apache.brooklyn.entity.cm.ansible.AnsibleEntity
           name: test

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/chef/example_yaml/mysql-chef-2.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/chef/example_yaml/mysql-chef-2.yaml b/guide/yaml/chef/example_yaml/mysql-chef-2.yaml
index ced2dbe..9e9de9b 100644
--- a/guide/yaml/chef/example_yaml/mysql-chef-2.yaml
+++ b/guide/yaml/chef/example_yaml/mysql-chef-2.yaml
@@ -13,9 +13,9 @@ services:
   launch_attributes:
     mysql:
       # these attrs are required by the mysql cookbook under node['mysql']
-      server_root_password: $brooklyn:component("db").config("mysql.password")
-      server_repl_password: $brooklyn:component("db").config("mysql.password")
-      server_debian_password: $brooklyn:component("db").config("mysql.password")
+      server_root_password: $brooklyn:entity("db").config("mysql.password")
+      server_repl_password: $brooklyn:entity("db").config("mysql.password")
+      server_debian_password: $brooklyn:entity("db").config("mysql.password")
       # many others are attrs are supported by the cookbook and can be passed here...
       
   # how to determine if the process is running and how to kill it

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/chef/writing-chef.md
----------------------------------------------------------------------
diff --git a/guide/yaml/chef/writing-chef.md b/guide/yaml/chef/writing-chef.md
index 0593837..671d961 100644
--- a/guide/yaml/chef/writing-chef.md
+++ b/guide/yaml/chef/writing-chef.md
@@ -63,7 +63,7 @@ please let us know.  We'd like to see this too, and we'll help you along
the way
 To help you on your way writing Chef blueprints, here are a handful of pointers
 particularly useful in this context:
 
-* Configuration keys can be inherited from the top-level and accessed using `$brooklyn:component('id').config('key_name')`.
+* Configuration keys can be inherited from the top-level and accessed using `$brooklyn:entity('id').config('key_name')`.
   An example of this is shown in the `mysql-chef.yaml` sample recipe contained in the Brooklyn
code base
   and [here](example_yaml/mysql-chef-2.yaml) for convenience.
   Here, `p4ssw0rd` is specified only once and then used for all the attributes required by
the stock mysql cookbook.  

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/custom-entities.md
----------------------------------------------------------------------
diff --git a/guide/yaml/custom-entities.md b/guide/yaml/custom-entities.md
index 9698aa8..f4af0cb 100644
--- a/guide/yaml/custom-entities.md
+++ b/guide/yaml/custom-entities.md
@@ -201,7 +201,7 @@ using `env` variables to inject the `netcat-server` location and
 `parameters` to pass in per-effector data:
 
       env:
-        TARGET_HOSTNAME: $brooklyn:component("netcat-server").attributeWhenReady("host.name")
+        TARGET_HOSTNAME: $brooklyn:entity("netcat-server").attributeWhenReady("host.name")
       brooklyn.initializers:
       - type: org.apache.brooklyn.core.effector.ssh.SshCommandEffector
         brooklyn.config:

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/example_yaml/brooklyn-elk-catalog.bom
----------------------------------------------------------------------
diff --git a/guide/yaml/example_yaml/brooklyn-elk-catalog.bom b/guide/yaml/example_yaml/brooklyn-elk-catalog.bom
index 6fc11f4..fbc9ab8 100644
--- a/guide/yaml/example_yaml/brooklyn-elk-catalog.bom
+++ b/guide/yaml/example_yaml/brooklyn-elk-catalog.bom
@@ -19,17 +19,17 @@ brooklyn.catalog:
       - type: kibana-standalone
         id: kibana
         name: Kibana Server
-        customize.latch: $brooklyn:component("es").attributeWhenReady("service.isUp")
+        customize.latch: $brooklyn:entity("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")
+          kibana.elasticsearch.ip: $brooklyn:entity("es").attributeWhenReady("host.address.first")
+          kibana.elasticsearch.port: $brooklyn:entity("es").config("elasticsearch.http.port")
       - type: org.apache.brooklyn.entity.webapp.tomcat.Tomcat8Server
         id: tomcat
-        customize.latch: $brooklyn:component("es").attributeWhenReady("service.isUp")
+        customize.latch: $brooklyn:entity("es").attributeWhenReady("service.isUp")
         brooklyn.config:
           children.startable.mode: background_late
         brooklyn.children:
         - type: logstash-child
           name: Logstash Child
           brooklyn.config:
-            logstash.elasticsearch.host: $brooklyn:component("es").attributeWhenReady("urls.http.withBrackets")
+            logstash.elasticsearch.host: $brooklyn:entity("es").attributeWhenReady("urls.http.withBrackets")

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/example_yaml/vanilla-bash-netcat-w-client.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/example_yaml/vanilla-bash-netcat-w-client.yaml b/guide/yaml/example_yaml/vanilla-bash-netcat-w-client.yaml
index 78ed99e..75d2b79 100644
--- a/guide/yaml/example_yaml/vanilla-bash-netcat-w-client.yaml
+++ b/guide/yaml/example_yaml/vanilla-bash-netcat-w-client.yaml
@@ -48,7 +48,7 @@ services:
   # set the hostname of the netcat instance as an env var for the scripts 
   env:
     TARGET_HOSTNAME: 
-      $brooklyn:component("netcat-server").
+      $brooklyn:entity("netcat-server").
         attributeWhenReady("host.name")
     
   # start/check/stop are no-op
@@ -74,5 +74,5 @@ services:
 brooklyn.enrichers:
 - enricherType: org.apache.brooklyn.enricher.stock.Propagator
   brooklyn.config:
-    enricher.producer: $brooklyn:component("netcat-server")
+    enricher.producer: $brooklyn:entity("netcat-server")
     enricher.propagating.propagatingAll: true

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/example_yaml/entities/loopovergroupmembers-entity.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/test/example_yaml/entities/loopovergroupmembers-entity.yaml b/guide/yaml/test/example_yaml/entities/loopovergroupmembers-entity.yaml
index e97ab4c..713ffbc 100644
--- a/guide/yaml/test/example_yaml/entities/loopovergroupmembers-entity.yaml
+++ b/guide/yaml/test/example_yaml/entities/loopovergroupmembers-entity.yaml
@@ -1,5 +1,5 @@
 - type: org.apache.brooklyn.test.framework.LoopOverGroupMembersTestCase
-  target: $brooklyn:component("infrastructure").component("child", "DockerHosts")
+  target: $brooklyn:entity("infrastructure").component("child", "DockerHosts")
   testSpec:
     $brooklyn:entitySpec:
       type: org.apache.brooklyn.test.framework.TestSensor

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/example_yaml/entities/testeffector-entity.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/test/example_yaml/entities/testeffector-entity.yaml b/guide/yaml/test/example_yaml/entities/testeffector-entity.yaml
index 13e0ebf..e9d570e 100644
--- a/guide/yaml/test/example_yaml/entities/testeffector-entity.yaml
+++ b/guide/yaml/test/example_yaml/entities/testeffector-entity.yaml
@@ -1,6 +1,6 @@
 - type: org.apache.brooklyn.test.framework.TestEffector
   name: Invoke Deploy Effector
-  target: $brooklyn:component("tomcat")
+  target: $brooklyn:entity("tomcat")
   effector: deploy
   timeout: 5m
   params:

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/example_yaml/entities/testhttpcall-entity.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/test/example_yaml/entities/testhttpcall-entity.yaml b/guide/yaml/test/example_yaml/entities/testhttpcall-entity.yaml
index bdb3347..e719b82 100644
--- a/guide/yaml/test/example_yaml/entities/testhttpcall-entity.yaml
+++ b/guide/yaml/test/example_yaml/entities/testhttpcall-entity.yaml
@@ -1,6 +1,6 @@
 - type: org.apache.brooklyn.test.framework.TestHttpCall
   name: Check HTTP Response Status Code
-  url: $brooklyn:component("tomcat").attributeWhenReady("webapp.url")
+  url: $brooklyn:entity("tomcat").attributeWhenReady("webapp.url")
   timeout: 60s
   applyAssertionTo: status
   assert:

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/example_yaml/entities/testsensor-entity.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/test/example_yaml/entities/testsensor-entity.yaml b/guide/yaml/test/example_yaml/entities/testsensor-entity.yaml
index e781d0d..91f55a5 100644
--- a/guide/yaml/test/example_yaml/entities/testsensor-entity.yaml
+++ b/guide/yaml/test/example_yaml/entities/testsensor-entity.yaml
@@ -1,6 +1,6 @@
 - type: org.apache.brooklyn.test.framework.TestSensor
   name: Check tomcat isUp
-  target: $brooklyn:component("tomcat")
+  target: $brooklyn:entity("tomcat")
   sensor: service.isUp
   timeout: 10m
   assert:

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/example_yaml/testcases/effector-test-snippet.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/test/example_yaml/testcases/effector-test-snippet.yaml b/guide/yaml/test/example_yaml/testcases/effector-test-snippet.yaml
index 54e30da..2e01ba5 100644
--- a/guide/yaml/test/example_yaml/testcases/effector-test-snippet.yaml
+++ b/guide/yaml/test/example_yaml/testcases/effector-test-snippet.yaml
@@ -21,8 +21,8 @@
     timeout: 5m
     url: >
       $brooklyn:formatString("http://%s:%s/newcontext/",
-      $brooklyn:component("webappcluster").attributeWhenReady("host.address"),
-      $brooklyn:component("webappcluster").attributeWhenReady("proxy.http.port"))
+      $brooklyn:entity("webappcluster").attributeWhenReady("host.address"),
+      $brooklyn:entity("webappcluster").attributeWhenReady("proxy.http.port"))
     applyAssertionTo: status
     assert:
     - isEqualTo: 200
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/example_yaml/testcases/getting-started-test-example.yaml
----------------------------------------------------------------------
diff --git a/guide/yaml/test/example_yaml/testcases/getting-started-test-example.yaml b/guide/yaml/test/example_yaml/testcases/getting-started-test-example.yaml
index 5f40abb..d6740ec 100644
--- a/guide/yaml/test/example_yaml/testcases/getting-started-test-example.yaml
+++ b/guide/yaml/test/example_yaml/testcases/getting-started-test-example.yaml
@@ -14,7 +14,7 @@ services:
     java.sysprops:
       brooklyn.example.db.url: >
         $brooklyn:formatString("jdbc:%s%s?user=%s&password=%s",
-        component("db").attributeWhenReady("datastore.url"),
+        entity("db").attributeWhenReady("datastore.url"),
         "visitors", "brooklyn", "br00k11n")
 - type: org.apache.brooklyn.entity.database.mysql.MySqlNode
   id: db
@@ -25,8 +25,8 @@ services:
   name: Check HTTP Response Status Code
   url: >
     $brooklyn:formatString("http://%s:%s",
-    $brooklyn:component("webappcluster").attributeWhenReady("host.address"),
-    $brooklyn:component("webappcluster").attributeWhenReady("proxy.http.port"))
+    $brooklyn:entity("webappcluster").attributeWhenReady("host.address"),
+    $brooklyn:entity("webappcluster").attributeWhenReady("proxy.http.port"))
   timeout: 10m
   applyAssertionTo: status
   assert:
@@ -35,8 +35,8 @@ services:
   name: Check HTTP Response Body
   url: >
     $brooklyn:formatString("http://%s:%s",
-    $brooklyn:component("webappcluster").attributeWhenReady("host.address"),
-    $brooklyn:component("webappcluster").attributeWhenReady("proxy.http.port"))
+    $brooklyn:entity("webappcluster").attributeWhenReady("host.address"),
+    $brooklyn:entity("webappcluster").attributeWhenReady("proxy.http.port"))
   timeout: 10m
   applyAssertionTo: body
   assert:
@@ -64,8 +64,8 @@ services:
     timeout: 5m
     url: >
       $brooklyn:formatString("http://%s:%s/newcontext/",
-      $brooklyn:component("webappcluster").attributeWhenReady("host.address"),
-      $brooklyn:component("webappcluster").attributeWhenReady("proxy.http.port"))
+      $brooklyn:entity("webappcluster").attributeWhenReady("host.address"),
+      $brooklyn:entity("webappcluster").attributeWhenReady("proxy.http.port"))
     applyAssertionTo: status
     assert:
     - isEqualTo: 200
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/test/test-entities.md
----------------------------------------------------------------------
diff --git a/guide/yaml/test/test-entities.md b/guide/yaml/test/test-entities.md
index a81a3d6..37dc098 100644
--- a/guide/yaml/test/test-entities.md
+++ b/guide/yaml/test/test-entities.md
@@ -41,7 +41,7 @@ The `LoopOverGroupMembersTestCase` entity is configured with a target group
and
 {% endhighlight %}
 
 #### Parameters
-- `target` - group who's members are to be tested, specified via DSL. For example, `$brooklyn:component("tomcat")`.
See also the `targetId` parameter.
+- `target` - group who's members are to be tested, specified via DSL. For example, `$brooklyn:entity("tomcat")`.
See also the `targetId` parameter.
 - `targetId` - alternative to the `target` parameter which wraps the DSL component lookup
requiring only the `id` be supplied. For example, `tomcat`. Please note, this must point to
a group.
 - `test.spec` - The TargetableTestComponent to create for each child.
 
@@ -69,7 +69,7 @@ The `TestSensor` entity performs an assertion on a specified sensors value.
 {% endhighlight %}
 
 #### Parameters
-- `target` - entity whose sensor will be tested, specified via DSL. For example, `$brooklyn:component("tomcat")`.
See also the `targetId` parameter.
+- `target` - entity whose sensor will be tested, specified via DSL. For example, `$brooklyn:entity("tomcat")`.
See also the `targetId` parameter.
 - `targetId` - alternative to the `target` parameter which wraps the DSL component lookup
requiring only the `id` be supplied. For example, `tomcat`.
 - `sensor` - sensor to evaluate. For example `service.isUp`.
 - `timeout` - duration to wait on assertion to return a result. For example `10s`, `10m`,
etc
@@ -82,7 +82,7 @@ The `TestEffector` entity invokes the specified effector on a target entity.
If
 {% endhighlight %}
 
 #### Parameters
-- `target` - entity whose effector will be invoked, specified via DSL. For example, `$brooklyn:component("tomcat")`.
See also the `targetId` parameter.
+- `target` - entity whose effector will be invoked, specified via DSL. For example, `$brooklyn:entity("tomcat")`.
See also the `targetId` parameter.
 - `targetId` - alternative to the `target` parameter which wraps the DSL component lookup
requiring only the `id` be supplied. For example, `tomcat`.
 - `timeout` - duration to wait on the effector task to complete. For example `10s`, `10m`,
etc
 - `effector` - effector to invoke, for example `deploy`.
@@ -96,7 +96,7 @@ The `TestHttpCall` entity performs a HTTP GET on the specified URL and performs
 {% endhighlight %}
 
 #### Parameters
-- `url` - URL to perform GET request on, this can use DSL for example `$brooklyn:component("tomcat").attributeWhenReady("webapp.url")`.
+- `url` - URL to perform GET request on, this can use DSL for example `$brooklyn:entity("tomcat").attributeWhenReady("webapp.url")`.
 - `timeout` - duration to wait on a HTTP response. For example `10s`, `10m`, etc
 - `applyAssertionTo` - The filed to apply the assertion to. For example `status`, `body`
 - `assert` - assertion to perform on the response.  See section on assertions below.

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/1ee3c3ba/guide/yaml/yaml-reference.md
----------------------------------------------------------------------
diff --git a/guide/yaml/yaml-reference.md b/guide/yaml/yaml-reference.md
index 7a628a0..d198316 100644
--- a/guide/yaml/yaml-reference.md
+++ b/guide/yaml/yaml-reference.md
@@ -191,9 +191,9 @@ concise DSL defined here:
   can be used to supply config at the root which is used in multiple places in the plan
 * `$brooklyn:sensor("sensor.name")` returns the given sensor on the current entity if found,
or an untyped (Object) sensor;
   `$brooklyn:sensor("com.acme.brooklyn.ContainingEntityClass", "sensor.name")` returns the
strongly typed sensor defined in the given class
-* `$brooklyn:component("ID")` refers to a Brooklyn component with the given ID; you can then
access the following subfields,
+* `$brooklyn:entity("ID")` refers to a Brooklyn entity with the given ID; you can then access
the following subfields,
   using the same syntax as defined above but with a different reference entity,
-  e.g. `$brooklyn:component("ID").attributeWhenReady("sensor")`:
+  e.g. `$brooklyn:entity("ID").attributeWhenReady("sensor")`:
   * `.attributeWhenReady("sensor")`
   * `.config("key")`
   * `.sensor("sensor.name")`


Mime
View raw message