DockerConnector

The Docker connector can spawn one or more instances of a Docker container locally on the StreamFlow node. The units of deployment and binding for this connector correspond to the set of homogeneous container instances, while the unit of scheduling is the single instance.

properties

image (required)

The name of the Docker image to run

type

string

addHost

Add a custom host-to-IP mapping (host:ip)

type

string[]

blkioWeight

Block IO (relative weight), between 10 and 1000, or 0 to disable

type

integer

default

0

blkioWeightDevice

Block IO weight (relative device weight)

type

integer[]

capAdd

Add Linux capabilities

type

string[]

capDrop

Drop Linux capabilities

type

string[]

cgroupParent

Optional parent cgroup for the container

type

string

cidfile

Write the container ID to the file

type

string

containerIds

When referencing an external environment, ids of existing containers must be explicitly listed

type

string[]

cpuPeriod

Limit CPU CFS (Completely Fair Scheduler) period

type

integer

cpuQuota

Limit CPU CFS (Completely Fair Scheduler) quota

type

integer

cpuRTPeriod

Limit CPU real-time period in microseconds

type

integer

cpuRTRuntime

Limit CPU real-time runtime in microseconds

type

integer

cpuShares

CPU shares (relative weight)

type

integer

cpus

Number of CPUs

type

number

cpusetCpus

CPUs in which to allow execution (0-3, 0,1)

type

string

cpusetMems

MEMs in which to allow execution (0-3, 0,1)

type

string

detachKeys

Overrude the key sequence for detaching a container

type

string

device

Add a host device to the container

type

string[]

deviceCgroupRule

Add a rule to the cgroup allowed devices list

type

string[]

deviceReadBps

Limit read rate (bytes per second) from a device

type

string[]

deviceReadIops

Limit read rate (IO per second) from a device

type

string[]

deviceWriteBps

Limit write rate (bytes per second) from a device

type

string[]

deviceWriteIops

Limit write rate (IO per second) from a device

type

string[]

disableContentTrust

Skip image verification

type

boolean

default

True

dns

Set custom DNS servers

type

string[]

dnsOption

Set DNS options

type

string[]

dnsSearch

Set custom DNS search domains

type

string[]

domainname

Container NIS domain name

type

string

entrypoint

Overwrite the default ENTRYPOINT of the image

type

string

env

Set environment variables

type

string[]

envFile

Read in a file of environment variables

type

string[]

expose

Expose a port or a range of ports

type

integer[]

gpus

GPU devices to add to the container (‘all’ to pass all GPUs)

type

string

groupAdd

Add additional groups to join

type

string[]

healthCmd

Command to run to check health

type

string

healthInterval

Time between running the check (ms|s|m|h)

type

string

default

0s

healthRetries

Consecutive failures needed to report unhealthy

type

integer

healthStartPeriod

Start period for the container to initialize before starting health-retries countdown (ms|s|m|h)

type

string

default

0s

healthTimeout

Maximum time to allow one check to run (ms|s|m|h)

type

string

default

0s

hostname

Container host name

type

string

init

Run an init inside the container that forwards signals and reaps processes

type

boolean

default

True

ip

IPv4 address

type

string

ip6

IPv6 address

type

string

ipc

IPC mode to use

type

string

isolation

Container isolation technology

type

string

kernelMemory

Kernel memory limit (bytes)

type

integer

label

Set metadata on a container

type

string[]

labelFile

Read in a line delimited file of labels

type

string[]

link

Add link to another container

type

string[]

linkLocalIP

Contaiener IPv4/IPv6 link-local addresses

type

string[]

logDriver

Logging driver for the container

type

string

logOpt

Log driver options

type

string[]

macAddress

Container MAC address

type

string

memory

Memory limit (bytes)

type

integer

memoryReservation

Memory soft limit

type

integer

memorySwap

Swap limit equal to memory plus swap (-1 to enable unlimited swap)

type

integer

memorySwappiness

Tune container memory swappiness (0 to 100)

type

integer

default

-1

mount

Attach a filesystem mount to the container

type

string[]

network

Connect a container to a network

type

string[]

networkAlias

Attach a network-scoped alias for the container

type

string[]

noHealthcheck

Disable any container-specified HEALTHCHECK

type

boolean

oomKillDisable

Disable OOM Killer

type

boolean

oomScoreAdj

Tune host’s OOM preferences (-1000 to 1000)

type

integer

pid

PID namespace to use

type

string

pidsLimit

Tune container pids limit (-1 for unlimited

type

integer

privileged

Give extended privileges to this container

type

boolean

publish

Publish container ports to the host

type

string[]

publishAll

Publish all exposed ports to random ports

type

boolean

readOnly

Mount the container’s root filesystem as read only

type

boolean

replicas

Number of instances to be co-allocated

type

integer

default

1

resourcesCacheTTL

Available resources cache TTL (in seconds). When such cache expires, the connector performs a new request to check resources availability

type

integer

default

10

restart

Restart policy to apply when a container exists

type

string

default

no

rm

Automatically remove the container when it exits

type

boolean

default

True

runtime

Runtime to use for this container

type

string

securityOpt

Security options

type

string[]

shmSize

Size of /dev/shm

type

integer

sigProxy

Proxy received signals to the process

type

boolean

default

True

stopSignal

Signal to stop a container

type

string

default

SIGTERM

stopTimeout

Timeout (in seconds) to stop a container

type

integer

storageOpt

Storage driver options for the container

type

string[]

sysctl

Sysctl options

type

string[]

tmpfs

Mount a tmpfs directory

type

string[]

transferBufferSize

Buffer size allocated for local and remote data transfers

type

integer

default

16kiB

ulimit

Ulimit options

type

string[]

user

Username or UID (format: <name|uid>[:<group|gid>])

type

string

userns

User namespace to use

type

string

uts

UTS namespace to use

type

string

volume

Bind mount a volume

type

string[]

volumeDriver

Optional volume driver for the container

type

string

volumesFrom

Mount volumes from the specified containers

type

string[]

workdir

Working directory inside the container

type

string