api

Dec 13, 2024

Changes in this version

type CreateOptions

+ AssumeYes bool

Nov 27, 2024

Changes in this version

+ type CommitOptions struct

+ Author string

+ Changes opts.ListOpts

+ Comment string

+ Index int

+ Pause bool

+ Reference string

+ Service string

type Service

+ Commit func(ctx context.Context, projectName string, options CommitOptions) error

Oct 29, 2024

Changes in this version

+ const HookEventLog

+ type ExportOptions struct

+ Index int

+ Output string

+ Service string

+ type GenerateOptions struct

+ Containers []string

+ ProjectName string

type PushOptions

+ ImageMandatory bool

type Service

+ Export func(ctx context.Context, projectName string, options ExportOptions) error

+ Generate func(ctx context.Context, options GenerateOptions) (*types.Project, error)

Jul 17, 2024

Changes in this version

type WatchOptions

+ Prune bool

Apr 24, 2024

Changes in this version

+ type Cascade int

+ const CascadeFail

+ const CascadeIgnore

+ const CascadeStop

type KillOptions

+ All bool

type StartOptions

+ OnExit Cascade

Mar 22, 2024

Changes in this version

type StartOptions

+ NavigationMenu bool

Mar 5, 2024

Changes in this version

+ const WatchLogger

type StartOptions

+ Watch bool

type WatchOptions

+ LogTo LogConsumer

Jan 11, 2024

Changes in this version

+ type AttachOptions struct

+ DetachKeys string

+ Index int

+ NoStdin bool

+ Project *types.Project

+ Proxy bool

+ Service string

type BuildOptions

+ Deps bool

type LogOptions

+ Index int

+ type OCIVersion string

+ const OCIVersion1_0

+ const OCIVersion1_1

type PublishOptions

+ OCIVersion OCIVersion

type Service

+ Attach func(ctx context.Context, projectName string, options AttachOptions) error

Nov 15, 2023

Changes in this version

type PublishOptions

+ ResolveImageDigests bool

Sep 21, 2023

Changes in this version

type CreateOptions

+ Build *BuildOptions

+ type PublishOptions struct

type RestartOptions

+ NoDeps bool

type RunOptions

+ Build *BuildOptions

+ type ScaleOptions struct

+ Services []string

type Service

+ Publish func(ctx context.Context, project *types.Project, repository string, ...) error

+ Scale func(ctx context.Context, project *types.Project, options ScaleOptions) error

type ServiceProxy

+ PublishFn func(ctx context.Context, project *types.Project, repository string, ...) error

+ ScaleFn func(ctx context.Context, project *types.Project, options ScaleOptions) error

+ func (s *ServiceProxy) Publish(ctx context.Context, project *types.Project, repository string, ...) error

+ func (s *ServiceProxy) Scale(ctx context.Context, project *types.Project, options ScaleOptions) error

type WatchOptions

+ Build BuildOptions

Aug 30, 2023

Changes in this version

type ContainerSummary

+ Labels map[string]string

+ LocalVolumes int

+ Mounts []string

+ Names []string

+ Networks []string

+ SizeRootFs int64

+ SizeRw int64

Jul 10, 2023

Changes in this version

type BuildOptions

+ Builder string

type Service

+ Wait func(ctx context.Context, projectName string, options WaitOptions) (int64, error)

type ServiceProxy

+ WaitFn func(ctx context.Context, projectName string, options WaitOptions) (int64, error)

+ func (s *ServiceProxy) Wait(ctx context.Context, projectName string, options WaitOptions) (int64, error)

+ type WaitOptions struct

+ DownProjectOnContainerExit bool

+ Services []string

Jun 21, 2023

Changes in this version

type DownOptions

+ Services []string

type RunOptions

+ CapAdd []string

+ CapDrop []string

May 16, 2023

Changes in this version

type BuildOptions

+ Memory int64

type Service

+ Viz func(ctx context.Context, project *types.Project, options VizOptions) (string, error)

type ServiceProxy

+ VizFn func(ctx context.Context, project *types.Project, options VizOptions) (string, error)

+ func (s *ServiceProxy) Viz(ctx context.Context, project *types.Project, options VizOptions) (string, error)

+ type VizOptions struct

+ IncludeImageName bool

+ IncludeNetworks bool

+ IncludePorts bool

+ Indentation string

Mar 22, 2023

Changes in this version

type BuildOptions

+ func (o BuildOptions) Apply(project *types.Project) error

