brooklyn.entity.container.docker

Class DockerHostImpl

java.lang.Object

brooklyn.basic.AbstractBrooklynObject

brooklyn.entity.basic.AbstractEntity

brooklyn.entity.basic.SoftwareProcessImpl

brooklyn.entity.basic.EmptySoftwareProcessImpl

brooklyn.entity.machine.MachineEntityImpl

brooklyn.entity.container.docker.DockerHostImpl

All Implemented Interfaces:

brooklyn.basic.BrooklynObject, brooklyn.basic.BrooklynObjectInternal, brooklyn.entity.basic.EmptySoftwareProcess, brooklyn.entity.basic.EntityInternal, brooklyn.entity.basic.EntityLocal, brooklyn.entity.basic.SoftwareProcess, DockerHost, brooklyn.entity.drivers.DriverDependentEntity, brooklyn.entity.Entity, brooklyn.entity.machine.MachineEntity, brooklyn.entity.rebind.Rebindable, brooklyn.entity.trait.Configurable, brooklyn.entity.trait.HasShortName, brooklyn.entity.trait.Identifiable, brooklyn.entity.trait.Resizable, brooklyn.entity.trait.Startable, brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

public class DockerHostImpl
extends brooklyn.entity.machine.MachineEntityImpl
implements DockerHost

The host running the Docker service.

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.entity.basic.SoftwareProcessImpl

brooklyn.entity.basic.SoftwareProcessImpl.UpdatingNotUpFromServiceProcessIsRunning

Nested classes/interfaces inherited from class brooklyn.entity.basic.AbstractEntity

brooklyn.entity.basic.AbstractEntity.BasicConfigurationSupport, brooklyn.entity.basic.AbstractEntity.BasicFeedSupport

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

brooklyn.basic.AbstractBrooklynObject.BasicTagSupport

Nested classes/interfaces inherited from interface brooklyn.entity.basic.SoftwareProcess

brooklyn.entity.basic.SoftwareProcess.ChildStartableMode, brooklyn.entity.basic.SoftwareProcess.RestartSoftwareParameters, brooklyn.entity.basic.SoftwareProcess.StopSoftwareParameters

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.entity.trait.Startable

brooklyn.entity.trait.Startable.RestartEffectorBody, brooklyn.entity.trait.Startable.StartEffectorBody, brooklyn.entity.trait.Startable.StopEffectorBody

Nested classes/interfaces inherited from interface brooklyn.entity.basic.EntityInternal

brooklyn.entity.basic.EntityInternal.FeedSupport

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

brooklyn.basic.BrooklynObjectInternal.ConfigurationSupportInternal

Field Summary

Fields inherited from class brooklyn.entity.basic.SoftwareProcessImpl

connectedSensors

Fields inherited from class brooklyn.entity.basic.AbstractEntity

_subscriptionTracker, CHILD_ADDED, CHILD_REMOVED, EFFECTOR_ADDED, EFFECTOR_CHANGED, EFFECTOR_REMOVED, LOCATION_ADDED, LOCATION_REMOVED, managementSupport, POLICY_ADDED, POLICY_REMOVED, SENSOR_ADDED, SENSOR_REMOVED, tempWorkings

Fields inherited from interface brooklyn.entity.container.docker.DockerHost

CREATE_SSHABLE_IMAGE, DEPLOY_ARCHIVE, DOCKER_CONTAINER_CLUSTER, DOCKER_CONTAINER_SPEC, DOCKER_HARDWARE_ID, DOCKER_HOST_AFFINITY_RULES, DOCKER_HOST_NAME, DOCKER_HOST_NAME_FORMAT, DOCKER_HOST_SUBNET_TIER, DOCKER_HOST_VOLUME_MAPPING, DOCKER_IMAGE_ID, DOCKER_IMAGE_NAME, DOCKER_INFRASTRUCTURE, DOCKER_PASSWORD, DOCKER_PORT, DOCKER_SSL_PORT, DOCKER_STORAGE_DRIVER, DOCKER_VERSION, DOWNLOAD_URL, EPEL_RELEASE, JCLOUDS_DOCKER_LOCATION, OPEN_IPTABLES, PROVISIONING_FLAGS, RUN_DOCKER_COMMAND, RUN_DOCKER_COMMAND_TIMEOUT, SCAN, SCAN_INTERVAL, START_TIMEOUT

