brooklyn.entity.container.policy

Class ContainerHeadroomEnricher

java.lang.Object

brooklyn.basic.AbstractBrooklynObject

brooklyn.policy.basic.AbstractEntityAdjunct

brooklyn.enricher.basic.AbstractEnricher

brooklyn.entity.container.policy.ContainerHeadroomEnricher

All Implemented Interfaces:

brooklyn.basic.BrooklynObject, brooklyn.basic.BrooklynObjectInternal, brooklyn.entity.rebind.Rebindable, brooklyn.entity.trait.Configurable, brooklyn.entity.trait.Identifiable, brooklyn.policy.Enricher, brooklyn.policy.EntityAdjunct

public class ContainerHeadroomEnricher
extends brooklyn.enricher.basic.AbstractEnricher

An Enricher that emits hot or cold notifications based on the container utilisation and headroom requirements.

This enricher must be applied to the DockerInfrastructure entity, and is normally created during the entity initialisation along with an AutoScalerPolicy. Notifications are fed into the policy, which resizes the child Docker host cluster. Workrates for the policy are calculated as resource utilisation percentages, based on the configured maximum number of containers per host. This is obtained from the MaxContainersPlacementStrategy or through the maxContainers configuration on the infrastructure entity. Workrate thresholds are calculated based on cluster utilisation with the specific headroom available, and the cluster will be resized as appropriate.

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

brooklyn.policy.basic.AbstractEntityAdjunct.AdjunctTagSupport

Nested classes/interfaces inherited from class brooklyn.basic.AbstractBrooklynObject

brooklyn.basic.AbstractBrooklynObject.BasicTagSupport

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

brooklyn.basic.BrooklynObject.TagSupport

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

brooklyn.entity.trait.Configurable.ConfigurationSupport

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

brooklyn.basic.BrooklynObjectInternal.ConfigurationSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static brooklyn.config.ConfigKey<Integer>	CONTAINER_HEADROOM
static brooklyn.config.ConfigKey<Double>	CONTAINER_HEADROOM_PERCENTAGE
static brooklyn.event.AttributeSensor<Integer>	CONTAINERS_NEEDED
static brooklyn.event.basic.BasicNotificationSensor<Map>	DOCKER_CONTAINER_CLUSTER_COLD
static brooklyn.event.basic.BasicNotificationSensor<Map>	DOCKER_CONTAINER_CLUSTER_HOT
static brooklyn.event.basic.BasicNotificationSensor<Map>	DOCKER_CONTAINER_CLUSTER_OK
static brooklyn.event.AttributeSensor<Double>	DOCKER_CONTAINER_UTILISATION

Fields inherited from class brooklyn.enricher.basic.AbstractEnricher

SUPPRESS_DUPLICATES, suppressDuplicates

Fields inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

_subscriptionTracker, adjunctType, configsInternal, entity, execution, leftoverProperties, name, uniqueTag

Constructor Summary

Constructors

Constructor and Description
ContainerHeadroomEnricher()

Method Summary

Methods

Modifier and Type	Method and Description
void	setEntity(brooklyn.entity.basic.EntityLocal entity)

Methods inherited from class brooklyn.enricher.basic.AbstractEnricher

emit, getEnricherType, getRebindSupport, onChanged

Methods inherited from class brooklyn.policy.basic.AbstractEntityAdjunct

check, checkCanSubscribe, checkCanSubscribe, config, configure, destroy, doReconfigureConfig, getAdjunctType, getAllConfig, getAllSubscriptions, getConfig, getConfigMap, getDisplayName, getName, getRequiredConfig, getSubscriptionTracker, getUniqueTag, isDestroyed, isLegacyNoConstructionInit, isRunning, onTagsChanged, setConfig, setDisplayName, setName, subscribe, subscribeToChildren, subscribeToMembers, tags, toString, unsubscribe, unsubscribe

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

configure, getCatalogItemId, getId, getManagementContext, getTagSupport, init, isLegacyConstruction, isRebinding, rebind, requestPersist, setCatalogItemId, setManagementContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.policy.Enricher

getAllConfig, getConfig, getId, getName, setConfig

Methods inherited from interface brooklyn.policy.EntityAdjunct

getUniqueTag, isDestroyed, isRunning

Methods inherited from interface brooklyn.basic.BrooklynObject

getCatalogItemId, getDisplayName, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable

config

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

setCatalogItemId

Field Detail

CONTAINER_HEADROOM

public static final brooklyn.config.ConfigKey<Integer> CONTAINER_HEADROOM

CONTAINER_HEADROOM_PERCENTAGE

public static final brooklyn.config.ConfigKey<Double> CONTAINER_HEADROOM_PERCENTAGE

CONTAINERS_NEEDED

public static final brooklyn.event.AttributeSensor<Integer> CONTAINERS_NEEDED

DOCKER_CONTAINER_UTILISATION

public static final brooklyn.event.AttributeSensor<Double> DOCKER_CONTAINER_UTILISATION

DOCKER_CONTAINER_CLUSTER_HOT

public static final brooklyn.event.basic.BasicNotificationSensor<Map> DOCKER_CONTAINER_CLUSTER_HOT

DOCKER_CONTAINER_CLUSTER_COLD

public static final brooklyn.event.basic.BasicNotificationSensor<Map> DOCKER_CONTAINER_CLUSTER_COLD

DOCKER_CONTAINER_CLUSTER_OK

public static final brooklyn.event.basic.BasicNotificationSensor<Map> DOCKER_CONTAINER_CLUSTER_OK

Constructor Detail

ContainerHeadroomEnricher

public ContainerHeadroomEnricher()

Method Detail

setEntity

public void setEntity(brooklyn.entity.basic.EntityLocal entity)

Overrides:

setEntity in class brooklyn.enricher.basic.AbstractEnricher