type RemoveOptions

+ Stop bool

type StartOptions

+ WaitTimeout time.Duration

Feb 8, 2023

Changes in this version

+ const ContainerEventRecreated

+ const ContainerReplaceLabel

+ const DRYRUN_PREFIX

type BuildOptions

+ Push bool

+ type ConfigOptions struct

+ Format string

+ Output string

+ ResolveImageDigests bool

type ContainerEvent

+ ID string

+ type DryRunClient struct

+ func NewDryRunClient(apiClient client.APIClient) *DryRunClient

+ func (d *DryRunClient) BuildCachePrune(ctx context.Context, opts moby.BuildCachePruneOptions) (*moby.BuildCachePruneReport, error)

+ func (d *DryRunClient) BuildCancel(ctx context.Context, id string) error

+ func (d *DryRunClient) CheckpointCreate(ctx context.Context, container string, options moby.CheckpointCreateOptions) error

+ func (d *DryRunClient) CheckpointDelete(ctx context.Context, container string, options moby.CheckpointDeleteOptions) error

+ func (d *DryRunClient) CheckpointList(ctx context.Context, container string, options moby.CheckpointListOptions) ([]moby.Checkpoint, error)

+ func (d *DryRunClient) ClientVersion() string

+ func (d *DryRunClient) Close() error

+ func (d *DryRunClient) ConfigCreate(ctx context.Context, config swarm.ConfigSpec) (moby.ConfigCreateResponse, error)

+ func (d *DryRunClient) ConfigInspectWithRaw(ctx context.Context, name string) (swarm.Config, []byte, error)

+ func (d *DryRunClient) ConfigList(ctx context.Context, options moby.ConfigListOptions) ([]swarm.Config, error)

+ func (d *DryRunClient) ConfigRemove(ctx context.Context, id string) error

+ func (d *DryRunClient) ConfigUpdate(ctx context.Context, id string, version swarm.Version, config swarm.ConfigSpec) error

+ func (d *DryRunClient) ContainerAttach(ctx context.Context, container string, options moby.ContainerAttachOptions) (moby.HijackedResponse, error)

+ func (d *DryRunClient) ContainerCommit(ctx context.Context, container string, options moby.ContainerCommitOptions) (moby.IDResponse, error)

+ func (d *DryRunClient) ContainerCreate(ctx context.Context, config *containerType.Config, ...) (containerType.CreateResponse, error)

+ func (d *DryRunClient) ContainerDiff(ctx context.Context, container string) ([]containerType.ContainerChangeResponseItem, error)

+ func (d *DryRunClient) ContainerExecAttach(ctx context.Context, execID string, config moby.ExecStartCheck) (moby.HijackedResponse, error)

+ func (d *DryRunClient) ContainerExecCreate(ctx context.Context, container string, config moby.ExecConfig) (moby.IDResponse, error)

+ func (d *DryRunClient) ContainerExecInspect(ctx context.Context, execID string) (moby.ContainerExecInspect, error)

+ func (d *DryRunClient) ContainerExecResize(ctx context.Context, execID string, options moby.ResizeOptions) error

+ func (d *DryRunClient) ContainerExecStart(ctx context.Context, execID string, config moby.ExecStartCheck) error

+ func (d *DryRunClient) ContainerExport(ctx context.Context, container string) (io.ReadCloser, error)

+ func (d *DryRunClient) ContainerInspect(ctx context.Context, container string) (moby.ContainerJSON, error)

+ func (d *DryRunClient) ContainerInspectWithRaw(ctx context.Context, container string, getSize bool) (moby.ContainerJSON, []byte, error)

+ func (d *DryRunClient) ContainerKill(ctx context.Context, container, signal string) error

+ func (d *DryRunClient) ContainerList(ctx context.Context, options moby.ContainerListOptions) ([]moby.Container, error)

+ func (d *DryRunClient) ContainerLogs(ctx context.Context, container string, options moby.ContainerLogsOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) ContainerPause(ctx context.Context, container string) error

+ func (d *DryRunClient) ContainerRemove(ctx context.Context, container string, options moby.ContainerRemoveOptions) error

+ func (d *DryRunClient) ContainerRename(ctx context.Context, container, newContainerName string) error

+ func (d *DryRunClient) ContainerResize(ctx context.Context, container string, options moby.ResizeOptions) error

+ func (d *DryRunClient) ContainerRestart(ctx context.Context, container string, options containerType.StopOptions) error