Fields inherited from interface brooklyn.entity.machine.MachineEntity

CPU_USAGE, EXEC_COMMAND, EXEC_COMMAND_TIMEOUT, FREE_MEMORY, LOAD_AVERAGE, TOTAL_MEMORY, UPTIME, USED_MEMORY

Fields inherited from interface brooklyn.entity.basic.SoftwareProcess

ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, PID_FILE, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RUN_DIR, RUNTIME_FILES, RUNTIME_RESOURCES_LATCH, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR, SUGGESTED_VERSION

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.location.dynamic.LocationOwner

DYNAMIC_LOCATION, DYNAMIC_LOCATION_STATUS, LOCATION_DEFINITION, LOCATION_FLAGS, LOCATION_NAME, LOCATION_NAME_PREFIX, LOCATION_NAME_SUFFIX, LOCATION_SPEC

Constructor Summary

Constructors

Constructor and Description
DockerHostImpl()

Method Summary

Methods

Modifier and Type	Method and Description
DockerHostLocation	createLocation(Map<String,?> flags) Create a new DockerHostLocation wrapping the machine we are starting in.
String	createSshableImage(String dockerFile, String name) Create an SSHable image and returns the image ID.
void	deleteLocation()
String	deployArchive(String url) Upload an archive file to the host and expand it, for export to a container.
int	execCommandStatus(String command)
int	execCommandStatusTimeout(String command, brooklyn.util.time.Duration timeout) Runs a Unix command on the machine and returns the exit status.
Integer	getCurrentSize()
brooklyn.entity.group.DynamicCluster	getDockerContainerCluster()
List<brooklyn.entity.Entity>	getDockerContainerList()
String	getDockerHostName()
Integer	getDockerPort()
DockerHostDriver	getDriver()
Class<?>	getDriverInterface()
DockerHostLocation	getDynamicLocation()
com.google.common.base.Optional<String>	getImageNamed(String name) As DockerHost.getImageNamed(String, String) and looking for the latest image.
com.google.common.base.Optional<String>	getImageNamed(String name, String tag)
DockerInfrastructure	getInfrastructure()
brooklyn.location.jclouds.JcloudsLocation	getJcloudsLocation()
String	getPassword()
protected Collection<Integer>	getRequiredOpenPorts()
String	getShortName()
brooklyn.networking.subnet.SubnetTier	getSubnetTier()
void	init()
boolean	isLocationAvailable()
String	layerSshableImageOn(String baseImage, String tag) Create an SSHable image based on the image with the given name.
protected Map<String,Object>	obtainProvisioningFlags(brooklyn.location.MachineProvisioningLocation location)
void	postStart()
void	postStop()
protected void	preStart()
void	preStop()
void	rebind()
Integer	resize(Integer desiredSize)
String	runDockerCommand(String command) Execute a Docker command and return the output.
String	runDockerCommandTimeout(String command, brooklyn.util.time.Duration timeout) Execute a Docker command and return the output, or throw an exception after a timeout.
void	scanContainers()

Methods inherited from class brooklyn.entity.machine.MachineEntityImpl

connectSensors, disconnectSensors, execCommand, execCommandTimeout, getMachine

Methods inherited from class brooklyn.entity.basic.SoftwareProcessImpl

callRebindHooks, callStartHooks, checkModifiable, connectServiceUpIsRunning, disconnectServiceUpIsRunning, doInitDriver, doRestart, doRestart, doStart, doStop, getLocalHostname, getMachineOrNull, getProvisioningLocation, initDriver, initEnrichers, newDriver, onManagementStarted, onManagementStarting, postDriverStart, postRebind, postRestart, preRestart, preStopConfirmCustom, restart, setProvisioningLocation, start, startInLocation, startInLocation, startInLocation, startInLocation, stop, waitForEntityStart, waitForServiceUp, waitForServiceUp, waitForServiceUp, waitForServiceUp

