brooklyn.entity.container.docker

Interface DockerHost

All Superinterfaces:

brooklyn.basic.BrooklynObject, brooklyn.entity.basic.EmptySoftwareProcess, brooklyn.entity.Entity, brooklyn.entity.trait.HasShortName, brooklyn.entity.trait.Identifiable, brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>, brooklyn.entity.machine.MachineEntity, brooklyn.entity.trait.Resizable, brooklyn.entity.basic.SoftwareProcess, brooklyn.entity.trait.Startable

All Known Implementing Classes:

DockerHostImpl

public interface DockerHost
extends brooklyn.entity.machine.MachineEntity, brooklyn.entity.trait.Resizable, brooklyn.entity.trait.HasShortName, brooklyn.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

A single machine running Docker.

This entity controls the DockerHostLocation location, and creates and wraps a JcloudsLocatiopn representing the API for the Docker service on this machine.

Nested Class Summary

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

brooklyn.entity.basic.SoftwareProcess.ChildStartableMode

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

brooklyn.basic.BrooklynObject.TagSupport

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

brooklyn.entity.trait.Startable.StartEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static brooklyn.entity.basic.MethodEffector<String>	CREATE_SSHABLE_IMAGE
static brooklyn.entity.basic.MethodEffector<String>	DEPLOY_ARCHIVE
static brooklyn.config.ConfigKey<Double>	DOCKER_CONTAINER_CLUSTER_MAX_CPU
static brooklyn.config.ConfigKey<Integer>	DOCKER_CONTAINER_CLUSTER_MAX_SIZE
static brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.proxying.EntitySpec,brooklyn.entity.proxying.EntitySpec>	DOCKER_CONTAINER_SPEC
static brooklyn.event.basic.AttributeSensorAndConfigKey<String,String>	DOCKER_HARDWARE_ID
static brooklyn.config.ConfigKey<String>	DOCKER_HOST_AFFINITY_RULES
static brooklyn.event.AttributeSensor<String>	DOCKER_HOST_NAME
static brooklyn.event.basic.AttributeSensorAndConfigKey<Map<String,String>,Map<String,String>>	DOCKER_HOST_VOLUME_MAPPING
static brooklyn.event.basic.AttributeSensorAndConfigKey<String,String>	DOCKER_IMAGE_ID
static brooklyn.event.AttributeSensor<String>	DOCKER_IMAGE_NAME
static brooklyn.event.basic.AttributeSensorAndConfigKey<DockerInfrastructure,DockerInfrastructure>	DOCKER_INFRASTRUCTURE
static brooklyn.config.ConfigKey<String>	DOCKER_PASSWORD
static brooklyn.event.basic.PortAttributeSensorAndConfigKey	DOCKER_PORT
static brooklyn.event.basic.AttributeSensorAndConfigKey<String,String>	DOCKER_REPOSITORY
static brooklyn.event.basic.PortAttributeSensorAndConfigKey	DOCKER_SSL_PORT
static brooklyn.event.basic.AttributeSensorAndConfigKey<String,String>	DOWNLOAD_URL
static brooklyn.config.ConfigKey<? extends String>	EPEL_RELEASE
static brooklyn.config.ConfigKey<Boolean>	HA_POLICY_ENABLE
static brooklyn.config.ConfigKey<String>	HOST_NAME_FORMAT
static brooklyn.entity.basic.MethodEffector<String>	RUN_DOCKER_COMMAND
static brooklyn.entity.basic.MethodEffector<String>	RUN_DOCKER_COMMAND_TIMEOUT
static brooklyn.config.ConfigKey<brooklyn.util.time.Duration>	START_TIMEOUT
static brooklyn.config.ConfigKey<String>	SUGGESTED_VERSION

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, EXPANDED_INSTALL_DIR, HOSTNAME, INSTALL_DIR, INSTALL_LATCH, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, PID_FILE, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_INSTALL_COMMAND, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, RESOURCES_LATCH, RUN_DIR, RUNTIME_FILES, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_STATE_ACTUAL, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_INSTALLATION, START_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR

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_FLAGS, LOCATION_NAME, LOCATION_NAME_PREFIX, LOCATION_NAME_SUFFIX, LOCATION_SPEC

Method Summary

Methods

Modifier and Type	Method and Description
String	createSshableImage(String dockerFile, String name) Create an SSHable image and returns the image ID.
String	deployArchive(String url) Upload an archive file to the host and expand it, for export to a container.
brooklyn.entity.group.DynamicCluster	getDockerContainerCluster()
List<brooklyn.entity.Entity>	getDockerContainerList()
String	getDockerHostName()
Integer	getDockerPort()
DockerInfrastructure	getInfrastructure()
brooklyn.location.jclouds.JcloudsLocation	getJcloudsLocation()
String	getPassword()
brooklyn.networking.subnet.PortForwarder	getPortForwarder()
String	getRepository()
brooklyn.networking.subnet.SubnetTier	getSubnetTier()
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.

Methods inherited from interface brooklyn.entity.machine.MachineEntity

execCommand, execCommandTimeout

Methods inherited from interface brooklyn.entity.basic.EmptySoftwareProcess

getDriver

Methods inherited from interface brooklyn.entity.Entity

addChild, addChild, addEnricher, addEnricher, 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

