org.apache.brooklyn.entity.machine.pool

Interface ServerPool

All Superinterfaces:

AbstractGroup, BrooklynObject, Changeable, Cluster, Configurable, DynamicCluster, Entity, Group, Identifiable, LocationOwner<ServerPoolLocation,ServerPool>, MemberReplaceable, Resizable, Startable

All Known Implementing Classes:

ServerPoolImpl

public interface ServerPool
extends DynamicCluster, LocationOwner<ServerPoolLocation,ServerPool>

A preallocated server pool is an entity that other applications can deploy to. Behaving as a cluster, the machines it creates for its members are reused.

Notes:

• The pool does not configure ports appropriately for applications subsequently deployed. If an entity that is to be run in the pool requires any ports open other than port 22 then thoses port should be configured with the INBOUND_PORTS config key as part of the pool's PROVISIONING_PROPERTIES. For example, in YAML:

       - type: org.apache.brooklyn.entity.machine.pool.ServerPool
         brooklyn.config:
           # Suitable for TomcatServers
           provisioning.properties:
           inboundPorts: [22, 31880, 8443, 8080, 31001, 1099]
           

  This is a limitation of Brooklyn that will be addressed in a future release.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.group.DynamicCluster

DynamicCluster.NodePlacementStrategy, 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 MethodEffector<java.util.Collection<Entity>>	ADD_MACHINES_FROM_SPEC
static AttributeSensor<java.lang.Integer>	AVAILABLE_COUNT
static AttributeSensor<java.lang.Integer>	CLAIMED_COUNT
static ConfigKey<java.lang.Integer>	INITIAL_SIZE
static ConfigKey<java.lang.String>	LOCATION_NAME_PREFIX
static ConfigKey<EntitySpec<?>>	MEMBER_SPEC

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

AVAILABILITY_ZONE_NAMES, CLUSTER, CLUSTER_MEMBER, CLUSTER_MEMBER_ID, CLUSTER_ONE_AND_ALL_MEMBERS_UP, CUSTOM_CHILD_FLAGS, ENABLE_AVAILABILITY_ZONES, ENTITY_QUARANTINED, FAILED_SUB_LOCATIONS, FIRST_MEMBER_SPEC, INITIAL_QUORUM_SIZE, MAX_CONCURRENT_CHILD_COMMANDS, MAX_SIZE, NUM_AVAILABILITY_ZONES, QUARANTINE_FAILED_ENTITIES, QUARANTINE_FILTER, QUARANTINE_GROUP, REMOVAL_STRATEGY, RESIZE_BY_DELTA, RESTART_MODE, SERVICE_STATE_ACTUAL, START_TIMEOUT, SUB_LOCATIONS, ZONE_FAILURE_DETECTOR, 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.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

Fields inherited from interface org.apache.brooklyn.core.location.dynamic.LocationOwner

DYNAMIC_LOCATION, DYNAMIC_LOCATION_STATUS, LOCATION_FLAGS, LOCATION_NAME, LOCATION_NAME_SUFFIX, LOCATION_SPEC

Method Summary

Modifier and Type	Method and Description
Entity	addExistingMachine(MachineLocation machine) Sets the pool to use an existing MachineLocation as a member.
java.util.Collection<Entity>	addExistingMachinesFromSpec(java.lang.String spec) Adds additional machines to the pool by resolving the given spec.
MachineLocation	claimMachine(java.util.Map<?,?> flags)
void	releaseMachine(MachineLocation machine)

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

addNode, resizeByDelta, setMemberSpec, setRemovalStrategy, setZoneFailureDetector, setZonePlacementStrategy

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

Methods inherited from interface org.apache.brooklyn.core.location.dynamic.LocationOwner

createLocation, deleteLocation, getDynamicLocation, isLocationAvailable

Field Detail

LOCATION_NAME_PREFIX

static final ConfigKey<java.lang.String> LOCATION_NAME_PREFIX

INITIAL_SIZE

static final ConfigKey<java.lang.Integer> INITIAL_SIZE

AVAILABLE_COUNT

static final AttributeSensor<java.lang.Integer> AVAILABLE_COUNT

CLAIMED_COUNT

static final AttributeSensor<java.lang.Integer> CLAIMED_COUNT

MEMBER_SPEC

static final ConfigKey<EntitySpec<?>> MEMBER_SPEC

ADD_MACHINES_FROM_SPEC

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

Method Detail

claimMachine

MachineLocation claimMachine(java.util.Map<?,?> flags)
                      throws NoMachinesAvailableException

Throws:

NoMachinesAvailableException

releaseMachine

void releaseMachine(MachineLocation machine)

addExistingMachine

Entity addExistingMachine(MachineLocation machine)

Sets the pool to use an existing MachineLocation as a member. Existing locations will count towards the capacity of the pool but will not be terminated when the pool is stopped.

Parameters:

machine - An existing machine.

Returns:

the new member of the pool, created with the configured MEMBER_SPEC.

addExistingMachinesFromSpec

java.util.Collection<Entity> addExistingMachinesFromSpec(java.lang.String spec)

Adds additional machines to the pool by resolving the given spec.

Parameters:

spec - A location spec, e.g. byon:(hosts="user@10.9.1.1,user@10.9.1.2,user@10.9.1.3")

Returns:

the new members of the pool, created with the configured MEMBER_SPEC.