compose

package

Go to main page

Versions in this module

v1

v1.0.17

Jun 2, 2021

Changes in this version

type ContainerEvent

+ Restarting bool

+ type LogPrinter interface

+ Cancel func()

+ HandleEvent func(event ContainerEvent)

+ Run func(cascadeStop bool, exitCodeFrom string, stopFn func() error) (int, error)

+ func NewLogPrinter(consumer LogConsumer) LogPrinter

v1.0.16

May 24, 2021

Changes in this version

type ContainerSummary

+ ExitCode int

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

type RestartOptions

+ Services []string

+ 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 *types.Project, 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) ([]string, 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 *types.Project, 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, project string, consumer LogConsumer, options LogOptions) 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) ([]string, 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

v1.0.15

May 12, 2021

Changes in this version

+ type CopyOptions struct

+ All bool

+ CopyUIDGID bool

+ Destination string

+ FollowLink bool

+ Index int

+ Source string

type NoImpl

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

type PsOptions

+ Services []string

type Service

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

type ServiceDelegator

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

v1.0.14

Apr 27, 2021

Changes in this version

+ type NoImpl struct

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

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

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

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

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

+ func (s NoImpl) Exec(ctx context.Context, project *types.Project, options RunOptions) error

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

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

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

+ func (s NoImpl) Logs(ctx context.Context, project string, consumer LogConsumer, options LogOptions) error

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

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

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

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

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

+ func (s NoImpl) Remove(ctx context.Context, project *types.Project, options RemoveOptions) ([]string, error)

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

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

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

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

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

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

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

type RemoveOptions

+ Services []string

+ type ServiceDelegator struct

+ Delegate Service

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

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

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

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

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

+ func (s *ServiceDelegator) Exec(ctx context.Context, project *types.Project, options RunOptions) error

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

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

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

+ func (s *ServiceDelegator) Logs(ctx context.Context, project string, consumer LogConsumer, options LogOptions) error

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

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

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

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

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

+ func (s *ServiceDelegator) Remove(ctx context.Context, project *types.Project, options RemoveOptions) ([]string, error)

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

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

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

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

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

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

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

type StopOptions

+ Services []string

v1.0.13

Apr 13, 2021

Changes in this version

type BuildOptions

+ Quiet bool

+ type ImageSummary struct

+ ContainerName string

+ ID string

+ Repository string

+ Size int64

+ Tag string

+ type ImagesOptions struct

+ Services []string

+ type PauseOptions struct

+ Services []string

type Service

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

v1.0.12

Apr 2, 2021

v1.0.11

Mar 31, 2021

Changes in this version

type BuildOptions

+ NoCache bool

type ContainerEvent

+ Container string

+ type PortOptions struct

+ Index int

+ Protocol string

+ type PullOptions struct

+ IgnoreFailures bool

+ type RestartOptions struct

+ Timeout *time.Duration

type Service

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

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

v1.0.10

Mar 16, 2021

Changes in this version

+ type BuildOptions struct

+ Args types.Mapping

+ Progress string

+ Pull bool

+ type ContainerProcSummary struct

+ ID string

+ Name string

+ Processes [][]string

+ Titles []string

type CreateOptions

+ Inherit bool

+ QuietPull bool

+ RecreateDependencies string

+ Services []string

+ Timeout *time.Duration

+ 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 PushOptions struct

+ IgnoreFailures bool

type RunOptions

+ UseNetworkAliases bool

type Service

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

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

type StartOptions

+ Services []string

type UpOptions

+ QuietPull bool

v1.0.9

Feb 26, 2021

Changes in this version

+ const ContainerEventAttach

+ const ContainerEventExit

+ const ContainerEventLog

+ const EnvironmentFileLabel

+ const UserCancel

+ type ContainerEvent struct

+ ExitCode int

+ Line string

+ Name string

+ Service string

+ Source string

+ Type int

+ type ContainerEventListener func(event ContainerEvent)

type ConvertOptions

+ Output string

type DownOptions

+ Images string

+ Timeout *time.Duration

+ Volumes bool

+ type ListOptions struct

+ All bool

type LogConsumer

+ Register func(name string, source string)

+ Status func(name, container, msg string)

type LogOptions

+ Timestamps bool

+ type RemoveOptions struct

+ DryRun bool

+ Force bool

+ Volumes bool

type RunOptions

+ Entrypoint []string

+ Environment []string

+ Index int

+ Labels types.Labels

+ Name string

+ Privileged bool

+ Tty bool

+ User string

+ WorkingDir string

+ func (opts *RunOptions) EnvironmentMap() types.MappingWithEquals

type Service

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

+ Pause func(ctx context.Context, project *types.Project) error

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

+ UnPause func(ctx context.Context, project *types.Project) error

+ type StartOptions struct

+ Attach ContainerEventListener

+ type StopOptions struct

+ Timeout *time.Duration

v1.0.8

Feb 3, 2021

Changes in this version

+ const RecreateDiverged

+ const RecreateForce

+ const RecreateNever

type ContainerSummary

+ Health string

type CreateOptions

+ Recreate string

type DownOptions

+ Project *types.Project

+ type KillOptions struct

+ Signal string

type LogOptions

+ Follow bool

+ Tail string

+ type PsOptions struct

+ All bool

type Service

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

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

v1.0.7

Jan 12, 2021

Changes in this version

+ type CreateOptions struct

+ RemoveOrphans bool

v1.0.6

Jan 6, 2021

Changes in this version

+ type ConvertOptions struct

+ Format string

+ type DownOptions struct

+ RemoveOrphans bool

+ type LogOptions struct

+ Services []string

+ type RunOptions struct

+ AutoRemove bool

+ Command []string

+ Detach bool

+ Reader io.Reader

+ Service string

+ Writer io.Writer

type Service

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

+ type UpOptions struct

+ Detach bool

v1.0.5

Dec 15, 2020

Changes in this version

+ type ContainerSummary struct

+ ID string

+ Name string

+ Project string

+ Publishers []PortPublisher

+ Service string

+ State string

v1.0.4

Dec 7, 2020

Changes in this version

+ type LogConsumer interface

+ Log func(service, container, message string)

type Service

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

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

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

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

+ Start func(ctx context.Context, project *types.Project, consumer LogConsumer) error

v1.0.3

Nov 23, 2020

v1.0.2

Nov 6, 2020

v1.0.1

Oct 30, 2020

v1.0.0

Oct 29, 2020

v0

v0.1.23

Oct 27, 2020

v0.1.22

Oct 13, 2020

Changes in this version

+ const VolumeTag

v0.1.21

Oct 13, 2020

v0.1.20

Oct 6, 2020

Changes in this version

type Stack

+ Reason string

v0.1.19

Oct 2, 2020

v0.1.18

Sep 28, 2020

v0.1.18-beta1

Sep 23, 2020

v0.1.17

Sep 23, 2020

v0.1.16

Sep 18, 2020

v0.1.15

Sep 10, 2020

Changes in this version

+ const FAILED

+ const NetworkTag

+ const ProjectTag

+ const REMOVING

+ const RUNNING

+ const STARTING

+ const ServiceTag

+ const UNKNOWN

+ const UPDATING

+ type PortPublisher struct

+ Protocol string

+ PublishedPort int

+ TargetPort int

+ URL string

+ type Service interface

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

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

+ List func(ctx context.Context, projectName string) ([]Stack, error)

+ Logs func(ctx context.Context, projectName string, w io.Writer) error

+ Ps func(ctx context.Context, projectName string) ([]ServiceStatus, error)

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

+ type ServiceStatus struct

+ Desired int

+ ID string

+ Name string

+ Ports []string

+ Publishers []PortPublisher

+ Replicas int

+ type Stack struct

+ ID string

+ Name string

+ Status string

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