engine

package

v5.7.0 Latest Latest Go to latest Published: Nov 2, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/compose

Links

Open Source Insights

Documentation ¶

Overview ¶

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.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Backend ¶

type Backend interface {
	// APIClient talks to the Docker daemon.
	APIClient() client.APIClient
	// MaxConcurrency bounds the daemon calls made in parallel, 0 meaning no bound.
	MaxConcurrency() int
	// Containers lists the containers of a project, narrowed to services when given.
	Containers(ctx context.Context, projectName string, oneOff OneOff, all bool, services ...string) ([]container.Summary, error)
	// SpecifiedContainer returns the container of a service, the replica with
	// the given index when it is above zero.
	SpecifiedContainer(ctx context.Context, projectName string, oneOff OneOff, all bool, serviceName string, index int) (container.Summary, error)
}

Backend is what every operation needs from the engine: the Docker daemon, the bound on the calls made to it, and the containers of a project.

type OneOff ¶

type OneOff int

OneOff tells whether the containers of `compose run` are part of a listing.

const (
	// OneOffInclude lists the one-off containers along with the services' ones.
	OneOffInclude OneOff = iota
	// OneOffExclude leaves the one-off containers out.
	OneOffExclude
)

Source Files ¶

View all Source files

engine.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL