Module compose

Expand description

Loading compose files: -f a.yaml -f b.yaml, interpolation, defaults.

Structs§

LoadOptions: How to load.
Project: A loaded, interpolated, merged compose project.
SecretValues: Secret values by top-level key. Debug output shows the keys only.

DEFAULT_FILES: File names tried, in order, when no -f is given.
OVERRIDE_FILES: Override files merged over the default file when no -f is given, like docker’s compose.override.yaml.

client_for: A client for the project’s incus project (incus_project: in the file), unless client was already pointed elsewhere explicitly.
dependency_order: Service names with every service after the ones it depends on (ties in name order). A cycle is an error.
down: isb down: delete the selected sandboxes; with volumes (and no service subset), also the file’s non-external named volumes, resolved to the pools up used. In-use volumes are kept and reported.
find_default: Find the default compose file in dir, if any.
find_override: Find the override file in dir, if any.
load: Load from disk using the process environment.
load_docs: Load from in-memory documents. base anchors relative paths and names the default project.
plan: isb plan: what up would change, per selected service.
sanitize_name: Lowercase, [a-z0-9-], squeezed, trimmed; starts with a letter.
up: isb up: ensure each selected service (all when services is empty). Returns (service, report) pairs in order.
up_handles: up, also returning a handle on each sandbox (with its exec defaults), for running its command.
wait_healthy: Probe a service until it passes, within its start period plus retries intervals (at least a minute).