clocker.docker.entity

Interface DockerHost

All Superinterfaces:

org.apache.brooklyn.api.objs.BrooklynObject, org.apache.brooklyn.api.objs.Configurable, org.apache.brooklyn.entity.software.base.EmptySoftwareProcess, org.apache.brooklyn.api.entity.Entity, org.apache.brooklyn.api.objs.HasShortName, org.apache.brooklyn.api.objs.Identifiable, org.apache.brooklyn.core.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>, org.apache.brooklyn.entity.machine.MachineEntity, org.apache.brooklyn.entity.software.base.SoftwareProcess, org.apache.brooklyn.core.entity.trait.Startable

All Known Implementing Classes:

DockerHostImpl

public interface DockerHost
extends org.apache.brooklyn.entity.machine.MachineEntity, org.apache.brooklyn.api.objs.HasShortName, org.apache.brooklyn.core.location.dynamic.LocationOwner<DockerHostLocation,DockerHost>

A single machine running Docker.

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

org.apache.brooklyn.entity.software.base.SoftwareProcess.ChildStartableMode, org.apache.brooklyn.entity.software.base.SoftwareProcess.RestartSoftwareParameters, org.apache.brooklyn.entity.software.base.SoftwareProcess.StopSoftwareParameters

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

org.apache.brooklyn.api.entity.Entity.AdjunctSupport<T extends org.apache.brooklyn.api.objs.EntityAdjunct>, org.apache.brooklyn.api.entity.Entity.EnricherSupport, org.apache.brooklyn.api.entity.Entity.GroupSupport, org.apache.brooklyn.api.entity.Entity.PolicySupport, org.apache.brooklyn.api.entity.Entity.SensorSupport

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

org.apache.brooklyn.core.entity.trait.Startable.RestartEffectorBody, org.apache.brooklyn.core.entity.trait.Startable.StartEffectorBody, org.apache.brooklyn.core.entity.trait.Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.brooklyn.config.ConfigKey<Boolean>	ADD_LOCALHOST_PERMISSION
static org.apache.brooklyn.config.ConfigKey<String>	ARCHIVE_DIRECTORY_NAME_FORMAT
static org.apache.brooklyn.core.effector.MethodEffector<String>	BUILD_IMAGE
static org.apache.brooklyn.core.effector.MethodEffector<String>	DEPLOY_ARCHIVE
static org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.api.entity.Group>	DOCKER_CONTAINER_CLUSTER
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.EntitySpec,org.apache.brooklyn.api.entity.EntitySpec>	DOCKER_CONTAINER_SPEC
static org.apache.brooklyn.config.ConfigKey<Integer>	DOCKER_CONTROL_PLANE_PORT
static org.apache.brooklyn.config.ConfigKey<Integer>	DOCKER_DATA_PLANE_PORT
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_HARDWARE_ID
static org.apache.brooklyn.config.ConfigKey<List<String>>	DOCKER_HOST_AFFINITY_RULES
static org.apache.brooklyn.api.sensor.AttributeSensor<brooklyn.networking.subnet.SubnetTier>	DOCKER_HOST_SUBNET_TIER
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<Map<String,String>,Map<String,String>>	DOCKER_HOST_VOLUME_MAPPING
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_IMAGE_ID
static org.apache.brooklyn.api.sensor.AttributeSensor<String>	DOCKER_IMAGE_NAME
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity>	DOCKER_INFRASTRUCTURE
static org.apache.brooklyn.config.ConfigKey<String>	DOCKER_LOGIN_PASSWORD
static org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey	DOCKER_PORT
static org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey	DOCKER_SSL_PORT
static org.apache.brooklyn.config.ConfigKey<String>	DOCKER_STORAGE_DRIVER
static org.apache.brooklyn.config.ConfigKey<Boolean>	DOCKER_USE_SSH
static org.apache.brooklyn.config.ConfigKey<String>	DOCKER_VERSION
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOWNLOAD_URL
static org.apache.brooklyn.config.ConfigKey<String>	EPEL_RELEASE
static org.apache.brooklyn.api.sensor.AttributeSensor<io.brooklyn.entity.nosql.etcd.EtcdNode>	ETCD_NODE
static org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.location.jclouds.JcloudsLocation>	JCLOUDS_DOCKER_LOCATION
static org.apache.brooklyn.config.ConfigKey<Boolean>	OPEN_IPTABLES
static org.apache.brooklyn.config.ConfigKey<Map<String,Object>>	PROVISIONING_FLAGS
static org.apache.brooklyn.core.effector.MethodEffector<String>	RUN_DOCKER_COMMAND
static org.apache.brooklyn.core.effector.MethodEffector<String>	RUN_DOCKER_COMMAND_TIMEOUT
static org.apache.brooklyn.api.sensor.AttributeSensor<Void>	SCAN
static org.apache.brooklyn.config.ConfigKey<org.apache.brooklyn.util.time.Duration>	SCAN_INTERVAL
static org.apache.brooklyn.config.ConfigKey<org.apache.brooklyn.util.time.Duration>	START_TIMEOUT

