Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

compose

package

Go to main page

Versions in this module

v0

v0.4.0

Jun 24, 2026

Changes in this version

+ func RenderEntrypointWrapper(entrypoints, original []string, escapeDollar bool) []string

type Override

+ CapAdd []string

+ Entrypoints []string

+ Init *bool

+ OriginalEntrypoint []string

+ Privileged *bool

+ SecurityOpt []string

v0.3.0

Jun 2, 2026

v0.2.0

May 18, 2026

Changes in this version

+ const DefaultHealthTimeout

+ const EngineDisplayName

+ const LabelComposeOneoff

+ const LabelComposeProject

+ const LabelComposeService

+ const LabelConfigHash

+ const LabelEngine

+ const LabelImageDigest

+ var ErrComposeUnsupportedOnBackend = errors.New("compose: backend does not support compose source")

+ func ApplyBuildOverride(project *composetypes.Project, primaryService, imageRef string) error

+ func ApplyRunOverride(project *composetypes.Project, primaryService string, ov Override) error

+ func ConfigHash(imageID string, svc composetypes.ServiceConfig) string

+ type CycleError struct

+ Cycle []string

+ func (e *CycleError) Error() string

+ type DownPlan struct

+ Project *composetypes.Project

+ ProjectName string

+ RemoveImages bool

+ RemoveVolumes bool

+ type HealthTimeoutError struct

+ Condition string

+ Service string

+ Waited string

+ func (e *HealthTimeoutError) Error() string

+ type Level []string

+ func TopoSort(project *composetypes.Project) ([]Level, error)

+ type Orchestrator struct

+ BackendName string

+ HealthTimeout time.Duration

+ PollInterval time.Duration

+ func NewOrchestrator(rt runtime.Runtime, backendName string) *Orchestrator

+ func (o *Orchestrator) Down(ctx context.Context, plan *DownPlan) error

+ func (o *Orchestrator) Up(ctx context.Context, plan *Plan) (UpResult, error)

+ type PartialUpError struct

+ Err error

+ Failed string

+ Started []string

+ func (e *PartialUpError) Error() string

+ func (e *PartialUpError) Unwrap() error

+ type Plan struct

+ Labels map[string]string

+ Project *composetypes.Project

+ ProjectName string

+ Services []string

+ func (p *Plan) Validate(backendName string, caps runtime.Capabilities) error

+ type UnsupportedFeatureOnBackendError struct

+ Backend string

+ Capability string

+ Detail string

+ Service string

+ func (e *UnsupportedFeatureOnBackendError) Error() string

+ type UnsupportedField struct

+ Field string

+ Reason string

+ Service string

+ type UnsupportedFieldError struct

+ Fields []UnsupportedField

+ func (e *UnsupportedFieldError) Error() string

+ type UpResult struct

+ ContainerIDs map[string]string

+ Network string

+ type VolumeSharedAcrossServicesError struct

+ Services []string

+ Volume string

+ func (e *VolumeSharedAcrossServicesError) Error() string

v0.1.4

May 13, 2026

v0.1.3

May 13, 2026

v0.1.2

May 12, 2026

v0.1.1

May 11, 2026

Changes in this version

+ func Load(ctx context.Context, opts LoadOptions) (*composetypes.Project, error)

+ func PrimaryService(project *composetypes.Project, name string) (*composetypes.ServiceConfig, error)

+ func WriteBuildOverride(dst string, ov Override) error

+ func WriteRunOverride(dst string, project *composetypes.Project, ov Override) error

+ type BindMount struct

+ ReadOnly bool

+ Source string

+ Target string

+ type LoadOptions struct

+ Env []string

+ Files []string

+ Profiles []string

+ ProjectName string

+ WorkingDir string

+ type Override struct

+ ExtraBindMounts []BindMount

+ ExtraEnvironment map[string]string

+ Image string

+ Labels map[string]string

+ Service string

v0.1.0

May 11, 2026