package
2.32.4
Repository: https://github.com/docker/compose.git
Documentation: pkg.go.dev

# Functions

ByExitCode retrieve FailureCategory based on command exit code.
ImageDigestResolver creates a func able to resolve image digest from a docker ref,.
InDependencyOrder applies the function to the services of the project taking in account the dependency order.
InReverseDependencyOrder applies the function to the services of the project in reverse order of dependencies.
NetworkHash computes the configuration hash for a network.
NewComposeService create a local implementation of the compose.Service API.
NewGraph returns the dependency graph of the services.
NewImagePruner creates an ImagePruner object for a project.
NewVertex is the constructor function for the Vertex.
ServiceHash computes the configuration hash for a service.
ToMobyEnv convert into []string.
ToSeconds convert into seconds.
VolumeHash computes the configuration hash for a volume.
No description provided by the author
WrapCategorisedComposeError wraps the error if not nil, otherwise returns nil.
WrapComposeError wraps the error if not nil, otherwise returns nil.

# Constants

No description provided by the author
APISource is sent for API metrics.
BuildFailureStatus failure building image.
CanceledStatus command canceled.
CommandSyntaxFailureStatus failure reading command.
ComposeParseFailureStatus failure while parsing compose file.
ContainerCreated created status.
ContainerDead dead status.
ContainerExited exited status.
ContainerPaused paused status.
ContainerRemoving removing status.
ContainerRestarting restarting status.
ContainerRunning running status.
No description provided by the author
No description provided by the author
No description provided by the author
FailureStatus command failure.
FileNotFoundFailureStatus failure getting compose file.
ImagePruneAll indicates that all project-associated images, including remote images should be removed.
ImagePruneLocal indicates that only images built locally by Compose should be removed.
ImagePruneNone indicates that no project images should be removed.
No description provided by the author
No description provided by the author
PullFailureStatus failure pulling image.
No description provided by the author
ServiceConditionRunningOrHealthy is a service condition on status running or healthy.
Services status flags.
Services status flags.
SuccessStatus command success.
No description provided by the author
No description provided by the author

# Variables

BuildFailure failure while building images.
CommandSyntaxFailure failure for command line syntax.
ComposeParseFailure failure for composefile parse error.
FileNotFoundFailure failure for compose file not found.
PullFailure failure while pulling image.

# Structs

ContainerStdin implement WriteCloser for moby.HijackedResponse.
ContainerStdout implement ReadCloser for moby.HijackedResponse.
Error error to categorize failures and extract metrics info.
FailureCategory struct regrouping metrics failure status and specific exit code.
Graph represents project as service dependencies.
ImagePruneOptions controls the behavior of image pruning.
ImagePruner handles image removal during Compose `down` operations.
Vertex represents a service in the dependencies structure.

# Type aliases

Containers is a set of moby Container.
ImagePruneMode controls how aggressively images associated with the project are removed from the engine.
ServiceStatus indicates the status of a service.