+ func (d *DryRunClient) ContainerStart(ctx context.Context, container string, options moby.ContainerStartOptions) error

+ func (d *DryRunClient) ContainerStatPath(ctx context.Context, container, path string) (moby.ContainerPathStat, error)

+ func (d *DryRunClient) ContainerStats(ctx context.Context, container string, stream bool) (moby.ContainerStats, error)

+ func (d *DryRunClient) ContainerStatsOneShot(ctx context.Context, container string) (moby.ContainerStats, error)

+ func (d *DryRunClient) ContainerStop(ctx context.Context, container string, options containerType.StopOptions) error

+ func (d *DryRunClient) ContainerTop(ctx context.Context, container string, arguments []string) (containerType.ContainerTopOKBody, error)

+ func (d *DryRunClient) ContainerUnpause(ctx context.Context, container string) error

+ func (d *DryRunClient) ContainerUpdate(ctx context.Context, container string, updateConfig containerType.UpdateConfig) (containerType.ContainerUpdateOKBody, error)

+ func (d *DryRunClient) ContainerWait(ctx context.Context, container string, condition containerType.WaitCondition) (<-chan containerType.WaitResponse, <-chan error)

+ func (d *DryRunClient) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (moby.ContainersPruneReport, error)

+ func (d *DryRunClient) CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, moby.ContainerPathStat, error)

+ func (d *DryRunClient) CopyToContainer(ctx context.Context, container, path string, content io.Reader, ...) error

+ func (d *DryRunClient) DaemonHost() string

+ func (d *DryRunClient) DialHijack(ctx context.Context, url, proto string, meta map[string][]string) (net.Conn, error)

+ func (d *DryRunClient) Dialer() func(context.Context) (net.Conn, error)

+ func (d *DryRunClient) DiskUsage(ctx context.Context, options moby.DiskUsageOptions) (moby.DiskUsage, error)

+ func (d *DryRunClient) DistributionInspect(ctx context.Context, imageName, encodedRegistryAuth string) (registry.DistributionInspect, error)

+ func (d *DryRunClient) Events(ctx context.Context, options moby.EventsOptions) (<-chan events.Message, <-chan error)

+ func (d *DryRunClient) HTTPClient() *http.Client

+ func (d *DryRunClient) ImageBuild(ctx context.Context, reader io.Reader, options moby.ImageBuildOptions) (moby.ImageBuildResponse, error)

+ func (d *DryRunClient) ImageCreate(ctx context.Context, parentReference string, options moby.ImageCreateOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) ImageHistory(ctx context.Context, imageName string) ([]image.HistoryResponseItem, error)

+ func (d *DryRunClient) ImageImport(ctx context.Context, source moby.ImageImportSource, ref string, ...) (io.ReadCloser, error)

+ func (d *DryRunClient) ImageInspectWithRaw(ctx context.Context, imageName string) (moby.ImageInspect, []byte, error)

+ func (d *DryRunClient) ImageList(ctx context.Context, options moby.ImageListOptions) ([]moby.ImageSummary, error)

+ func (d *DryRunClient) ImageLoad(ctx context.Context, input io.Reader, quiet bool) (moby.ImageLoadResponse, error)

+ func (d *DryRunClient) ImagePull(ctx context.Context, ref string, options moby.ImagePullOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) ImagePush(ctx context.Context, ref string, options moby.ImagePushOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) ImageRemove(ctx context.Context, imageName string, options moby.ImageRemoveOptions) ([]moby.ImageDeleteResponseItem, error)

+ func (d *DryRunClient) ImageSave(ctx context.Context, images []string) (io.ReadCloser, error)

+ func (d *DryRunClient) ImageSearch(ctx context.Context, term string, options moby.ImageSearchOptions) ([]registry.SearchResult, error)

+ func (d *DryRunClient) ImageTag(ctx context.Context, imageName, ref string) error

+ func (d *DryRunClient) ImagesPrune(ctx context.Context, pruneFilter filters.Args) (moby.ImagesPruneReport, error)

+ func (d *DryRunClient) Info(ctx context.Context) (moby.Info, error)

+ func (d *DryRunClient) NegotiateAPIVersion(ctx context.Context)

+ func (d *DryRunClient) NegotiateAPIVersionPing(ping moby.Ping)

+ func (d *DryRunClient) NetworkConnect(ctx context.Context, networkName, container string, ...) error

+ func (d *DryRunClient) NetworkCreate(ctx context.Context, name string, options moby.NetworkCreate) (moby.NetworkCreateResponse, error)

