Improve @Catalog descriptions
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/3853681f Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/3853681f Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/3853681f Branch: refs/heads/master Commit: 3853681f05c8297929cb1bb55f383048118df12f Parents: f14a64b Author: Aled Sage <[email protected]> Authored: Fri Sep 5 13:41:28 2014 +0100 Committer: Martin Harris <[email protected]> Committed: Mon Sep 8 11:22:38 2014 +0100 ---------------------------------------------------------------------- .../src/main/java/brooklyn/demo/NodeJsTodoApplication.java | 2 +- .../src/main/java/brooklyn/entity/messaging/storm/Storm.java | 4 +++- .../brooklyn/entity/messaging/storm/StormDeployment.java | 4 +++- .../java/brooklyn/entity/zookeeper/ZooKeeperEnsemble.java | 3 ++- .../main/java/brooklyn/entity/zookeeper/ZooKeeperNode.java | 3 ++- .../brooklyn/entity/nosql/couchbase/CouchbaseCluster.java | 3 ++- .../java/brooklyn/entity/nosql/couchbase/CouchbaseNode.java | 3 ++- .../entity/nosql/elasticsearch/ElasticSearchCluster.java | 4 +++- .../entity/nosql/elasticsearch/ElasticSearchNode.java | 4 +++- .../main/java/brooklyn/entity/nosql/riak/RiakCluster.java | 8 +++++--- .../src/main/java/brooklyn/entity/nosql/riak/RiakNode.java | 3 ++- .../brooklyn/entity/webapp/nodejs/NodeJsWebAppService.java | 2 +- 12 files changed, 29 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/examples/simple-web-cluster/src/main/java/brooklyn/demo/NodeJsTodoApplication.java ---------------------------------------------------------------------- diff --git a/examples/simple-web-cluster/src/main/java/brooklyn/demo/NodeJsTodoApplication.java b/examples/simple-web-cluster/src/main/java/brooklyn/demo/NodeJsTodoApplication.java index 483986a..50d5f74 100644 --- a/examples/simple-web-cluster/src/main/java/brooklyn/demo/NodeJsTodoApplication.java +++ b/examples/simple-web-cluster/src/main/java/brooklyn/demo/NodeJsTodoApplication.java @@ -37,7 +37,7 @@ import com.google.common.collect.ImmutableMap; * Node.JS Todo Application */ @Catalog(name="NodeJS Todo", - description="Node.JS Todo Application.", + description="Node.js is a cross-platform runtime environment for server-side and networking applications. Node.js applications are written in JavaScript", iconUrl="classpath://nodejs-logo.png") public class NodeJsTodoApplication extends AbstractApplication implements StartableApplication { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/messaging/src/main/java/brooklyn/entity/messaging/storm/Storm.java ---------------------------------------------------------------------- diff --git a/software/messaging/src/main/java/brooklyn/entity/messaging/storm/Storm.java b/software/messaging/src/main/java/brooklyn/entity/messaging/storm/Storm.java index d7ec47b..455747a 100644 --- a/software/messaging/src/main/java/brooklyn/entity/messaging/storm/Storm.java +++ b/software/messaging/src/main/java/brooklyn/entity/messaging/storm/Storm.java @@ -36,7 +36,9 @@ import brooklyn.util.flags.SetFromFlag; /** * An {@link brooklyn.entity.Entity} that represents a Storm node (UI, Nimbus or Supervisor). */ -@Catalog(name="Storm Node", description="Storm is...") +@Catalog(name="Storm Node", description="Apache Storm is a distributed realtime computation system. " + + "Storm makes it easy to reliably process unbounded streams of data, doing for realtime processing " + + "what Hadoop did for batch processing") @ImplementedBy(StormImpl.class) public interface Storm extends SoftwareProcess, UsesJmx { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/messaging/src/main/java/brooklyn/entity/messaging/storm/StormDeployment.java ---------------------------------------------------------------------- diff --git a/software/messaging/src/main/java/brooklyn/entity/messaging/storm/StormDeployment.java b/software/messaging/src/main/java/brooklyn/entity/messaging/storm/StormDeployment.java index 1483281..f5e3373 100644 --- a/software/messaging/src/main/java/brooklyn/entity/messaging/storm/StormDeployment.java +++ b/software/messaging/src/main/java/brooklyn/entity/messaging/storm/StormDeployment.java @@ -26,7 +26,9 @@ import brooklyn.entity.proxying.ImplementedBy; import brooklyn.entity.trait.Startable; import brooklyn.util.flags.SetFromFlag; -@Catalog(name="Storm Deployment", description="Storm is...") +@Catalog(name="Storm Deployment", description="A Storm cluster. Apache Storm is a distributed realtime computation system. " + + "Storm makes it easy to reliably process unbounded streams of data, doing for realtime processing " + + "what Hadoop did for batch processing") @ImplementedBy(StormDeploymentImpl.class) public interface StormDeployment extends Entity, Startable { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperEnsemble.java ---------------------------------------------------------------------- diff --git a/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperEnsemble.java b/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperEnsemble.java index f33ee90..a15eeef 100644 --- a/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperEnsemble.java +++ b/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperEnsemble.java @@ -32,7 +32,8 @@ import brooklyn.util.flags.SetFromFlag; import com.google.common.reflect.TypeToken; -@Catalog(name="ZooKeeper ensemble", description="ZooKeeper is...") +@Catalog(name="ZooKeeper ensemble", description="A cluster of ZooKeeper servers. " + + "Apache ZooKeeper enables highly reliable distributed coordination.") @ImplementedBy(ZooKeeperEnsembleImpl.class) public interface ZooKeeperEnsemble extends DynamicCluster { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperNode.java ---------------------------------------------------------------------- diff --git a/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperNode.java b/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperNode.java index 40b7b3e..a4a6d2d 100644 --- a/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperNode.java +++ b/software/messaging/src/main/java/brooklyn/entity/zookeeper/ZooKeeperNode.java @@ -32,7 +32,8 @@ import brooklyn.util.flags.SetFromFlag; /** * An {@link brooklyn.entity.Entity} that represents a single Apache ZooKeeper instance. */ -@Catalog(name="ZooKeeper Node", description="ZooKeeper is...") +@Catalog(name="ZooKeeper Node", description="Apache ZooKeeper is a server which enables " + + "highly reliable distributed coordination.") @ImplementedBy(ZooKeeperNodeImpl.class) public interface ZooKeeperNode extends SoftwareProcess { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseCluster.java ---------------------------------------------------------------------- diff --git a/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseCluster.java b/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseCluster.java index 1bdc124..9a5de95 100644 --- a/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseCluster.java +++ b/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseCluster.java @@ -35,7 +35,8 @@ import brooklyn.util.time.Duration; import com.google.common.reflect.TypeToken; -@Catalog(name="CouchBase Cluster", description="CouchBase is...") +@Catalog(name="CouchBase Cluster", description="Couchbase is an open source, distributed (shared-nothing architecture) " + + "NoSQL document-oriented database that is optimized for interactive applications.") @ImplementedBy(CouchbaseClusterImpl.class) public interface CouchbaseCluster extends DynamicCluster { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseNode.java ---------------------------------------------------------------------- diff --git a/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseNode.java b/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseNode.java index 9fa23b5..4a843dd 100644 --- a/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseNode.java +++ b/software/nosql/src/main/java/brooklyn/entity/nosql/couchbase/CouchbaseNode.java @@ -36,7 +36,8 @@ import brooklyn.event.basic.Sensors; import brooklyn.util.flags.SetFromFlag; import brooklyn.util.text.ByteSizeStrings; -@Catalog(name="CouchBase Node", description="CouchBase is...") +@Catalog(name="CouchBase Node", description="Couchbase Server is an open source, distributed (shared-nothing architecture) " + + "NoSQL document-oriented database that is optimized for interactive applications.") @ImplementedBy(CouchbaseNodeImpl.class) public interface CouchbaseNode extends SoftwareProcess { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchCluster.java ---------------------------------------------------------------------- diff --git a/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchCluster.java b/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchCluster.java index 738661b..155b79f 100644 --- a/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchCluster.java +++ b/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchCluster.java @@ -27,7 +27,9 @@ import brooklyn.util.flags.SetFromFlag; /** * A cluster of {@link ElasticSearchNode}s based on {@link DynamicCluster} which can be resized by a policy if required. */ -@Catalog(name="Elastic Search Cluster", description="Elastic Search is...") +@Catalog(name="Elastic Search Cluster", description="Elasticsearch is an open-source search server based on Lucene. " + + "It provides a distributed, multitenant-capable full-text search engine with a RESTful web interface and " + + "schema-free JSON documents.") @ImplementedBy(ElasticSearchClusterImpl.class) public interface ElasticSearchCluster extends DynamicCluster { @SetFromFlag("clusterName") http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchNode.java ---------------------------------------------------------------------- diff --git a/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchNode.java b/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchNode.java index d679f3f..ddd7b36 100644 --- a/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchNode.java +++ b/software/nosql/src/main/java/brooklyn/entity/nosql/elasticsearch/ElasticSearchNode.java @@ -36,7 +36,9 @@ import brooklyn.util.flags.SetFromFlag; /** * An {@link brooklyn.entity.Entity} that represents an ElasticSearch node */ -@Catalog(name="Elastic Search Node", description="Elastic Search is...") +@Catalog(name="Elastic Search Node", description="Elasticsearch is an open-source search server based on Lucene. " + + "It provides a distributed, multitenant-capable full-text search engine with a RESTful web interface and " + + "schema-free JSON documents.") @ImplementedBy(ElasticSearchNodeImpl.class) public interface ElasticSearchNode extends SoftwareProcess, DatastoreMixins.HasDatastoreUrl { @SetFromFlag("version") http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakCluster.java ---------------------------------------------------------------------- diff --git a/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakCluster.java b/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakCluster.java index 798ebe9..32e8de7 100644 --- a/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakCluster.java +++ b/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakCluster.java @@ -33,13 +33,15 @@ import brooklyn.util.time.Duration; import com.google.common.reflect.TypeToken; -@Catalog(name="Riak Node", description="Riak is...") +@Catalog(name="Riak Cluster", description="Riak is a distributed NoSQL key-value data store that offers " + + "extremely high availability, fault tolerance, operational simplicity and scalability.") @ImplementedBy(RiakClusterImpl.class) public interface RiakCluster extends DynamicCluster { @SuppressWarnings("serial") - AttributeSensor<Map<Entity, String>> RIAK_CLUSTER_NODES = Sensors.newSensor(new TypeToken<Map<Entity, String>>() { - }, "riak.cluster.nodes", "Names of all active Riak nodes in the cluster <Entity,Riak Name>"); + AttributeSensor<Map<Entity, String>> RIAK_CLUSTER_NODES = Sensors.newSensor( + new TypeToken<Map<Entity, String>>() {}, + "riak.cluster.nodes", "Names of all active Riak nodes in the cluster <Entity,Riak Name>"); @SetFromFlag("delayBeforeAdvertisingCluster") ConfigKey<Duration> DELAY_BEFORE_ADVERTISING_CLUSTER = ConfigKeys.newConfigKey(Duration.class, "riak.cluster.delayBeforeAdvertisingCluster", "Delay after cluster is started before checking and advertising its availability", Duration.seconds(2 * 60)); http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakNode.java ---------------------------------------------------------------------- diff --git a/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakNode.java b/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakNode.java index 0acc7b1..8eb583f 100644 --- a/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakNode.java +++ b/software/nosql/src/main/java/brooklyn/entity/nosql/riak/RiakNode.java @@ -35,7 +35,8 @@ import brooklyn.event.basic.PortAttributeSensorAndConfigKey; import brooklyn.event.basic.Sensors; import brooklyn.util.flags.SetFromFlag; -@Catalog(name="Riak Node", description="Riak is...") +@Catalog(name="Riak Node", description="Riak is a distributed NoSQL key-value data store that offers " + + "extremely high availability, fault tolerance, operational simplicity and scalability.") @ImplementedBy(RiakNodeImpl.class) public interface RiakNode extends SoftwareProcess { http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/3853681f/software/webapp/src/main/java/brooklyn/entity/webapp/nodejs/NodeJsWebAppService.java ---------------------------------------------------------------------- diff --git a/software/webapp/src/main/java/brooklyn/entity/webapp/nodejs/NodeJsWebAppService.java b/software/webapp/src/main/java/brooklyn/entity/webapp/nodejs/NodeJsWebAppService.java index 1711563..dd1534b 100644 --- a/software/webapp/src/main/java/brooklyn/entity/webapp/nodejs/NodeJsWebAppService.java +++ b/software/webapp/src/main/java/brooklyn/entity/webapp/nodejs/NodeJsWebAppService.java @@ -35,7 +35,7 @@ import com.google.common.collect.ImmutableList; import com.google.common.reflect.TypeToken; @Catalog(name="Node.JS Application", - description="Node.JS Web Application", + description="Node.js is a cross-platform runtime environment for server-side and networking applications. Node.js applications are written in JavaScriptq", iconUrl="classpath:///nodejs-logo.png") @ImplementedBy(NodeJsWebAppServiceImpl.class) public interface NodeJsWebAppService extends SoftwareProcess, WebAppService {