getTagSupport

Methods inherited from interface brooklyn.entity.trait.Startable

restart, start, stop

Methods inherited from interface brooklyn.entity.trait.Resizable

getCurrentSize, resize

Methods inherited from interface brooklyn.entity.trait.HasShortName

getShortName

Methods inherited from interface brooklyn.location.dynamic.LocationOwner

createLocation, deleteLocation, getDynamicLocation, isLocationAvailable

Field Detail

SUGGESTED_VERSION

static final brooklyn.config.ConfigKey<String> SUGGESTED_VERSION

START_TIMEOUT

static final brooklyn.config.ConfigKey<brooklyn.util.time.Duration> START_TIMEOUT

DOWNLOAD_URL

static final brooklyn.event.basic.AttributeSensorAndConfigKey<String,String> DOWNLOAD_URL

DOCKER_CONTAINER_CLUSTER_MAX_SIZE

static final brooklyn.config.ConfigKey<Integer> DOCKER_CONTAINER_CLUSTER_MAX_SIZE

DOCKER_CONTAINER_CLUSTER_MAX_CPU

static final brooklyn.config.ConfigKey<Double> DOCKER_CONTAINER_CLUSTER_MAX_CPU

HA_POLICY_ENABLE

static final brooklyn.config.ConfigKey<Boolean> HA_POLICY_ENABLE

DOCKER_PORT

static final brooklyn.event.basic.PortAttributeSensorAndConfigKey DOCKER_PORT

DOCKER_SSL_PORT

static final brooklyn.event.basic.PortAttributeSensorAndConfigKey DOCKER_SSL_PORT

DOCKER_CONTAINER_SPEC

static final brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.proxying.EntitySpec,brooklyn.entity.proxying.EntitySpec> DOCKER_CONTAINER_SPEC

DOCKER_INFRASTRUCTURE

static final brooklyn.event.basic.AttributeSensorAndConfigKey<DockerInfrastructure,DockerInfrastructure> DOCKER_INFRASTRUCTURE

HOST_NAME_FORMAT

static final brooklyn.config.ConfigKey<String> HOST_NAME_FORMAT

DOCKER_REPOSITORY

static final brooklyn.event.basic.AttributeSensorAndConfigKey<String,String> DOCKER_REPOSITORY

EPEL_RELEASE

static final brooklyn.config.ConfigKey<? extends String> EPEL_RELEASE

DOCKER_IMAGE_ID

static final brooklyn.event.basic.AttributeSensorAndConfigKey<String,String> DOCKER_IMAGE_ID

DOCKER_IMAGE_NAME

static final brooklyn.event.AttributeSensor<String> DOCKER_IMAGE_NAME

DOCKER_HARDWARE_ID

static final brooklyn.event.basic.AttributeSensorAndConfigKey<String,String> DOCKER_HARDWARE_ID

DOCKER_HOST_VOLUME_MAPPING

static final brooklyn.event.basic.AttributeSensorAndConfigKey<Map<String,String>,Map<String,String>> DOCKER_HOST_VOLUME_MAPPING

DOCKER_HOST_AFFINITY_RULES

static final brooklyn.config.ConfigKey<String> DOCKER_HOST_AFFINITY_RULES

DOCKER_PASSWORD

static final brooklyn.config.ConfigKey<String> DOCKER_PASSWORD

DOCKER_HOST_NAME

static final brooklyn.event.AttributeSensor<String> DOCKER_HOST_NAME

CREATE_SSHABLE_IMAGE

static final brooklyn.entity.basic.MethodEffector<String> CREATE_SSHABLE_IMAGE

RUN_DOCKER_COMMAND

static final brooklyn.entity.basic.MethodEffector<String> RUN_DOCKER_COMMAND

RUN_DOCKER_COMMAND_TIMEOUT

static final brooklyn.entity.basic.MethodEffector<String> RUN_DOCKER_COMMAND_TIMEOUT

DEPLOY_ARCHIVE

static final brooklyn.entity.basic.MethodEffector<String> DEPLOY_ARCHIVE

Method Detail

getRepository

String getRepository()

getPassword

String getPassword()

getDockerPort

Integer getDockerPort()

getJcloudsLocation

brooklyn.location.jclouds.JcloudsLocation getJcloudsLocation()

getPortForwarder

brooklyn.networking.subnet.PortForwarder getPortForwarder()

getSubnetTier

brooklyn.networking.subnet.SubnetTier getSubnetTier()

getDockerHostName

String getDockerHostName()

getDockerContainerCluster

brooklyn.entity.group.DynamicCluster getDockerContainerCluster()

getDockerContainerList

List<brooklyn.entity.Entity> getDockerContainerList()

getInfrastructure

DockerInfrastructure getInfrastructure()

createSshableImage

String createSshableImage(String dockerFile,
                        String name)

Create an SSHable image and returns the image ID.

Parameters:

dockerFile - URL of Dockerfile to copy

name - Repository name

See Also:

DockerHostDriver.buildImage(String, String)

runDockerCommand

String runDockerCommand(String command)

Execute a Docker command and return the output.

Parameters:

command - Docker command

runDockerCommandTimeout

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

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

Parameters:

command - Docker command

timeout - Timeout

deployArchive

String deployArchive(String url)

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

Parameters:

url - Archive source URL