+ func (d *DryRunClient) NetworkDisconnect(ctx context.Context, networkName, container string, force bool) error

+ func (d *DryRunClient) NetworkInspect(ctx context.Context, networkName string, options moby.NetworkInspectOptions) (moby.NetworkResource, error)

+ func (d *DryRunClient) NetworkInspectWithRaw(ctx context.Context, networkName string, options moby.NetworkInspectOptions) (moby.NetworkResource, []byte, error)

+ func (d *DryRunClient) NetworkList(ctx context.Context, options moby.NetworkListOptions) ([]moby.NetworkResource, error)

+ func (d *DryRunClient) NetworkRemove(ctx context.Context, networkName string) error

+ func (d *DryRunClient) NetworksPrune(ctx context.Context, pruneFilter filters.Args) (moby.NetworksPruneReport, error)

+ func (d *DryRunClient) NodeInspectWithRaw(ctx context.Context, nodeID string) (swarm.Node, []byte, error)

+ func (d *DryRunClient) NodeList(ctx context.Context, options moby.NodeListOptions) ([]swarm.Node, error)

+ func (d *DryRunClient) NodeRemove(ctx context.Context, nodeID string, options moby.NodeRemoveOptions) error

+ func (d *DryRunClient) NodeUpdate(ctx context.Context, nodeID string, version swarm.Version, node swarm.NodeSpec) error

+ func (d *DryRunClient) Ping(ctx context.Context) (moby.Ping, error)

+ func (d *DryRunClient) PluginCreate(ctx context.Context, createContext io.Reader, options moby.PluginCreateOptions) error

+ func (d *DryRunClient) PluginDisable(ctx context.Context, name string, options moby.PluginDisableOptions) error

+ func (d *DryRunClient) PluginEnable(ctx context.Context, name string, options moby.PluginEnableOptions) error

+ func (d *DryRunClient) PluginInspectWithRaw(ctx context.Context, name string) (*moby.Plugin, []byte, error)

+ func (d *DryRunClient) PluginInstall(ctx context.Context, name string, options moby.PluginInstallOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) PluginList(ctx context.Context, filter filters.Args) (moby.PluginsListResponse, error)

+ func (d *DryRunClient) PluginPush(ctx context.Context, name string, registryAuth string) (io.ReadCloser, error)

+ func (d *DryRunClient) PluginRemove(ctx context.Context, name string, options moby.PluginRemoveOptions) error

+ func (d *DryRunClient) PluginSet(ctx context.Context, name string, args []string) error

+ func (d *DryRunClient) PluginUpgrade(ctx context.Context, name string, options moby.PluginInstallOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) RegistryLogin(ctx context.Context, auth moby.AuthConfig) (registry.AuthenticateOKBody, error)

+ func (d *DryRunClient) SecretCreate(ctx context.Context, secret swarm.SecretSpec) (moby.SecretCreateResponse, error)

+ func (d *DryRunClient) SecretInspectWithRaw(ctx context.Context, name string) (swarm.Secret, []byte, error)

+ func (d *DryRunClient) SecretList(ctx context.Context, options moby.SecretListOptions) ([]swarm.Secret, error)

+ func (d *DryRunClient) SecretRemove(ctx context.Context, id string) error

+ func (d *DryRunClient) SecretUpdate(ctx context.Context, id string, version swarm.Version, secret swarm.SecretSpec) error

+ func (d *DryRunClient) ServerVersion(ctx context.Context) (moby.Version, error)

+ func (d *DryRunClient) ServiceCreate(ctx context.Context, service swarm.ServiceSpec, ...) (moby.ServiceCreateResponse, error)

+ func (d *DryRunClient) ServiceInspectWithRaw(ctx context.Context, serviceID string, options moby.ServiceInspectOptions) (swarm.Service, []byte, error)

+ func (d *DryRunClient) ServiceList(ctx context.Context, options moby.ServiceListOptions) ([]swarm.Service, error)

+ func (d *DryRunClient) ServiceLogs(ctx context.Context, serviceID string, options moby.ContainerLogsOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) ServiceRemove(ctx context.Context, serviceID string) error

+ func (d *DryRunClient) ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, ...) (moby.ServiceUpdateResponse, error)

+ func (d *DryRunClient) SwarmGetUnlockKey(ctx context.Context) (moby.SwarmUnlockKeyResponse, error)