Methods inherited from class brooklyn.entity.basic.AbstractEntity

addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addLocations, addPolicy, addPolicy, addTag, clearLocations, clearParent, config, configure, configure, configure, configure, configure, containsTag, destroy, emit, emitInternal, equals, feeds, firstLocation, getAllAttributes, getAllConfig, getAllConfigBag, getApplication, getApplicationId, getAttribute, getAttributeByNameParts, getChildren, getConfig, getConfig, getConfig, getConfig, getConfigMap, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEffector, getEnrichers, getEntityManager, getEntityType, getEntityTypeName, getExecutionContext, getFeedSupport, getGroups, getIconUrl, getLocalConfigBag, getLocations, getManagementContext, getManagementSupport, getMutableEntityType, getParent, getPolicies, getProxy, getProxyIfAvailable, getRebindSupport, getSubscriptionContext, getSubscriptionTracker, getTags, hashCode, invalidateReferences, invoke, invoke, invoke, modifyAttribute, onManagementBecomingMaster, onManagementNoLongerMaster, onManagementStopped, onTagsChanged, refreshInheritedConfig, removeAllEnrichers, removeAllPolicies, removeAttribute, removeChild, removeEnricher, removeGroup, removeLocations, removePolicy, removeTag, requestPersist, resetProxy, setApplication, setAttribute, setAttribute, setAttributeWithoutPublishing, setConfig, setConfig, setConfig, setConfig, setConfig, setConfig, setConfigEvenIfOwned, setConfigEvenIfOwned, setConfigIfValNonNull, setConfigIfValNonNull, setDefaultDisplayName, setDisplayName, setManagementContext, setParent, setProxy, subscribe, subscribeToChildren, subscribeToMembers, toMetadataRecord, toString, toStringHelper, unsubscribe, unsubscribe

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

configure, getCatalogItemId, getId, getTagSupport, isLegacyConstruction, isRebinding, setCatalogItemId, tags

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.entity.machine.MachineEntity

execCommand, execCommandTimeout

Methods inherited from interface brooklyn.entity.Entity

addChild, addChild, 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.basic.BrooklynObjectInternal

setCatalogItemId

Constructor Detail

DockerHostImpl

public DockerHostImpl()

Method Detail

init

public void init()

Overrides:

init in class brooklyn.entity.machine.MachineEntityImpl

getRequiredOpenPorts

protected Collection<Integer> getRequiredOpenPorts()

Overrides:

getRequiredOpenPorts in class brooklyn.entity.basic.SoftwareProcessImpl

obtainProvisioningFlags

protected Map<String,Object> obtainProvisioningFlags(brooklyn.location.MachineProvisioningLocation location)

Overrides:

obtainProvisioningFlags in class brooklyn.entity.basic.SoftwareProcessImpl

resize

public Integer resize(Integer desiredSize)

Specified by:

resize in interface brooklyn.entity.trait.Resizable

getShortName

public String getShortName()

Specified by:

getShortName in interface brooklyn.entity.trait.HasShortName

getCurrentSize

public Integer getCurrentSize()

Specified by:

getCurrentSize in interface brooklyn.entity.trait.Resizable

getDriverInterface

public Class<?> getDriverInterface()

Specified by:

getDriverInterface in interface brooklyn.entity.drivers.DriverDependentEntity

Overrides:

getDriverInterface in class brooklyn.entity.machine.MachineEntityImpl

getDriver

public DockerHostDriver getDriver()

Specified by:

getDriver in interface brooklyn.entity.basic.EmptySoftwareProcess

Specified by:

getDriver in interface brooklyn.entity.drivers.DriverDependentEntity

Overrides:

getDriver in class brooklyn.entity.basic.SoftwareProcessImpl

getDockerPort

public Integer getDockerPort()

Specified by:

getDockerPort in interface DockerHost

getDockerHostName

public String getDockerHostName()

Specified by:

getDockerHostName in interface DockerHost

getDockerContainerList

public List<brooklyn.entity.Entity> getDockerContainerList()

Specified by:

getDockerContainerList in interface DockerHost

getInfrastructure

public DockerInfrastructure getInfrastructure()

Specified by:

