DynamicCluster (Apache Brooklyn)

All Superinterfaces:

AbstractGroup, BrooklynObject, Changeable, Cluster, Configurable, Entity, Group, Identifiable, MemberReplaceable, Resizable, Startable

All Known Subinterfaces:

BrooklynCluster, CassandraCluster, CassandraDatacenter, CouchbaseCluster, CouchDBCluster, DynamicWebAppCluster, ElasticSearchCluster, LoadBalancerCluster, MongoDBConfigServerCluster, MongoDBReplicaSet, MongoDBRouterCluster, MongoDBShardCluster, RiakCluster, ServerPool, ZooKeeperEnsemble

All Known Implementing Classes:

BrooklynClusterImpl, CassandraClusterImpl, CassandraDatacenterImpl, CouchbaseClusterImpl, CouchDBClusterImpl, DynamicClusterImpl, DynamicWebAppClusterImpl, ElasticSearchClusterImpl, LoadBalancerClusterImpl, MongoDBConfigServerClusterImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBShardClusterImpl, RiakClusterImpl, ServerPoolImpl, ZooKeeperEnsembleImpl
```
public interface DynamicCluster
extends AbstractGroup, Cluster, MemberReplaceable
```
A Cluster of entities that can dynamically increase or decrease the number of members.
When quarantine is enabled:
- The cluster will have a child entity named quarantine, which is a Group for nodes that failed to start correctly.
- The cluster's other children will be all nodes in the cluster (that have not been unmanaged/deleted).
- The cluster's members will be all live nodes in the cluster.
- The quarantine group's members will be any problem nodes (all nodes that failed to start correctly)
When quarantine is disabled, the cluster will not have a quarantine child. Nodes that fail to start will be removed from the cluster (i.e. stopped and deleted).
Advanced users will wish to examine the configuration for the DynamicCluster.NodePlacementStrategy and DynamicCluster.ZoneFailureDetector interfaces and their implementations, which are used here to control the placement of nodes in particular availability zones and locations when the cluster is resized.
See Also:
DynamicGroup, DynamicFabric

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface DynamicCluster.NodePlacementStrategy

static interface DynamicCluster.ZoneFailureDetector
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Startable
  Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DynamicCluster.NodePlacementStrategy`
`static interface`	`DynamicCluster.ZoneFailureDetector`

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.util.Collection<java.lang.String>>`	`AVAILABILITY_ZONE_NAMES`
`static AttributeSensor<Entity>`	`CLUSTER`
`static AttributeSensor<java.lang.Boolean>`	`CLUSTER_MEMBER`
`static ConfigKey<java.util.Map>`	`CUSTOM_CHILD_FLAGS`
`static ConfigKey<java.lang.Boolean>`	`ENABLE_AVAILABILITY_ZONES`
`static BasicNotificationSensor<Entity>`	`ENTITY_QUARANTINED`
`static ConfigKey<EntityFactory>`	`FACTORY` Deprecated. since 0.7.0; use `MEMBER_SPEC` instead.
`static AttributeSensor<java.util.Set<Location>>`	`FAILED_SUB_LOCATIONS`
`static ConfigKey<EntitySpec<?>>`	`FIRST_MEMBER_SPEC`
`static ConfigKey<java.lang.Integer>`	`INITIAL_QUORUM_SIZE`
`static ConfigKey<EntitySpec<?>>`	`MEMBER_SPEC`
`static ConfigKey<java.lang.Integer>`	`NUM_AVAILABILITY_ZONES`
`static ConfigKey<java.lang.Boolean>`	`QUARANTINE_FAILED_ENTITIES`
`static AttributeSensor<QuarantineGroup>`	`QUARANTINE_GROUP`
`static ConfigKey<com.google.common.base.Function<java.util.Collection<Entity>,Entity>>`	`REMOVAL_STRATEGY`
`static MethodEffector<java.util.Collection<Entity>>`	`RESIZE_BY_DELTA`
`static AttributeSensor<Lifecycle>`	`SERVICE_STATE_ACTUAL`
`static AttributeSensor<java.util.List<Location>>`	`SUB_LOCATIONS`
`static ConfigKey<DynamicCluster.ZoneFailureDetector>`	`ZONE_FAILURE_DETECTOR`
`static ConfigKey<DynamicCluster.NodePlacementStrategy>`	`ZONE_PLACEMENT_STRATEGY`