+ func (d *DryRunClient) SwarmInit(ctx context.Context, req swarm.InitRequest) (string, error)

+ func (d *DryRunClient) SwarmInspect(ctx context.Context) (swarm.Swarm, error)

+ func (d *DryRunClient) SwarmJoin(ctx context.Context, req swarm.JoinRequest) error

+ func (d *DryRunClient) SwarmLeave(ctx context.Context, force bool) error

+ func (d *DryRunClient) SwarmUnlock(ctx context.Context, req swarm.UnlockRequest) error

+ func (d *DryRunClient) SwarmUpdate(ctx context.Context, version swarm.Version, swarmSpec swarm.Spec, ...) error

+ func (d *DryRunClient) TaskInspectWithRaw(ctx context.Context, taskID string) (swarm.Task, []byte, error)

+ func (d *DryRunClient) TaskList(ctx context.Context, options moby.TaskListOptions) ([]swarm.Task, error)

+ func (d *DryRunClient) TaskLogs(ctx context.Context, taskID string, options moby.ContainerLogsOptions) (io.ReadCloser, error)

+ func (d *DryRunClient) VolumeCreate(ctx context.Context, options volume.CreateOptions) (volume.Volume, error)

+ func (d *DryRunClient) VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error)

+ func (d *DryRunClient) VolumeInspectWithRaw(ctx context.Context, volumeID string) (volume.Volume, []byte, error)

+ func (d *DryRunClient) VolumeList(ctx context.Context, filter filters.Args) (volume.ListResponse, error)

+ func (d *DryRunClient) VolumeRemove(ctx context.Context, volumeID string, force bool) error

+ func (d *DryRunClient) VolumeUpdate(ctx context.Context, volumeID string, version swarm.Version, ...) error

+ func (d *DryRunClient) VolumesPrune(ctx context.Context, pruneFilter filters.Args) (moby.VolumesPruneReport, error)

+ type DryRunKey struct

type Service

+ Config func(ctx context.Context, project *types.Project, options ConfigOptions) ([]byte, error)

+ DryRunMode func(ctx context.Context, dryRun bool) (context.Context, error)

+ Watch func(ctx context.Context, project *types.Project, services []string, ...) error

type ServiceProxy

+ ConfigFn func(ctx context.Context, project *types.Project, options ConfigOptions) ([]byte, error)

+ DryRunModeFn func(ctx context.Context, dryRun bool) (context.Context, error)

+ WatchFn func(ctx context.Context, project *types.Project, services []string, ...) error

+ func (s *ServiceProxy) Config(ctx context.Context, project *types.Project, options ConfigOptions) ([]byte, error)

+ func (s *ServiceProxy) DryRunMode(ctx context.Context, dryRun bool) (context.Context, error)

+ func (s *ServiceProxy) Watch(ctx context.Context, project *types.Project, services []string, ...) error

+ type WatchOptions struct

Jan 5, 2023

Changes in this version

type PullOptions

+ IgnoreBuildable bool

+ type Streams interface

+ Err func() io.Writer

+ In func() *streams.In

+ Out func() *streams.Out

Dec 15, 2022

Changes in this version

+ const ContainerEventErr

type ContainerSummary

+ Created int64

+ Image any

+ Status string

type LogConsumer

+ Err func(containerName, message string)

type Service

+ MaxConcurrency func(parallel int)

type ServiceProxy

+ MaxConcurrencyFn func(parallel int)

+ func (s *ServiceProxy) MaxConcurrency(i int)

Dec 2, 2022

Changes in this version

type ConvertOptions

+ ResolveImageDigests bool

Oct 18, 2022

Changes in this version

type PushOptions

+ Quiet bool

Sep 14, 2022

Changes in this version

+ const ImageBuilderLabel

type LogOptions

+ Project *types.Project

type StartOptions

+ Services []string

Aug 19, 2022

Changes in this version

type KillOptions

+ Project *types.Project

+ RemoveOrphans bool

type PauseOptions

+ Project *types.Project

type PsOptions

+ Project *types.Project

type RemoveOptions

+ Project *types.Project

type RestartOptions

+ Project *types.Project

type RunOptions

+ Project *types.Project

type StopOptions

+ Project *types.Project

Jul 29, 2022

Changes in this version

+ var Separator = "-"

+ func GetImageNameOrDefault(service types.ServiceConfig, projectName string) string

Apr 24, 2022

Changes in this version

type StartOptions

+ Project *types.Project

Mar 31, 2022

Changes in this version

type BuildOptions

