Documentation
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package build implements the build of the images of a project's services, with BuildKit through the buildx bake plugin or with the classic builder.
|
Package build implements the build of the images of a project's services, with BuildKit through the buildx bake plugin or with the classic builder. |
|
Package concurrency holds the helpers Compose uses to bound how many operations run at once, driven by the --parallel setting.
|
Package concurrency holds the helpers Compose uses to bound how many operations run at once, driven by the --parallel setting. |
|
Package confighash computes the configuration hashes that Compose stamps on the containers, networks and volumes it creates, and compares against on the next run to detect a configuration change.
|
Package confighash computes the configuration hashes that Compose stamps on the containers, networks and volumes it creates, and compares against on the next run to detect a configuration change. |
|
Package containerops implements the operations that act from the outside on the container of a service: exec, cp, export and commit.
|
Package containerops implements the operations that act from the outside on the container of a service: exec, cp, export and commit. |
|
Package depgraph builds the dependency graph of a project's services and walks it in (reverse) dependency order, optionally in parallel.
|
Package depgraph builds the dependency graph of a project's services and walks it in (reverse) dependency order, optionally in parallel. |
|
Package devwatch implements the development loop of a project: the develop.watch triggers that sync, restart or rebuild services as the files they come from change.
|
Package devwatch implements the development loop of a project: the develop.watch triggers that sync, restart or rebuild services as the files they come from change. |
|
Package engine describes what the operations extracted out of pkg/compose need from the engine they run against, so that they all state it the same way.
|
Package engine describes what the operations extracted out of pkg/compose need from the engine they run against, so that they all state it the same way. |
|
Package envresolver resolves environment variables the way the platform does: case-sensitively, except on Windows.
|
Package envresolver resolves environment variables the way the platform does: case-sensitively, except on Windows. |
|
Package images implements the operations on the images of a project: listing the images its containers run, working out the identity of a local image, and removing the images `down` and `watch` leave behind.
|
Package images implements the operations on the images of a project: listing the images its containers run, working out the identity of a local image, and removing the images `down` and `watch` leave behind. |
|
Package inspect implements the read-only operations that report on a project and its resources: ps, ls, top, port, volumes, events and viz.
|
Package inspect implements the read-only operations that report on a project and its resources: ps, ls, top, port, volumes, events and viz. |
|
Package jobsv0 defines the extension point through which the jobs extension exposes its client-facing API on the daemon socket.
|
Package jobsv0 defines the extension point through which the jobs extension exposes its client-facing API on the daemon socket. |
|
protogen
Code generated by mobyextgen.
|
Code generated by mobyextgen. |
|
Package logstream streams the output of the containers of a project to the user: logs, attach, and the monitor of the containers' events they follow.
|
Package logstream streams the output of the containers of a project to the user: logs, attach, and the monitor of the containers' events they follow. |
|
Package naming derives the names Compose uses for the Docker resources it manages.
|
Package naming derives the names Compose uses for the Docker resources it manages. |
|
Package pidfile provides helper functions to create and remove PID files.
|
Package pidfile provides helper functions to create and remove PID files. |
|
Package progress builds the progress events Compose reports while it operates on resources.
|
Package progress builds the progress events Compose reports while it operates on resources. |
|
Package projectloader obtains a Compose project: either by loading and validating the Compose files (LoadProject), or by generating one from existing containers (Generate).
|
Package projectloader obtains a Compose project: either by loading and validating the Compose files (LoadProject), or by generating one from existing containers (Generate). |
|
Package provider runs the provider plugins that manage the services declared with a provider, and speaks the JSON message protocol they use to publish variables and endpoints, and to ask Compose for the service configuration, the relay information or an image.
|
Package provider runs the provider plugins that manage the services declared with a provider, and speaks the JSON message protocol they use to publish variables and endpoints, and to ask Compose for the service configuration, the relay information or an image. |
|
Package publish implements publishing a Compose application as an OCI artifact: the pre-checks on what it would leak, the layers, and the push.
|
Package publish implements publishing a Compose application as an OCI artifact: the pre-checks on what it would leak, the layers, and the push. |
Click to show internal directories.
Click to hide internal directories.