Fields inherited from interface brooklyn.entity.basic.AbstractGroup
FIRST, FIRST_MEMBER, GROUP_MEMBERS, MEMBER_DELEGATE_CHILDREN, MEMBER_DELEGATE_NAME_FORMAT, RUNNING_QUORUM_CHECK, UP_QUORUM_CHECK

Fields inherited from interface brooklyn.entity.trait.Changeable
GROUP_SIZE, MEMBER_ADDED, MEMBER_REMOVED

Fields inherited from interface brooklyn.entity.group.Cluster
INITIAL_SIZE

Fields inherited from interface brooklyn.entity.trait.Startable
RESTART, SERVICE_UP, START, STOP

Fields inherited from interface brooklyn.entity.trait.Resizable
RESIZE

Fields inherited from interface brooklyn.entity.trait.MemberReplaceable
REPLACE_MEMBER

Method Summary

Methods
Modifier and Type	Method and Description
`Entity`	`addNode(Location loc, java.util.Map<?,?> extraFlags)`
`java.util.Collection<Entity>`	`resizeByDelta(int delta)` Changes the cluster size by the given number.
`void`	`setFactory(EntityFactory<?> factory)` Deprecated. since 0.7.0; use `setMemberSpec(EntitySpec)`
`void`	`setMemberSpec(EntitySpec<?> memberSpec)`
`void`	`setRemovalStrategy(com.google.common.base.Function<java.util.Collection<Entity>,Entity> val)`
`void`	`setZoneFailureDetector(DynamicCluster.ZoneFailureDetector val)`
`void`	`setZonePlacementStrategy(DynamicCluster.NodePlacementStrategy val)`

Methods inherited from interface brooklyn.entity.basic.AbstractGroup
setMembers, setMembers

Methods inherited from interface brooklyn.entity.Group
addChild, addChild, addMember, addMemberChild, addMemberChild, getCurrentSize, getMembers, hasMember, removeMember

Methods inherited from interface brooklyn.entity.Entity
addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, addTag, clearParent, containsTag, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, getTags, invoke, removeChild, removeEnricher, removeGroup, removePolicy, removeTag, setParent

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

Methods inherited from interface brooklyn.entity.trait.Startable
restart, start, stop

Methods inherited from interface brooklyn.entity.trait.Resizable
getCurrentSize, resize

Methods inherited from interface brooklyn.entity.trait.MemberReplaceable
replaceMember

Field Detail

RESIZE_BY_DELTA

static final MethodEffector<java.util.Collection<Entity>> RESIZE_BY_DELTA

QUARANTINE_FAILED_ENTITIES

static final ConfigKey<java.lang.Boolean> QUARANTINE_FAILED_ENTITIES

SERVICE_STATE_ACTUAL

static final AttributeSensor<Lifecycle> SERVICE_STATE_ACTUAL

ENTITY_QUARANTINED

static final BasicNotificationSensor<Entity> ENTITY_QUARANTINED

QUARANTINE_GROUP

static final AttributeSensor<QuarantineGroup> QUARANTINE_GROUP

INITIAL_QUORUM_SIZE

static final ConfigKey<java.lang.Integer> INITIAL_QUORUM_SIZE

MEMBER_SPEC

static final ConfigKey<EntitySpec<?>> MEMBER_SPEC

FIRST_MEMBER_SPEC

static final ConfigKey<EntitySpec<?>> FIRST_MEMBER_SPEC

FACTORY

@Deprecated
static final ConfigKey<EntityFactory> FACTORY

Deprecated. since 0.7.0; use MEMBER_SPEC instead.

REMOVAL_STRATEGY

static final ConfigKey<com.google.common.base.Function<java.util.Collection<Entity>,Entity>> REMOVAL_STRATEGY