+ SSHs []types.SSHKey

Mar 18, 2022

Changes in this version

type RunOptions

+ Interactive bool

Mar 4, 2022

Changes in this version

type Stack

+ ConfigFiles string

Jan 4, 2022

Changes in this version

+ const ContainerEventStopped

Nov 23, 2021

Changes in this version

type RunOptions

+ QuietPull bool

Nov 7, 2021

Changes in this version

type StartOptions

+ Wait bool

Sep 28, 2021

Changes in this version

+ const ConfigFilesLabel

+ const ConfigHashLabel

+ const ContainerEventAttach

+ const ContainerEventExit

+ const ContainerEventLog

+ const ContainerNumberLabel

+ const DependenciesLabel

+ const EnvironmentFileLabel

+ const ExitCodeLoginRequired

+ const FAILED

+ const ImageDigestLabel

+ const NetworkLabel

+ const OneoffLabel

+ const ProjectLabel

+ const REMOVING

+ const RUNNING

+ const RecreateDiverged

+ const RecreateForce

+ const RecreateNever

+ const STARTING

+ const ServiceLabel

+ const SlugLabel

+ const UNKNOWN

+ const UPDATING

+ const UserCancel

+ const VersionLabel

+ const VolumeLabel

+ const WorkingDirLabel

+ var ComposeVersion string

+ var ErrAlreadyExists = errors.New("already exists")

+ var ErrCanceled = errors.New("canceled")

+ var ErrForbidden = errors.New("forbidden")

+ var ErrLoginFailed = errors.New("login failed")

+ var ErrLoginRequired = errors.New("login required")

+ var ErrNotFound = errors.New("not found")

+ var ErrNotImplemented = errors.New("not implemented")

+ var ErrParsingFailed = errors.New("parsing failed")

+ var ErrUnknown = errors.New("unknown")

+ var ErrUnsupportedFlag = errors.New("unsupported flag")

+ var ErrWrongContextType = errors.New("wrong context type")

+ func IsAlreadyExistsError(err error) bool

+ func IsErrCanceled(err error) bool

+ func IsErrNotImplemented(err error) bool

+ func IsErrParsingFailed(err error) bool

+ func IsErrUnsupportedFlag(err error) bool

+ func IsForbiddenError(err error) bool

+ func IsNotFoundError(err error) bool

+ func IsUnknownError(err error) bool

+ type BuildOptions struct

+ Args types.MappingWithEquals

+ NoCache bool

+ Progress string

+ Pull bool

+ Quiet bool

+ Services []string

+ type ContainerEvent struct

+ Container string

+ ExitCode int

+ Line string

+ Restarting bool

+ Service string

+ Type int

+ type ContainerEventListener func(event ContainerEvent)

+ type ContainerProcSummary struct

+ ID string

+ Name string

+ Processes [][]string

+ Titles []string

+ type ContainerSummary struct

+ Command string

+ ExitCode int

+ Health string

+ ID string

+ Name string

+ Project string

+ Publishers PortPublishers

+ Service string

+ State string

+ type ConvertOptions struct

+ Format string

+ Output string

+ type CopyOptions struct

+ All bool

+ CopyUIDGID bool

+ Destination string

+ FollowLink bool

+ Index int

+ Source string

+ type CreateOptions struct

+ IgnoreOrphans bool

+ Inherit bool

+ QuietPull bool

+ Recreate string

+ RecreateDependencies string

+ RemoveOrphans bool

+ Services []string

+ Timeout *time.Duration

+ type DownOptions struct

+ Images string

+ Project *types.Project

+ RemoveOrphans bool

+ Timeout *time.Duration

+ Volumes bool

+ type Event struct

+ Attributes map[string]string

+ Container string

+ Service string

+ Status string

+ Timestamp time.Time

+ func (e Event) String() string

+ type EventsOptions struct

+ Consumer func(event Event) error

+ Services []string

+ type ImageSummary struct

+ ContainerName string

+ ID string

+ Repository string

+ Size int64

+ Tag string

+ type ImagesOptions struct

+ Services []string

+ type Interceptor func(ctx context.Context, project *types.Project)

+ type KillOptions struct

+ Services []string

+ Signal string

+ type ListOptions struct

+ All bool

+ type LogConsumer interface

+ Log func(service, container, message string)

+ Register func(container string)

+ Status func(container, msg string)

+ type LogOptions struct

+ Follow bool

+ Services []string

+ Since string

+ Tail string

