org.apache.brooklyn.entity.group

Interface DynamicCluster

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

BrooklynClusterImpl, CassandraClusterImpl, CassandraDatacenterImpl, CouchbaseClusterImpl, CouchDBClusterImpl, DynamicClusterImpl, DynamicWebAppClusterImpl, ElasticSearchClusterImpl, HazelcastClusterImpl, LoadBalancerClusterImpl, MongoDBConfigServerClusterImpl, MongoDBReplicaSetImpl, MongoDBRouterClusterImpl, MongoDBShardClusterImpl, MySqlClusterImpl, 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 org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

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

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Resizable

Resizable.InsufficientCapacityException

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.lang.Integer>	CLUSTER_MEMBER_ID
static AttributeSensor<java.lang.Boolean>	CLUSTER_ONE_AND_ALL_MEMBERS_UP
static ConfigKey<java.util.Map>	CUSTOM_CHILD_FLAGS
static ConfigKey<java.lang.Boolean>	ENABLE_AVAILABILITY_ZONES
static BasicNotificationSensor<Entity>	ENTITY_QUARANTINED
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<java.lang.Integer>	MAX_CONCURRENT_CHILD_COMMANDS
static ConfigKey<java.lang.Integer>	MAX_SIZE
static ConfigKey<EntitySpec<?>>	MEMBER_SPEC
static ConfigKey<java.lang.Integer>	NUM_AVAILABILITY_ZONES
static ConfigKey<java.lang.Boolean>	QUARANTINE_FAILED_ENTITIES
static ConfigKey<<any>>	QUARANTINE_FILTER
static AttributeSensor<QuarantineGroup>	QUARANTINE_GROUP
static ConfigKey<<any>>	REMOVAL_STRATEGY
static MethodEffector<java.util.Collection<Entity>>	RESIZE_BY_DELTA
static ConfigKey<java.lang.String>	RESTART_MODE
static AttributeSensor<Lifecycle>	SERVICE_STATE_ACTUAL
static ConfigKey<Duration>	START_TIMEOUT
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 org.apache.brooklyn.entity.group.AbstractGroup

FIRST, GROUP_MEMBERS, MEMBER_DELEGATE_CHILDREN, MEMBER_DELEGATE_NAME_FORMAT, RUNNING_QUORUM_CHECK, UP_QUORUM_CHECK

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Changeable

GROUP_SIZE, MEMBER_ADDED, MEMBER_REMOVED

Fields inherited from interface org.apache.brooklyn.entity.group.Cluster

INITIAL_SIZE

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Resizable

RESIZE

Fields inherited from interface org.apache.brooklyn.core.entity.trait.MemberReplaceable

REPLACE_MEMBER

Method Summary

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	setMemberSpec(EntitySpec<?> memberSpec)
void	setRemovalStrategy(<any> val)
void	setZoneFailureDetector(DynamicCluster.ZoneFailureDetector val)
void	setZonePlacementStrategy(DynamicCluster.NodePlacementStrategy val)

Methods inherited from interface org.apache.brooklyn.entity.group.AbstractGroup

getFirst, setMembers, setMembers

Methods inherited from interface org.apache.brooklyn.api.entity.Group

addChild, addChild, addMember, addMemberChild, addMemberChild, getCurrentSize, getMembers, hasMember, removeMember

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Resizable

getCurrentSize, resize

Methods inherited from interface org.apache.brooklyn.core.entity.trait.MemberReplaceable

replaceMember

Field Detail

RESIZE_BY_DELTA

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

RESTART_MODE

static final ConfigKey<java.lang.String> RESTART_MODE

QUARANTINE_FAILED_ENTITIES

static final ConfigKey<java.lang.Boolean> QUARANTINE_FAILED_ENTITIES

QUARANTINE_FILTER

static final ConfigKey<<any>> QUARANTINE_FILTER

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

REMOVAL_STRATEGY

static final ConfigKey<<any>> 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

CLUSTER_MEMBER_ID

static final ConfigKey<java.lang.Integer> CLUSTER_MEMBER_ID

START_TIMEOUT

static final ConfigKey<Duration> START_TIMEOUT

MAX_SIZE

static final ConfigKey<java.lang.Integer> MAX_SIZE

MAX_CONCURRENT_CHILD_COMMANDS

static final ConfigKey<java.lang.Integer> MAX_CONCURRENT_CHILD_COMMANDS

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

CLUSTER_ONE_AND_ALL_MEMBERS_UP

static final AttributeSensor<java.lang.Boolean> CLUSTER_ONE_AND_ALL_MEMBERS_UP

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(<any> val)

setZonePlacementStrategy

void setZonePlacementStrategy(DynamicCluster.NodePlacementStrategy val)

setZoneFailureDetector

void setZoneFailureDetector(DynamicCluster.ZoneFailureDetector val)

setMemberSpec

void setMemberSpec(EntitySpec<?> memberSpec)

addNode

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