Fields inherited from interface org.apache.brooklyn.entity.machine.MachineEntity

EXEC_COMMAND, EXEC_COMMAND_TIMEOUT

Fields inherited from interface org.apache.brooklyn.entity.software.base.EmptySoftwareProcess

USE_SSH_MONITORING

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INBOUND_PORTS_AUTO_INFER, INBOUND_PORTS_CONFIG_REGEX, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, LIFECYCLE_EFFECTOR_TASKS, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, PID_FILE, POST_CUSTOMIZE_COMMAND, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_CUSTOMIZE_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RETRIEVE_USAGE_METRICS, 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, STOP_IPTABLES, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_VERSION

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Fields inherited from interface org.apache.brooklyn.core.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
void	addIpPermissions(Collection<org.jclouds.net.domain.IpPermission> permissions)
String	buildImage(String dockerfile, String entrypoint, String contextArchive, String name, boolean useSsh, Map<String,Object> substitutions) Create an image from a Dockerfile and optional entrypoint script and return the image ID.
void	configureSecurityGroups()
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, org.apache.brooklyn.util.time.Duration timeout) Runs a Unix command on the machine and returns the exit status.
Integer	getCurrentSize()
org.apache.brooklyn.api.entity.Group	getDockerContainerCluster()
List<org.apache.brooklyn.api.entity.Entity>	getDockerContainerList()
Integer	getDockerPort()
Object	getHostMutex()
com.google.common.base.Optional<String>	getImageNamed(String name) As getImageNamed(String, String) and looking for the latest image.
com.google.common.base.Optional<String>	getImageNamed(String name, String tag)
DockerInfrastructure	getInfrastructure()
org.apache.brooklyn.location.jclouds.JcloudsLocation	getJcloudsLocation()
String	getLoginPassword()
brooklyn.networking.subnet.SubnetTier	getSubnetTier()
String	layerSshableImageOn(String baseImage, String tag) Create an SSHable image based on the image with the given name.
String	layerSshableImageOnFullyQualified(String fullyQualifiedName) Create an SSHable image based on the fullyQualifiedName provided
void	removeIpPermissions(Collection<org.jclouds.net.domain.IpPermission> permissions)
String	runDockerCommand(String command) Execute a Docker command and return the output.
String	runDockerCommandTimeout(String command, org.apache.brooklyn.util.time.Duration timeout) Execute a Docker command and return the output, or throw an exception after a timeout.

Methods inherited from interface org.apache.brooklyn.entity.machine.MachineEntity

execCommand, execCommandTimeout

Methods inherited from interface org.apache.brooklyn.entity.software.base.EmptySoftwareProcess

getDriver

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

populateServiceNotUpDiagnostics

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, groups, invoke, policies, relations, removeChild, removeEnricher, removeGroup, removePolicy, sensors, setDisplayName, setParent

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

getCatalogItemId, subscriptions, tags

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

config, getConfig, setConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

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

getShortName

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

createLocation, deleteLocation, getDynamicLocation, isLocationAvailable

Field Detail

DOCKER_VERSION

static final org.apache.brooklyn.config.ConfigKey<String> DOCKER_VERSION

ARCHIVE_DIRECTORY_NAME_FORMAT

static final org.apache.brooklyn.config.ConfigKey<String> ARCHIVE_DIRECTORY_NAME_FORMAT

START_TIMEOUT

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

DOWNLOAD_URL

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOWNLOAD_URL

DOCKER_PORT

static final org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey DOCKER_PORT

DOCKER_SSL_PORT

static final org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey DOCKER_SSL_PORT

DOCKER_CONTROL_PLANE_PORT

static final org.apache.brooklyn.config.ConfigKey<Integer> DOCKER_CONTROL_PLANE_PORT

DOCKER_DATA_PLANE_PORT

static final org.apache.brooklyn.config.ConfigKey<Integer> DOCKER_DATA_PLANE_PORT

OPEN_IPTABLES

static final org.apache.brooklyn.config.ConfigKey<Boolean> OPEN_IPTABLES

DOCKER_USE_SSH

static final org.apache.brooklyn.config.ConfigKey<Boolean> DOCKER_USE_SSH

DOCKER_CONTAINER_SPEC

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.EntitySpec,org.apache.brooklyn.api.entity.EntitySpec> DOCKER_CONTAINER_SPEC

DOCKER_INFRASTRUCTURE

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity> DOCKER_INFRASTRUCTURE

EPEL_RELEASE

static final org.apache.brooklyn.config.ConfigKey<String> EPEL_RELEASE

DOCKER_STORAGE_DRIVER

static final org.apache.brooklyn.config.ConfigKey<String> DOCKER_STORAGE_DRIVER

DOCKER_IMAGE_ID

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_IMAGE_ID

DOCKER_IMAGE_NAME

static final org.apache.brooklyn.api.sensor.AttributeSensor<String> DOCKER_IMAGE_NAME

