clocker.docker.policy

Class ContainerHeadroomEnricher

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.enricher.AbstractEnricher

clocker.docker.policy.ContainerHeadroomEnricher

All Implemented Interfaces:

org.apache.brooklyn.api.mgmt.rebind.Rebindable, org.apache.brooklyn.api.objs.BrooklynObject, org.apache.brooklyn.api.objs.Configurable, org.apache.brooklyn.api.objs.EntityAdjunct, org.apache.brooklyn.api.objs.Identifiable, org.apache.brooklyn.api.sensor.Enricher, org.apache.brooklyn.core.objs.BrooklynObjectInternal

public class ContainerHeadroomEnricher
extends org.apache.brooklyn.core.enricher.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 org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.objs.AbstractEntityAdjunct.AdjunctTagSupport, org.apache.brooklyn.core.objs.AbstractEntityAdjunct.BasicSubscriptionSupport

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractBrooklynObject.BasicTagSupport

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

org.apache.brooklyn.api.objs.BrooklynObject.RelationSupport<T extends org.apache.brooklyn.api.objs.BrooklynObject>, org.apache.brooklyn.api.objs.BrooklynObject.SubscriptionSupport, org.apache.brooklyn.api.objs.BrooklynObject.TagSupport

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

org.apache.brooklyn.api.objs.Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

org.apache.brooklyn.core.objs.BrooklynObjectInternal.ConfigurationSupportInternal, org.apache.brooklyn.core.objs.BrooklynObjectInternal.RelationSupportInternal<T extends org.apache.brooklyn.api.objs.BrooklynObject>, org.apache.brooklyn.core.objs.BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.brooklyn.config.ConfigKey<Boolean>	CLUSTER_TOO_COLD_ENABLED
static org.apache.brooklyn.config.ConfigKey<Integer>	CONTAINER_HEADROOM
static org.apache.brooklyn.config.ConfigKey<Double>	CONTAINER_HEADROOM_PERCENTAGE
static org.apache.brooklyn.api.sensor.AttributeSensor<Integer>	CONTAINERS_NEEDED
static org.apache.brooklyn.core.sensor.BasicNotificationSensor<Map>	DOCKER_CONTAINER_CLUSTER_COLD
static org.apache.brooklyn.core.sensor.BasicNotificationSensor<Map>	DOCKER_CONTAINER_CLUSTER_HOT
static org.apache.brooklyn.core.sensor.BasicNotificationSensor<Map>	DOCKER_CONTAINER_CLUSTER_OK
static org.apache.brooklyn.api.sensor.AttributeSensor<Double>	DOCKER_CONTAINER_UTILISATION

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

SUPPRESS_DUPLICATES, suppressDuplicates

Fields inherited from class org.apache.brooklyn.core.objs.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(org.apache.brooklyn.api.entity.EntityLocal entity)

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

emit, getEnricherType, getRebindSupport, onChanged, relations

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

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

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

configure, getCatalogItemId, getId, getManagementContext, 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 org.apache.brooklyn.api.sensor.Enricher

getId

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

getUniqueTag, isDestroyed, isRunning

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

getCatalogItemId, getDisplayName, subscriptions, tags

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

config, getConfig, setConfig

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

setCatalogItemId

Field Detail

CONTAINER_HEADROOM

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

CONTAINER_HEADROOM_PERCENTAGE

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

CLUSTER_TOO_COLD_ENABLED

public static final org.apache.brooklyn.config.ConfigKey<Boolean> CLUSTER_TOO_COLD_ENABLED

CONTAINERS_NEEDED

public static final org.apache.brooklyn.api.sensor.AttributeSensor<Integer> CONTAINERS_NEEDED

DOCKER_CONTAINER_UTILISATION

public static final org.apache.brooklyn.api.sensor.AttributeSensor<Double> DOCKER_CONTAINER_UTILISATION

DOCKER_CONTAINER_CLUSTER_HOT

public static final org.apache.brooklyn.core.sensor.BasicNotificationSensor<Map> DOCKER_CONTAINER_CLUSTER_HOT

DOCKER_CONTAINER_CLUSTER_COLD

public static final org.apache.brooklyn.core.sensor.BasicNotificationSensor<Map> DOCKER_CONTAINER_CLUSTER_COLD

DOCKER_CONTAINER_CLUSTER_OK

public static final org.apache.brooklyn.core.sensor.BasicNotificationSensor<Map> DOCKER_CONTAINER_CLUSTER_OK

Constructor Detail

ContainerHeadroomEnricher

public ContainerHeadroomEnricher()

Method Detail

setEntity

public void setEntity(org.apache.brooklyn.api.entity.EntityLocal entity)

Overrides:

setEntity in class org.apache.brooklyn.core.enricher.AbstractEnricher