+ Timestamps bool

+ Until string

+ type PauseOptions struct

+ Services []string

+ type PortOptions struct

+ Index int

+ Protocol string

+ type PortPublisher struct

+ Protocol string

+ PublishedPort int

+ TargetPort int

+ URL string

+ type PortPublishers []PortPublisher

+ func (p PortPublishers) Len() int

+ func (p PortPublishers) Less(i, j int) bool

+ func (p PortPublishers) Swap(i, j int)

+ type PsOptions struct

+ All bool

+ Services []string

+ type PullOptions struct

+ IgnoreFailures bool

+ Quiet bool

+ type PushOptions struct

+ IgnoreFailures bool

+ type RemoveOptions struct

+ DryRun bool

+ Force bool

+ Services []string

+ Volumes bool

+ type RestartOptions struct

+ Services []string

+ Timeout *time.Duration

+ type RunOptions struct

+ AutoRemove bool

+ Command []string

+ Detach bool

+ Entrypoint []string

+ Environment []string

+ Index int

+ Labels types.Labels

+ Name string

+ NoDeps bool

+ Privileged bool

+ Service string

+ Stderr io.WriteCloser

+ Stdin io.ReadCloser

+ Stdout io.WriteCloser

+ Tty bool

+ UseNetworkAliases bool

+ User string

+ WorkingDir string

+ type Service interface

+ Build func(ctx context.Context, project *types.Project, options BuildOptions) error

+ Convert func(ctx context.Context, project *types.Project, options ConvertOptions) ([]byte, error)

+ Copy func(ctx context.Context, project *types.Project, opts CopyOptions) error

+ Create func(ctx context.Context, project *types.Project, opts CreateOptions) error

+ Down func(ctx context.Context, projectName string, options DownOptions) error

+ Events func(ctx context.Context, project string, options EventsOptions) error

+ Exec func(ctx context.Context, project string, opts RunOptions) (int, error)

+ Images func(ctx context.Context, projectName string, options ImagesOptions) ([]ImageSummary, error)

+ Kill func(ctx context.Context, project *types.Project, options KillOptions) error

+ List func(ctx context.Context, options ListOptions) ([]Stack, error)

+ Logs func(ctx context.Context, projectName string, consumer LogConsumer, ...) error

+ Pause func(ctx context.Context, project string, options PauseOptions) error

+ Port func(ctx context.Context, project string, service string, port int, ...) (string, int, error)

+ Ps func(ctx context.Context, projectName string, options PsOptions) ([]ContainerSummary, error)

+ Pull func(ctx context.Context, project *types.Project, opts PullOptions) error

+ Push func(ctx context.Context, project *types.Project, options PushOptions) error

+ Remove func(ctx context.Context, project *types.Project, options RemoveOptions) error

+ Restart func(ctx context.Context, project *types.Project, options RestartOptions) error

+ RunOneOffContainer func(ctx context.Context, project *types.Project, opts RunOptions) (int, error)

+ Start func(ctx context.Context, project *types.Project, options StartOptions) error

+ Stop func(ctx context.Context, project *types.Project, options StopOptions) error

+ Top func(ctx context.Context, projectName string, services []string) ([]ContainerProcSummary, error)

+ UnPause func(ctx context.Context, project string, options PauseOptions) error

+ Up func(ctx context.Context, project *types.Project, options UpOptions) error

+ type ServiceProxy struct

+ BuildFn func(ctx context.Context, project *types.Project, options BuildOptions) error

+ ConvertFn func(ctx context.Context, project *types.Project, options ConvertOptions) ([]byte, error)

+ CopyFn func(ctx context.Context, project *types.Project, opts CopyOptions) error

+ CreateFn func(ctx context.Context, project *types.Project, opts CreateOptions) error

+ DownFn func(ctx context.Context, projectName string, options DownOptions) error

+ EventsFn func(ctx context.Context, project string, options EventsOptions) error

+ ExecFn func(ctx context.Context, project string, opts RunOptions) (int, error)

+ ImagesFn func(ctx context.Context, projectName string, options ImagesOptions) ([]ImageSummary, error)

+ KillFn func(ctx context.Context, project *types.Project, options KillOptions) error

+ ListFn func(ctx context.Context, options ListOptions) ([]Stack, error)

+ LogsFn func(ctx context.Context, projectName string, consumer LogConsumer, ...) error

+ PauseFn func(ctx context.Context, project string, options PauseOptions) error

