org.apache.brooklyn.container.entity.docker

Interface DockerContainer

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, SoftwareProcess, Startable

All Known Subinterfaces:

KubernetesPod, OpenShiftPod

All Known Implementing Classes:

DockerContainerImpl, KubernetesPodImpl, OpenShiftPodImpl

public interface DockerContainer
extends SoftwareProcess

The DockerContainer type is for easily deploying any docker image from the image repository set on the target swarm or docker-engine based location

Example YAML is shown below. Note the different types of the env key in the location config and the docker.container.environment key on the entity. The entity environment variables will override any environment configured on the location. To specify environment variables that will be set when executing SSH commands against the container you should use the shell.env key.

 location:
   docker:
     endpoint: "https://52.29.59.193:3376"
     identity: "~/.certs/cert.pem"
     credential: "~/.certs/key.pem"
     templateOptions:
       networkMode: "brooklyn"
     env:
       - "HTTP_CONFIG_ROOT=/var/httpd"
       - "USE_DEFAULTS=true"
 services:
   - type: org.apache.brooklyn.container.entity.docker.DockerContainer
     brooklyn.config:
       docker.container.imageName: "apache/httpd:latest"
       docker.container.disableSsh: true
       docker.container.inboundPorts:
         - "8080-8081"
       docker.container.environment:
         ENABLE_JMX: false
         ENABLE_SHUTDOWN: false
 

Nested Class Summary

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

SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, SoftwareProcess.StopSoftwareParameters

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

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

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

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

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

Configurable.ConfigurationSupport

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

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static MapConfigKey<java.lang.Object>	CONTAINER_ENVIRONMENT
static ConfigKey<java.lang.Boolean>	DISABLE_SSH
static ConfigKey<java.lang.String>	IMAGE_NAME
static ConfigKey<java.lang.Iterable<java.lang.String>>	INBOUND_TCP_PORTS

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

ADD_OPEN_INBOUND_PORTS_EFFECTOR, ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, 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, OPEN_IPTABLES, 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_PROCESS_IS_RUNNING_POLL_PERIOD, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, START_TIMEOUT, STOP_IPTABLES, STOP_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_VERSION, TEMPLATE_SUBSTITUTIONS

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

RESTART, SERVICE_UP, START, STOP

Method Summary

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

populateServiceNotUpDiagnostics

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

addChild, addChild, addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

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

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

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

config, getConfig

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

restart, start, stop

Field Detail

DISABLE_SSH

static final ConfigKey<java.lang.Boolean> DISABLE_SSH

IMAGE_NAME

static final ConfigKey<java.lang.String> IMAGE_NAME

INBOUND_TCP_PORTS

static final ConfigKey<java.lang.Iterable<java.lang.String>> INBOUND_TCP_PORTS

CONTAINER_ENVIRONMENT

static final MapConfigKey<java.lang.Object> CONTAINER_ENVIRONMENT