package
2.0.0-rc.2+incompatible
Repository: https://github.com/docker/compose-cli.git
Documentation: pkg.go.dev

# Functions

IsAlreadyExistsError returns true if the unwrapped error is ErrAlreadyExists.
IsErrCanceled returns true if the unwrapped error is ErrCanceled.
IsErrNotImplemented returns true if the unwrapped error is ErrNotImplemented.
IsErrParsingFailed returns true if the unwrapped error is ErrParsingFailed.
IsForbiddenError returns true if the unwrapped error is ErrForbidden.
IsNotFoundError returns true if the unwrapped error is ErrNotFound.
IsUnknownError returns true if the unwrapped error is ErrUnknown.
NewServiceProxy produces a ServiceProxy.

# Constants

ConfigFilesLabel stores absolute path to compose project configuration files.
ConfigHashLabel stores configuration hash for a compose service.
ContainerEventAttach is a ContainerEvent of type attach.
ContainerEventExit is a ContainerEvent of type exit.
ContainerEventLog is a ContainerEvent of type log.
ContainerNumberLabel stores the container index of a replicated service.
EnvironmentFileLabel stores absolute path to compose project env file set by `--env-file`.
ExitCodeLoginRequired exit code when command cannot execute because it requires cloud login This will be used by VSCode to detect when creating context if the user needs to login first.
FAILED indicates that stack deployment failed.
ImageDigestLabel stores digest of the container image used to run service.
NetworkLabel allow to track resource related to a compose network.
OneoffLabel stores value 'True' for one-off containers created by `compose run`.
ProjectLabel allow to track resource related to a compose project.
RecreateDiverged to recreate services which configuration diverges from compose model.
RecreateForce to force service container being recreated.
RecreateNever to never recreate existing service containers.
REMOVING indicates that stack is being deleted.
RUNNING indicates that stack is deployed and services are running.
ServiceLabel allow to track resource related to a compose service.
SlugLabel stores unique slug used for one-off container identity.
STARTING indicates that stack is being deployed.
UNKNOWN indicates unknown stack state.
UPDATING indicates that some stack resources are being recreated.
UserCancel user cancelled compose up, we are stopping containers.
VersionLabel stores the compose tool version used to run application.
VolumeLabel allow to track resource related to a compose volume.
WorkingDirLabel stores absolute path to compose project working directory.

# Variables

ComposeVersion is the compose tool version as declared by label VersionLabel.
ErrAlreadyExists is returned when an object already exists.
ErrCanceled is returned when the command was canceled by user.
ErrForbidden is returned when an operation is not permitted.
ErrLoginFailed is returned when login failed.
ErrLoginRequired is returned when login is required for a specific action.
ErrNotFound is returned when an object is not found.
ErrNotImplemented is returned when a backend doesn't implement an action.
ErrParsingFailed is returned when a string cannot be parsed.
ErrUnknown is returned when the error type is unmapped.
ErrWrongContextType is returned when the caller tries to get a context with the wrong type.

# Structs

BuildOptions group options of the Build API.
ContainerEvent notify an event has been collected on source container implementing Service.
ContainerProcSummary holds container processes top data.
ContainerSummary hold high-level description of a container.
ConvertOptions group options of the Convert API.
CopyOptions group options of the cp API.
CreateOptions group options of the Create API.
DownOptions group options of the Down API.
Event is a container runtime event served by Events API.
EventsOptions group options of the Events API.
ImagesOptions group options of the Images API.
ImageSummary holds container image description.
KillOptions group options of the Kill API.
ListOptions group options of the ls API.
LogOptions defines optional parameters for the `Log` API.
PauseOptions group options of the Pause API.
PortOptions group options of the Port API.
PortPublisher hold status about published port.
PsOptions group options of the Ps API.
PullOptions group options of the Pull API.
PushOptions group options of the Push API.
RemoveOptions group options of the Remove API.
RestartOptions group options of the Restart API.
RunOptions group options of the Run API.
ServiceProxy implements Service by delegating to implementation functions.
ServiceStatus hold status about a service.
Stack holds the name and state of a compose application/stack.
StartOptions group options of the Start API.
StopOptions group options of the Stop API.
UpOptions group options of the Up API.

# Interfaces

LogConsumer is a callback to process log messages from services.
Service manages a compose project.

# Type aliases

ContainerEventListener is a callback to process ContainerEvent from services.
Interceptor allow to customize the compose types.Project before the actual Service method is executed.