DOCKER_HARDWARE_ID

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_HARDWARE_ID

DOCKER_HOST_VOLUME_MAPPING

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<Map<String,String>,Map<String,String>> DOCKER_HOST_VOLUME_MAPPING

DOCKER_LOGIN_PASSWORD

static final org.apache.brooklyn.config.ConfigKey<String> DOCKER_LOGIN_PASSWORD

DOCKER_HOST_AFFINITY_RULES

static final org.apache.brooklyn.config.ConfigKey<List<String>> DOCKER_HOST_AFFINITY_RULES

PROVISIONING_FLAGS

static final org.apache.brooklyn.config.ConfigKey<Map<String,Object>> PROVISIONING_FLAGS

SCAN_INTERVAL

static final org.apache.brooklyn.config.ConfigKey<org.apache.brooklyn.util.time.Duration> SCAN_INTERVAL

SCAN

static final org.apache.brooklyn.api.sensor.AttributeSensor<Void> SCAN

DOCKER_CONTAINER_CLUSTER

static final org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.api.entity.Group> DOCKER_CONTAINER_CLUSTER

JCLOUDS_DOCKER_LOCATION

static final org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.location.jclouds.JcloudsLocation> JCLOUDS_DOCKER_LOCATION

DOCKER_HOST_SUBNET_TIER

static final org.apache.brooklyn.api.sensor.AttributeSensor<brooklyn.networking.subnet.SubnetTier> DOCKER_HOST_SUBNET_TIER

ADD_LOCALHOST_PERMISSION

static final org.apache.brooklyn.config.ConfigKey<Boolean> ADD_LOCALHOST_PERMISSION

ETCD_NODE

static final org.apache.brooklyn.api.sensor.AttributeSensor<io.brooklyn.entity.nosql.etcd.EtcdNode> ETCD_NODE

BUILD_IMAGE

static final org.apache.brooklyn.core.effector.MethodEffector<String> BUILD_IMAGE

RUN_DOCKER_COMMAND

static final org.apache.brooklyn.core.effector.MethodEffector<String> RUN_DOCKER_COMMAND

RUN_DOCKER_COMMAND_TIMEOUT

static final org.apache.brooklyn.core.effector.MethodEffector<String> RUN_DOCKER_COMMAND_TIMEOUT

DEPLOY_ARCHIVE

static final org.apache.brooklyn.core.effector.MethodEffector<String> DEPLOY_ARCHIVE

Method Detail

getLoginPassword

String getLoginPassword()

getDockerPort

Integer getDockerPort()

getJcloudsLocation

org.apache.brooklyn.location.jclouds.JcloudsLocation getJcloudsLocation()

getSubnetTier

brooklyn.networking.subnet.SubnetTier getSubnetTier()

getDockerContainerCluster

org.apache.brooklyn.api.entity.Group getDockerContainerCluster()

getDockerContainerList

List<org.apache.brooklyn.api.entity.Entity> getDockerContainerList()

getCurrentSize

Integer getCurrentSize()

getInfrastructure

DockerInfrastructure getInfrastructure()

execCommandStatusTimeout

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

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

See Also:

MachineEntity.execCommandTimeout(String, Duration)

execCommandStatus

int execCommandStatus(String command)

See Also:

execCommandStatusTimeout(String, Duration)

getImageNamed

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

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

getImageNamed

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

Returns:

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

configureSecurityGroups

void configureSecurityGroups()

addIpPermissions

void addIpPermissions(Collection<org.jclouds.net.domain.IpPermission> permissions)

removeIpPermissions

void removeIpPermissions(Collection<org.jclouds.net.domain.IpPermission> permissions)

getHostMutex

Object getHostMutex()

buildImage

String buildImage(String dockerfile,
                String entrypoint,
                String contextArchive,
                String name,
                boolean useSsh,
                Map<String,Object> substitutions)

Create an image from a Dockerfile and optional entrypoint script and return the image ID.

Parameters:

dockerfile - URL of Dockerfile template, or an archive including Dockerfile and all required context

entrypoint - URL of entrypoint script for Dockerfile, may be null

contextArchive - URL of context archive for Dockerfile, may be null

name - Registry name

useSsh - Add SSHable layer after building

substitutions - Extra template substitutions for the Dockerfile

See Also:

DockerHostDriver#buildImage(String, Optional, String, boolean)

layerSshableImageOnFullyQualified

String layerSshableImageOnFullyQualified(String fullyQualifiedName)

Create an SSHable image based on the fullyQualifiedName provided

Parameters:

fullyQualifiedName - The fully qualified name to base the new image on. E.g. quay.io/graemem/myrepo/redis:2

Returns:

the new image's ID

layerSshableImageOn

String layerSshableImageOn(String baseImage,
                         String tag)

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

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

String runDockerCommand(String command)

Execute a Docker command and return the output.

Parameters:

command - Docker command

runDockerCommandTimeout

String runDockerCommandTimeout(String command,
                             org.apache.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