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
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

api

package

Go to main page

Versions in this module

v0

v0.3.4

Jun 5, 2026

v0.3.3

Jun 5, 2026

v0.3.2

Jun 2, 2026

v0.3.1

Jun 2, 2026

v0.3.0

Jun 2, 2026

v0.2.0

Jun 2, 2026

Changes in this version

+ func NewRegistryDigestResolver() digest.RemoteResolver

type DockerClientProvider

+ func NewDockerClientProvider(options ...client.Opt) DockerClientProvider

type ImagePuller

+ func NewImagePuller(provider DockerClientProvider) ImagePuller

type PendingStore

+ func NewMemoryPendingStore(records ...types.ImageUpdateRecord) PendingStore

type ProjectUpdater

+ func NewDockerComposeProjectUpdater(provider DockerClientProvider) ProjectUpdater

type Service

+ func NewDefaultService() *Service

v0.1.0

Jun 2, 2026

Changes in this version

+ func ResolvePullableImageRef(summaryImage, inspectConfigImage string, repoTags []string) (ref, source string)

+ type Config struct

+ AllowComposeStandaloneFallback bool

+ DockerClientProvider DockerClientProvider

+ EventRecorder EventRecorder

+ ImagePuller ImagePuller

+ LabelPolicy types.LabelPolicy

+ Logger *slog.Logger

+ Notifier Notifier

+ PendingStore PendingStore

+ ProjectUpdater ProjectUpdater

+ RegistryDigestResolver digest.RemoteResolver

+ RunRecorder RunRecorder

+ SelfUpdater SelfUpdater

+ Settings SettingsProvider

+ UsedImageCollector UsedImageCollector

+ type DockerClientProvider interface

+ DockerClient func(ctx context.Context) (*client.Client, error)

+ type EventRecorder interface

+ RecordEvent func(ctx context.Context, event types.Event) error

+ type ImagePuller interface

+ PullImage func(ctx context.Context, imageRef string, progress io.Writer) error

+ type Notifier interface

+ Notify func(ctx context.Context, notification types.Notification) error

+ type PendingStore interface

+ ClearImageUpdateRecord func(ctx context.Context, record types.ImageUpdateRecord) error

+ PendingImageUpdates func(ctx context.Context) ([]types.ImageUpdateRecord, error)

+ type ProjectUpdater interface

+ ProjectByComposeName func(ctx context.Context, composeName string) (types.ComposeProject, error)

+ UpdateServices func(ctx context.Context, projectID string, services []string) error

+ type RunRecorder interface

+ RecordUpdateRun func(ctx context.Context, result types.ResourceResult) error

+ type SelfUpdater interface

+ TriggerSelfUpdate func(ctx context.Context, target types.SelfUpdateTarget) error

+ type Service struct

+ func NewService(config Config) *Service

+ func (s *Service) ApplyPending(ctx context.Context, opts types.Options) (out *types.Result, err error)

+ func (s *Service) BeginContainerUpdate(containerID string) func()

+ func (s *Service) BeginProjectUpdate(projectID string) func()

+ func (s *Service) RestartContainersUsingOldImages(ctx context.Context, oldIDToNewRef map[string]string, ...) ([]types.ResourceResult, error)

+ func (s *Service) Status() types.Status

+ func (s *Service) UpdateContainer(ctx context.Context, containerID string, opts types.Options) (out *types.Result, err error)

+ func (s *Service) UpdateStandaloneContainer(ctx context.Context, cnt container.Summary, inspect container.InspectResponse, ...) error

+ type SettingsProvider interface

+ ExcludedContainers func(ctx context.Context) ([]string, error)

+ type UsedImageCollector interface

+ UsedImages func(ctx context.Context) (map[string]struct{}, error)

+ type UsedImageCollectorFunc func(context.Context) (map[string]struct{}, error)

+ func (f UsedImageCollectorFunc) UsedImages(ctx context.Context) (map[string]struct{}, error)