CUSTOM_CHILD_FLAGS

static final ConfigKey<java.util.Map> CUSTOM_CHILD_FLAGS

ENABLE_AVAILABILITY_ZONES

static final ConfigKey<java.lang.Boolean> ENABLE_AVAILABILITY_ZONES

ZONE_FAILURE_DETECTOR

static final ConfigKey<DynamicCluster.ZoneFailureDetector> ZONE_FAILURE_DETECTOR

ZONE_PLACEMENT_STRATEGY

static final ConfigKey<DynamicCluster.NodePlacementStrategy> ZONE_PLACEMENT_STRATEGY

AVAILABILITY_ZONE_NAMES

static final ConfigKey<java.util.Collection<java.lang.String>> AVAILABILITY_ZONE_NAMES

NUM_AVAILABILITY_ZONES

static final ConfigKey<java.lang.Integer> NUM_AVAILABILITY_ZONES

SUB_LOCATIONS

static final AttributeSensor<java.util.List<Location>> SUB_LOCATIONS

FAILED_SUB_LOCATIONS

static final AttributeSensor<java.util.Set<Location>> FAILED_SUB_LOCATIONS

CLUSTER_MEMBER

static final AttributeSensor<java.lang.Boolean> CLUSTER_MEMBER

CLUSTER

static final AttributeSensor<Entity> CLUSTER

Method Detail

resizeByDelta
```
java.util.Collection<Entity> resizeByDelta(int delta)
```
Changes the cluster size by the given number.

Parameters:
delta - number of nodes to add or remove

Returns:
successfully added or removed nodes
See Also:
#grow(int)

setRemovalStrategy

void setRemovalStrategy(com.google.common.base.Function<java.util.Collection<Entity>,Entity> val)

setZonePlacementStrategy

void setZonePlacementStrategy(DynamicCluster.NodePlacementStrategy val)

setZoneFailureDetector

void setZoneFailureDetector(DynamicCluster.ZoneFailureDetector val)

setMemberSpec

void setMemberSpec(EntitySpec<?> memberSpec)

setFactory
```
@Deprecated
void setFactory(EntityFactory<?> factory)
```
Deprecated. since 0.7.0; use setMemberSpec(EntitySpec)

addNode

Entity addNode(Location loc,
             java.util.Map<?,?> extraFlags)

Interface DynamicCluster

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Startable

Field Summary

Fields inherited from interface brooklyn.entity.basic.AbstractGroup

Fields inherited from interface brooklyn.entity.trait.Changeable

Fields inherited from interface brooklyn.entity.group.Cluster

Fields inherited from interface brooklyn.entity.trait.Startable

Fields inherited from interface brooklyn.entity.trait.Resizable

Fields inherited from interface brooklyn.entity.trait.MemberReplaceable

Method Summary

Methods inherited from interface brooklyn.entity.basic.AbstractGroup

Methods inherited from interface brooklyn.entity.Group

Methods inherited from interface brooklyn.entity.Entity

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.entity.trait.Startable

Methods inherited from interface brooklyn.entity.trait.Resizable

Methods inherited from interface brooklyn.entity.trait.MemberReplaceable

Field Detail

RESIZE_BY_DELTA

QUARANTINE_FAILED_ENTITIES

SERVICE_STATE_ACTUAL

ENTITY_QUARANTINED

QUARANTINE_GROUP

INITIAL_QUORUM_SIZE

MEMBER_SPEC

FIRST_MEMBER_SPEC

FACTORY

REMOVAL_STRATEGY

CUSTOM_CHILD_FLAGS

ENABLE_AVAILABILITY_ZONES

ZONE_FAILURE_DETECTOR

ZONE_PLACEMENT_STRATEGY

AVAILABILITY_ZONE_NAMES

NUM_AVAILABILITY_ZONES

SUB_LOCATIONS

FAILED_SUB_LOCATIONS

CLUSTER_MEMBER

CLUSTER

Method Detail

resizeByDelta

setRemovalStrategy

setZonePlacementStrategy

setZoneFailureDetector

setMemberSpec

setFactory

addNode