+ PortFn func(ctx context.Context, project string, service string, port int, ...) (string, int, error)

+ PsFn func(ctx context.Context, projectName string, options PsOptions) ([]ContainerSummary, error)

+ PullFn func(ctx context.Context, project *types.Project, opts PullOptions) error

+ PushFn func(ctx context.Context, project *types.Project, options PushOptions) error

+ RemoveFn func(ctx context.Context, project *types.Project, options RemoveOptions) error

+ RestartFn func(ctx context.Context, project *types.Project, options RestartOptions) error

+ RunOneOffContainerFn func(ctx context.Context, project *types.Project, opts RunOptions) (int, error)

+ StartFn func(ctx context.Context, project *types.Project, options StartOptions) error

+ StopFn func(ctx context.Context, project *types.Project, options StopOptions) error

+ TopFn func(ctx context.Context, projectName string, services []string) ([]ContainerProcSummary, error)

+ UnPauseFn func(ctx context.Context, project string, options PauseOptions) error

+ UpFn func(ctx context.Context, project *types.Project, options UpOptions) error

+ func NewServiceProxy() *ServiceProxy

+ func (s *ServiceProxy) Build(ctx context.Context, project *types.Project, options BuildOptions) error

+ func (s *ServiceProxy) Convert(ctx context.Context, project *types.Project, options ConvertOptions) ([]byte, error)

+ func (s *ServiceProxy) Copy(ctx context.Context, project *types.Project, options CopyOptions) error

+ func (s *ServiceProxy) Create(ctx context.Context, project *types.Project, options CreateOptions) error

+ func (s *ServiceProxy) Down(ctx context.Context, project string, options DownOptions) error

+ func (s *ServiceProxy) Events(ctx context.Context, project string, options EventsOptions) error

+ func (s *ServiceProxy) Exec(ctx context.Context, project string, options RunOptions) (int, error)

+ func (s *ServiceProxy) Images(ctx context.Context, project string, options ImagesOptions) ([]ImageSummary, error)

+ func (s *ServiceProxy) Kill(ctx context.Context, project *types.Project, options KillOptions) error

+ func (s *ServiceProxy) List(ctx context.Context, options ListOptions) ([]Stack, error)

+ func (s *ServiceProxy) Logs(ctx context.Context, projectName string, consumer LogConsumer, ...) error

+ func (s *ServiceProxy) Pause(ctx context.Context, project string, options PauseOptions) error

+ func (s *ServiceProxy) Port(ctx context.Context, project string, service string, port int, ...) (string, int, error)

+ func (s *ServiceProxy) Ps(ctx context.Context, project string, options PsOptions) ([]ContainerSummary, error)

+ func (s *ServiceProxy) Pull(ctx context.Context, project *types.Project, options PullOptions) error

+ func (s *ServiceProxy) Push(ctx context.Context, project *types.Project, options PushOptions) error

+ func (s *ServiceProxy) Remove(ctx context.Context, project *types.Project, options RemoveOptions) error

+ func (s *ServiceProxy) Restart(ctx context.Context, project *types.Project, options RestartOptions) error

+ func (s *ServiceProxy) RunOneOffContainer(ctx context.Context, project *types.Project, options RunOptions) (int, error)

+ func (s *ServiceProxy) Start(ctx context.Context, project *types.Project, options StartOptions) error

+ func (s *ServiceProxy) Stop(ctx context.Context, project *types.Project, options StopOptions) error

+ func (s *ServiceProxy) Top(ctx context.Context, project string, services []string) ([]ContainerProcSummary, error)

+ func (s *ServiceProxy) UnPause(ctx context.Context, project string, options PauseOptions) error

+ func (s *ServiceProxy) Up(ctx context.Context, project *types.Project, options UpOptions) error

+ func (s *ServiceProxy) WithInterceptor(interceptors ...Interceptor) *ServiceProxy

+ func (s *ServiceProxy) WithService(service Service) *ServiceProxy

+ type ServiceStatus struct

+ Desired int

+ ID string

+ Name string

+ Ports []string

+ Publishers []PortPublisher

+ Replicas int

+ type Stack struct

+ ID string

+ Name string

+ Reason string

+ Status string

+ type StartOptions struct

+ Attach LogConsumer

+ AttachTo []string

+ CascadeStop bool

+ ExitCodeFrom string

+ type StopOptions struct

+ Services []string

+ Timeout *time.Duration

+ type UpOptions struct

+ Create CreateOptions

+ Start StartOptions