Skip to content

docker

Docker Compose stacks running on a node. labops owns getting the stack's directory onto the node and running compose there; what is inside the compose file is yours.

See the Docker stacks guide.

Docker

The Docker Compose stacks running on a node.

Key Type Default Description
root_path string required The directory on the node that stacks are copied into; each stack lands in a subdirectory named after it. Must be absolute — it is a path on the node, not on the machine running labops.
stacks map of name → StackEntry required Stacks on this node, keyed by name. Names need not be unique across the whole config — a name matching several nodes makes the docker commands ask for --node rather than guess.

StackEntry

One Docker Compose stack: a local directory of compose files, plus the services it publishes.

labops owns getting that directory onto the node and running compose there. What is inside the compose file is yours.

Key Type Default Description
name string "" Overrides the key this stack is written under. Leave it unset — the usual case — and the key is the name. This is the name you pass to the docker stack commands and the directory the stack is copied into on the node.
config_path path to a directory required The local directory holding this stack's compose files, copied to the node by docker stack sync / deploy. Relative to the config file. The directory must exist, so a typo fails at labops validate.
web_services list of WebService or map of name → integer unset HTTP services this stack exposes. Each entry with a proxy_name becomes a route pointing at the node running the stack.