DockerComposeConnector
The DockerCompose connector can spawn complex, multi-container environments described in a Docker Compose file locally on the StreamFlow node. The entire set of services in the Docker Compose file contitutes the unit of deployment, while a single service is the unit of binding. Finally, the single instance of a potentially replicated service is the unit of scheduling.
properties |
||
files (required) |
The files containing the architecture specification |
|
type |
string[] |
|
projectName |
Specify an alternate project name |
|
type |
string |
|
default |
The name of the project directory |
|
verbose |
Show more output |
|
type |
boolean |
|
logLevel |
Set log level (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
|
type |
string |
|
enum |
DEBUG, INFO, WARNING, ERROR, CRITICAL |
|
noAnsi |
Do not print ANSI control characters |
|
type |
boolean |
|
host |
Daemon socket to connect to |
|
type |
string |
|
skipHostnameCheck |
Don’t check the daemon’s hostname against the name specified in the client certificate |
|
type |
boolean |
|
projectDirectory |
Specify an alternate working directory |
|
type |
string |
|
default |
The path of the Compose file |
|
compatibility |
If set, Compose will attempt to convert deploy keys in v3 files to their non-Swarm equivalent |
|
type |
boolean |
|
noDeps |
Don’t start linked services |
|
type |
boolean |
|
forceRecreate |
Recreate containers even if their configuration and image haven’t changed |
|
type |
boolean |
|
alwaysRecreateDeps |
Recreate dependent containers (incompatible with noRecreate) |
|
type |
boolean |
|
noRecreate |
If containers already exist, don’t recreate them (incompatible with forceRecreate and renewAnonVolumes) |
|
type |
boolean |
|
noBuild |
Don’t build an image, even if it’s missing |
|
type |
boolean |
|
noStart |
Don’t start the services after creating them |
|
type |
boolean |
|
build |
Build images before starting containers |
|
type |
boolean |
|
renewAnonVolumes |
Recreate anonymous volumes instead of retrieving data from the previous containers |
|
type |
boolean |
|
removeOrphans |
Remove containers for services not defined in the Compose file |
|
type |
boolean |
|
removeVolumes |
Remove named volumes declared in the volumes section of the Compose file and anonymous volumes attached to containers |
|
type |
boolean |
|
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 |
|
timeout |
Timeout in seconds for container shutdown when attached or when containers are already running |
|
type |
integer |
|
default |
10 |
|
tls |
Use TLS (implied by –tlsverify) |
|
type |
boolean |
|
tlscacert |
Trust certs signed only by this CA |
|
type |
string |
|
tlscert |
Path to TLS certificate file |
|
type |
string |
|
tlskey |
Path to TLS key file |
|
type |
string |
|
tlsverify |
Use TLS and verify the remote |
|
type |
boolean |
|
transferBufferSize |
Buffer size allocated for local and remote data transfers |
|
type |
integer |
|
default |
16kiB |
|