clocker.docker.networking.entity.sdn

Interface SdnAgent

All Superinterfaces:

org.apache.brooklyn.api.objs.BrooklynObject, org.apache.brooklyn.api.objs.Configurable, org.apache.brooklyn.api.entity.Entity, org.apache.brooklyn.api.objs.Identifiable, org.apache.brooklyn.entity.software.base.SoftwareProcess, org.apache.brooklyn.core.entity.trait.Startable

All Known Subinterfaces:

CalicoNode, OverlayPlugin, WeaveRouter

All Known Implementing Classes:

CalicoNodeImpl, OverlayPluginImpl, SdnAgentImpl, WeaveRouterImpl

public interface SdnAgent
extends org.apache.brooklyn.entity.software.base.SoftwareProcess

An SDN agent process.

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.core.effector.MethodEffector<InetAddress>	ATTACH_NETWORK
static org.apache.brooklyn.core.effector.MethodEffector<InetAddress>	CREATE_NETWORK
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<DockerHost,DockerHost>	DOCKER_HOST
static org.apache.brooklyn.api.sensor.AttributeSensor<SdnAgent>	SDN_AGENT
static org.apache.brooklyn.api.sensor.AttributeSensor<InetAddress>	SDN_AGENT_ADDRESS
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<SdnProvider,SdnProvider>	SDN_PROVIDER

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

ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, 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_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, START_TIMEOUT, STOP_IPTABLES, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_VERSION

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

RESTART, SERVICE_UP, START, STOP

Method Summary

Methods

Modifier and Type	Method and Description
InetAddress	attachNetwork(String containerId, String networkId) Attach a network to a container.
void	connect(DockerContainer container, VirtualNetwork network)
VirtualNetwork	createNetwork(String networkId) Create a network.
void	deallocateNetwork(VirtualNetwork network)
void	disconnect(DockerContainer container, VirtualNetwork network)
DockerHost	getDockerHost()
String	provisionNetwork(VirtualNetwork network)

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

Field Detail

DOCKER_HOST

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<DockerHost,DockerHost> DOCKER_HOST

SDN_PROVIDER

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<SdnProvider,SdnProvider> SDN_PROVIDER

SDN_AGENT_ADDRESS

static final org.apache.brooklyn.api.sensor.AttributeSensor<InetAddress> SDN_AGENT_ADDRESS

SDN_AGENT

static final org.apache.brooklyn.api.sensor.AttributeSensor<SdnAgent> SDN_AGENT

CREATE_NETWORK

static final org.apache.brooklyn.core.effector.MethodEffector<InetAddress> CREATE_NETWORK

ATTACH_NETWORK

static final org.apache.brooklyn.core.effector.MethodEffector<InetAddress> ATTACH_NETWORK

Method Detail

getDockerHost

DockerHost getDockerHost()

provisionNetwork

String provisionNetwork(VirtualNetwork network)

deallocateNetwork

void deallocateNetwork(VirtualNetwork network)

connect

void connect(DockerContainer container,
           VirtualNetwork network)

disconnect

void disconnect(DockerContainer container,
              VirtualNetwork network)

createNetwork

VirtualNetwork createNetwork(String networkId)

Create a network.

Parameters:

networkId - the network ID to create

Returns:

the VirtualNetwork

attachNetwork

InetAddress attachNetwork(String containerId,
                        String networkId)

Attach a network to a container.

Parameters:

containerId - the container ID

networkId - the network ID to attach

Returns:

the SubnetTier IP address