getInfrastructure in interface DockerHost

getPassword

public String getPassword()

Specified by:

getPassword in interface DockerHost

createSshableImage

public String createSshableImage(String dockerFile,
                        String name)

Create an SSHable image and returns the image ID.

Specified by:

createSshableImage in interface DockerHost

Parameters:

dockerFile - URL of Dockerfile to copy

name - Repository name

See Also:

DockerHostDriver.buildImage(String, String)

layerSshableImageOn

public String layerSshableImageOn(String baseImage,
                         String tag)

Description copied from interface: DockerHost

Create an SSHable image based on the image with the given name.

Specified by:

layerSshableImageOn in interface DockerHost

Parameters:

baseImage - The parent image to base the new image on, e.g. "tomcat" or "redis"

tag - The tag of the parent image, e.g. "latest"

Returns:

the new image's ID

runDockerCommand

public String runDockerCommand(String command)

Execute a Docker command and return the output.

Specified by:

runDockerCommand in interface DockerHost

Parameters:

command - Docker command

runDockerCommandTimeout

public String runDockerCommandTimeout(String command,
                             brooklyn.util.time.Duration timeout)

Execute a Docker command and return the output, or throw an exception after a timeout.

Specified by:

runDockerCommandTimeout in interface DockerHost

Parameters:

command - Docker command

timeout - Timeout

deployArchive

public String deployArchive(String url)

Upload an archive file to the host and expand it, for export to a container.

Specified by:

deployArchive in interface DockerHost

Parameters:

url - Archive source URL

getDynamicLocation

public DockerHostLocation getDynamicLocation()

Specified by:

getDynamicLocation in interface brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

isLocationAvailable

public boolean isLocationAvailable()

Specified by:

isLocationAvailable in interface brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

getDockerContainerCluster

public brooklyn.entity.group.DynamicCluster getDockerContainerCluster()

Specified by:

getDockerContainerCluster in interface DockerHost

getJcloudsLocation

public brooklyn.location.jclouds.JcloudsLocation getJcloudsLocation()

Specified by:

getJcloudsLocation in interface DockerHost

getSubnetTier

public brooklyn.networking.subnet.SubnetTier getSubnetTier()

Specified by:

getSubnetTier in interface DockerHost

execCommandStatus

public int execCommandStatus(String command)

Specified by:

execCommandStatus in interface DockerHost

See Also:

DockerHost.execCommandStatusTimeout(String, Duration)

execCommandStatusTimeout

public int execCommandStatusTimeout(String command,
                           brooklyn.util.time.Duration timeout)

Description copied from interface: DockerHost

Runs a Unix command on the machine and returns the exit status.

Specified by:

execCommandStatusTimeout in interface DockerHost

See Also:

MachineEntity.execCommandTimeout(String, Duration)

getImageNamed

public com.google.common.base.Optional<String> getImageNamed(String name)

Description copied from interface: DockerHost

As DockerHost.getImageNamed(String, String) and looking for the latest image.

Specified by:

getImageNamed in interface DockerHost

getImageNamed

public com.google.common.base.Optional<String> getImageNamed(String name,
                                                    String tag)

Specified by:

getImageNamed in interface DockerHost

Returns:

an Optional containing the ID of the named and tagged image.

createLocation

public DockerHostLocation createLocation(Map<String,?> flags)

Create a new DockerHostLocation wrapping the machine we are starting in.

Specified by:

createLocation in interface brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

deleteLocation

public void deleteLocation()

Specified by:

deleteLocation in interface brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

preStart

protected void preStart()

Overrides:

preStart in class brooklyn.entity.basic.SoftwareProcessImpl

postStart

public void postStart()

Overrides:

postStart in class brooklyn.entity.basic.SoftwareProcessImpl

rebind

public void rebind()

Overrides:

rebind in class brooklyn.entity.basic.SoftwareProcessImpl

preStop

public void preStop()

Overrides:

preStop in class brooklyn.entity.basic.SoftwareProcessImpl

postStop

public void postStop()

Overrides:

postStop in class brooklyn.entity.basic.SoftwareProcessImpl

scanContainers

public void scanContainers()