catalog.bom: improve names/descriptions Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/651f63c7 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/651f63c7 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/651f63c7
Branch: refs/heads/master Commit: 651f63c7c64b24270e4d80b58877e81c4bdd7c1e Parents: 3d62a1e Author: Aled Sage <[email protected]> Authored: Tue Sep 12 16:07:05 2017 +0100 Committer: Aled Sage <[email protected]> Committed: Tue Sep 12 18:31:57 2017 +0100 ---------------------------------------------------------------------- core/src/main/resources/catalog.bom | 55 +++++++++++++++- policy/src/main/resources/catalog.bom | 77 ++++++++++++++--------- software/base/src/main/resources/catalog.bom | 15 ++++- 3 files changed, 114 insertions(+), 33 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/651f63c7/core/src/main/resources/catalog.bom ---------------------------------------------------------------------- diff --git a/core/src/main/resources/catalog.bom b/core/src/main/resources/catalog.bom index 19f4929..6625afe 100644 --- a/core/src/main/resources/catalog.bom +++ b/core/src/main/resources/catalog.bom @@ -23,42 +23,68 @@ brooklyn.catalog: - id: org.apache.brooklyn.entity.group.QuarantineGroup item: type: org.apache.brooklyn.entity.group.QuarantineGroup + name: Quarantine Group + description: A grouping for entities that are in quarantine (i.e. removed from the main cluster) - id: org.apache.brooklyn.entity.group.BasicGroup item: type: org.apache.brooklyn.entity.group.BasicGroup + name: Basic Group + description: A grouping of entities - id: org.apache.brooklyn.entity.stock.BasicEntity item: type: org.apache.brooklyn.entity.stock.BasicEntity + name: Basic Entity + description: The simplest basic entity (can be useful for testing) - id: org.apache.brooklyn.entity.stock.DataEntity item: type: org.apache.brooklyn.entity.stock.DataEntity + name: Basic Entity + description: An entity that supplies data as sensor values (periodically evaluating given suppliers). - id: org.apache.brooklyn.entity.group.DynamicGroup item: type: org.apache.brooklyn.entity.group.DynamicGroup + name: Dynamic Group + description: A grouping of entities, where membership of the group is based on a given filter. - id: org.apache.brooklyn.entity.stock.DelegateEntity item: type: org.apache.brooklyn.entity.stock.DelegateEntity + name: Delegate Entity + description: An entity that mirrors another entity (mirroring its sensors) - id: org.apache.brooklyn.entity.group.DynamicRegionsFabric item: type: org.apache.brooklyn.entity.group.DynamicRegionsFabric + name: Dynamic Regions Fabric + description: A 'fabric' (see 'Dynamic Fabric') that allows new locations to be added/removed. - id: org.apache.brooklyn.core.server.entity.BrooklynMetrics item: type: org.apache.brooklyn.core.server.entity.BrooklynMetrics + name: Brooklyn Metrics + description: An entity that gives information about this Brooklyn server. - id: org.apache.brooklyn.entity.stock.BasicApplication item: type: org.apache.brooklyn.entity.stock.BasicApplication + name: Basic Application + description: The simplest application. - id: org.apache.brooklyn.entity.stock.BasicStartable item: type: org.apache.brooklyn.entity.stock.BasicStartable + name: Basic Startable + description: Provides a pass-through Startable entity, which can control the location(s) passed to its children. - id: org.apache.brooklyn.entity.group.DynamicCluster item: type: org.apache.brooklyn.entity.group.DynamicCluster + name: Dynamic Cluster + description: A cluster of entities that can dynamically increase or decrease the number of members. - id: org.apache.brooklyn.entity.group.DynamicMultiGroup item: type: org.apache.brooklyn.entity.group.DynamicMultiGroup + name: Dynamic Multi Group + description: Similar to 'Dynamic Group', but with multiple child groups. Entities are added to the child groups based on a supplied filter. - id: org.apache.brooklyn.entity.group.DynamicFabric item: type: org.apache.brooklyn.entity.group.DynamicFabric + name: Dynamic Fabric + description: The 'fabric' creates and starts an entity in each of its locations. - itemType: enricher items: @@ -66,51 +92,78 @@ brooklyn.catalog: itemType: enricher item: type: org.apache.brooklyn.core.network.OnPublicNetworkEnricher + name: Public Network Advertiser + description: Advertises entity's public mapped ports. This can be used with sensors of type URI, HostAndPort or plain integer port values - id: org.apache.brooklyn.core.network.OnSubnetNetworkEnricher itemType: enricher item: type: org.apache.brooklyn.core.network.OnSubnetNetworkEnricher + name: Subnet Network Advertiser + description: Advertises entity's subnet mapped ports. This can be used with sensors of type URI, HostAndPort or plain integer port values - id: org.apache.brooklyn.enricher.stock.Aggregator itemType: enricher item: type: org.apache.brooklyn.enricher.stock.Aggregator + name: Aggregator + description: Aggregates sensors from multiple entities into a single sensor value - id: org.apache.brooklyn.enricher.stock.Combiner itemType: enricher item: type: org.apache.brooklyn.enricher.stock.Combiner + name: Combiner + description: Combines and apply a transformation to sensors of an entity - id: org.apache.brooklyn.enricher.stock.Joiner itemType: enricher item: type: org.apache.brooklyn.enricher.stock.Joiner + name: Joiner + description: Joins entity's sensors into another one, i.e. creates a comma separated string from a list - id: org.apache.brooklyn.enricher.stock.MapAggregator itemType: enricher item: type: org.apache.brooklyn.enricher.stock.MapAggregator + name: Map Aggregator + description: Aggregates a pair of sensors on multiple children and/or members that are used as key-value pairs in a generated Map - id: org.apache.brooklyn.enricher.stock.PercentageEnricher itemType: enricher item: type: org.apache.brooklyn.enricher.stock.PercentageEnricher + name: Percentage Transformer + description: Computes and advertises the percentage based on a current and total values - id: org.apache.brooklyn.enricher.stock.Propagator itemType: enricher item: type: org.apache.brooklyn.enricher.stock.Propagator + name: Propagator + description: Propagates sensors from one entity to another - id: org.apache.brooklyn.enricher.stock.Transformer itemType: enricher item: type: org.apache.brooklyn.enricher.stock.Transformer + name: Transformer + description: Transforms sensors of an entity - id: org.apache.brooklyn.enricher.stock.UpdatingMap itemType: enricher item: type: org.apache.brooklyn.enricher.stock.UpdatingMap + name: Map Updater + description: Updates an entry in a sensor Map - id: org.apache.brooklyn.enricher.stock.YamlRollingTimeWindowMeanEnricher itemType: enricher item: type: org.apache.brooklyn.enricher.stock.YamlRollingTimeWindowMeanEnricher + name: YAML Rolling Average + description: Transforms sensor data into a rolling average based on a time window.") - id: org.apache.brooklyn.enricher.stock.YamlTimeWeightedDeltaEnricher itemType: enricher item: type: org.apache.brooklyn.enricher.stock.YamlTimeWeightedDeltaEnricher + name: YAML Time-weighted Delta + description: Converts an absolute count sensor into a delta sensor - id: org.apache.brooklyn.enricher.stock.reducer.Reducer itemType: enricher item: - type: org.apache.brooklyn.enricher.stock.reducer.Reducer \ No newline at end of file + type: org.apache.brooklyn.enricher.stock.reducer.Reducer + name: Reducer + description: Applies a transformation to a sensor + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/651f63c7/policy/src/main/resources/catalog.bom ---------------------------------------------------------------------- diff --git a/policy/src/main/resources/catalog.bom b/policy/src/main/resources/catalog.bom index fc637d0..d92b836 100644 --- a/policy/src/main/resources/catalog.bom +++ b/policy/src/main/resources/catalog.bom @@ -16,77 +16,92 @@ # under the License. brooklyn.catalog: - version: "0.12.0-SNAPSHOT" # BROOKLYN_VERSION + version: "0.12.0-SNAPSHOT" # BROOKLYN_VERSION + items: + + - itemType: policy items: - id: org.apache.brooklyn.policy.ha.ConnectionFailureDetector - itemType: policy item: type: org.apache.brooklyn.policy.ha.ConnectionFailureDetector name: Connection Failure Detector - description: HA policy for monitoring a host:port, + description: HA policy for monitoring a host:port, emitting an event if the connection is lost/restored - id: org.apache.brooklyn.policy.ha.ServiceRestarter - itemType: policy item: type: org.apache.brooklyn.policy.ha.ServiceRestarter name: Service Restarter - description: HA policy for restarting a service automatically, + description: HA policy for restarting a service automatically, and for emitting an events if the service repeatedly fails - id: org.apache.brooklyn.policy.ha.SshMachineFailureDetector - itemType: policy item: type: org.apache.brooklyn.policy.ha.SshMachineFailureDetector name: Ssh Connectivity Failure Detector - description: HA policy for monitoring an SshMachine, -# removed from catalog because it cannot currently be configured via catalog mechanisms -# - id: org.apache.brooklyn.policy.followthesun.FollowTheSunPool -# item: -# type: org.apache.brooklyn.policy.followthesun.FollowTheSunPool - - id: org.apache.brooklyn.policy.loadbalancing.BalanceableWorkerPool - itemType: entity - item: - type: org.apache.brooklyn.policy.loadbalancing.BalanceableWorkerPool + description: HA policy for monitoring an SshMachine, emitting an event if the connection is lost/restored - id: org.apache.brooklyn.policy.ha.ServiceReplacer - itemType: policy item: type: org.apache.brooklyn.policy.ha.ServiceReplacer name: Service Replacer description: HA policy for replacing a failed member of a group - - id: org.apache.brooklyn.policy.loadbalancing.ItemsInContainersGroup - itemType: entity - item: - type: org.apache.brooklyn.policy.loadbalancing.ItemsInContainersGroup - id: org.apache.brooklyn.policy.autoscaling.AutoScalerPolicy - itemType: policy item: type: org.apache.brooklyn.policy.autoscaling.AutoScalerPolicy name: Auto-scaler - description: Policy that is attached to a Resizable entity and dynamically + description: | + Policy that is attached to a Resizable entity and dynamically adjusts its size in + response to either keep a metric within a given range, or in response to + POOL_COLD and POOL_HOT events - # Enrichers +# Removed from catalog because 'FollowTheSunPool' cannot currently be configured via catalog mechanisms. +# Also removing associated 'BalanceableWorkerPool' etc as they are only useful with 'FollowTheSunPool' +# - itemType: entity +# items: +# - id: org.apache.brooklyn.policy.followthesun.FollowTheSunPool +# item: +# type: org.apache.brooklyn.policy.followthesun.FollowTheSunPool +# - id: org.apache.brooklyn.policy.loadbalancing.BalanceableWorkerPool +# item: +# type: org.apache.brooklyn.policy.loadbalancing.BalanceableWorkerPool +# - id: org.apache.brooklyn.policy.loadbalancing.ItemsInContainersGroup +# item: +# type: org.apache.brooklyn.policy.loadbalancing.ItemsInContainersGroup + + - itemType: enricher + items: - id: org.apache.brooklyn.policy.enricher.DeltaEnricher - itemType: enricher item: type: org.apache.brooklyn.policy.enricher.DeltaEnricher + name: Delta + description: Converts an absolute sensor into a delta sensor (i.e. the diff between the current and previous value) - id: org.apache.brooklyn.policy.enricher.HttpLatencyDetector - itemType: enricher item: type: org.apache.brooklyn.policy.enricher.HttpLatencyDetector + name: HTTP Latency Detector + description: Computes latency in accessing a URL, normally by periodically polling that URL - id: org.apache.brooklyn.policy.enricher.RollingMeanEnricher - itemType: enricher item: type: org.apache.brooklyn.policy.enricher.RollingMeanEnricher + name: Rolling Mean + description: | + Transforms a sensor into a rolling average based on a fixed window size. + This is useful for smoothing sample type metrics, such as latency or CPU time. - id: org.apache.brooklyn.policy.enricher.RollingTimeWindowMeanEnricher - itemType: enricher item: type: org.apache.brooklyn.policy.enricher.RollingTimeWindowMeanEnricher + name: [DEPRECATED] Rolling Mean in Time Window + description: [DEPRECATED] Prefer YamlRollingTimeWindowMeanEnricher - id: org.apache.brooklyn.policy.enricher.TimeFractionDeltaEnricher - itemType: enricher item: type: org.apache.brooklyn.policy.enricher.TimeFractionDeltaEnricher + name: Time-fraction Delta + description: | + Converts an absolute measure of time into a fraction of time, + based on the delta between consecutive values and the elapsed time between those values. - id: org.apache.brooklyn.policy.enricher.TimeWeightedDeltaEnricher - itemType: enricher item: type: org.apache.brooklyn.policy.enricher.TimeWeightedDeltaEnricher + name: [DEPRECATED] Time Weighted Delta + description: [DEPRECATED] prefer 'YamlTimeWeightedDeltaEnricher' - id: org.apache.brooklyn.policy.ha.ServiceFailureDetector - itemType: enricher item: - type: org.apache.brooklyn.policy.ha.ServiceFailureDetector \ No newline at end of file + type: org.apache.brooklyn.policy.ha.ServiceFailureDetector + name: Service Failure Detector + description: Emits a new sensor if the current entity fails http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/651f63c7/software/base/src/main/resources/catalog.bom ---------------------------------------------------------------------- diff --git a/software/base/src/main/resources/catalog.bom b/software/base/src/main/resources/catalog.bom index 7fafca9..a1ea042 100644 --- a/software/base/src/main/resources/catalog.bom +++ b/software/base/src/main/resources/catalog.bom @@ -27,20 +27,29 @@ brooklyn.catalog: - id: org.apache.brooklyn.entity.software.base.SameServerEntity item: type: org.apache.brooklyn.entity.software.base.SameServerEntity + name: Same Server Entity + description: | + An entity that, on start, will obtain a machine and pass that to each of its children + by calling their start effectors. - id: org.apache.brooklyn.entity.chef.ChefEntity item: type: org.apache.brooklyn.entity.chef.ChefEntity + name: Chef Entity - id: org.apache.brooklyn.entity.brooklynnode.BrooklynEntityMirror item: type: org.apache.brooklyn.entity.brooklynnode.BrooklynEntityMirror name: Brooklyn Entity Mirror - description: Provides an entity which can sit in one brooklyn + description: | + Provides an entity which can sit in one brooklyn + domain and reflect the status of an entity via the REST API of another domain. - id: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess item: type: org.apache.brooklyn.entity.software.base.EmptySoftwareProcess + name: Empty Software Process - id: org.apache.brooklyn.entity.software.base.EmptyWindowsProcess item: type: org.apache.brooklyn.entity.software.base.EmptyWindowsProcess + name: Empty Windows Process - id: org.apache.brooklyn.entity.software.base.VanillaWindowsProcess item: type: org.apache.brooklyn.entity.software.base.VanillaWindowsProcess @@ -49,6 +58,7 @@ brooklyn.catalog: - id: org.apache.brooklyn.entity.java.VanillaJavaApp item: type: org.apache.brooklyn.entity.java.VanillaJavaApp + name: Vanilla Java App - id: org.apache.brooklyn.entity.brooklynnode.BrooklynNode item: type: org.apache.brooklyn.entity.brooklynnode.BrooklynNode @@ -57,9 +67,12 @@ brooklyn.catalog: - id: org.apache.brooklyn.entity.brooklynnode.BrooklynCluster item: type: org.apache.brooklyn.entity.brooklynnode.BrooklynCluster + name: Brooklyn Cluster - id: org.apache.brooklyn.entity.brooklynnode.LocalBrooklynNode item: type: org.apache.brooklyn.entity.brooklynnode.LocalBrooklynNode + name: Local Brooklyn Node + description: An entity that represents the local Brooklyn server. - id: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess item: type: org.apache.brooklyn.entity.software.base.VanillaSoftwareProcess
