composer

Documentation

Index

• type BuildOptions
• type Composer
  • func New(o Options) (*Composer, error)
  • func (c *Composer) Build(ctx context.Context, bo BuildOptions) error
  • func (c *Composer) Down(ctx context.Context, downOptions DownOptions) error
  • func (c *Composer) Logs(ctx context.Context, lo LogsOptions) error
  • func (c *Composer) Up(ctx context.Context, uo UpOptions) error
• type DownOptions
• type LogsOptions
• type Options
• type UpOptions

Types

type BuildOptions

type BuildOptions struct {
	Args     []string // --build-arg strings
	NoCache  bool
	Progress string
}

type Composer

type Composer struct {
	Options
	// contains filtered or unexported fields
}

func New

func New(o Options) (*Composer, error)

func (*Composer) Build

func (c *Composer) Build(ctx context.Context, bo BuildOptions) error

func (*Composer) Down

func (c *Composer) Down(ctx context.Context, downOptions DownOptions) error

func (*Composer) Logs

func (c *Composer) Logs(ctx context.Context, lo LogsOptions) error

func (*Composer) Up

func (c *Composer) Up(ctx context.Context, uo UpOptions) error

type DownOptions

type DownOptions struct {
	RemoveVolumes bool
}

type LogsOptions

type LogsOptions struct {
	Follow      bool
	Timestamps  bool
	Tail        string
	NoColor     bool
	NoLogPrefix bool
}

type Options

type Options struct {
	//TODO Specifying multiple Compose files
	ProjectOptions composecli.ProjectOptions
	Project        string // empty for default
	NerdctlCmd     string
	NerdctlArgs    []string
	NetworkExists  func(string) (bool, error)
	VolumeExists   func(string) (bool, error)
	ImageExists    func(ctx context.Context, imageName string) (bool, error)
	EnsureImage    func(ctx context.Context, imageName, pullMode string) error
	DebugPrintFull bool // full debug print, may leak secret env var to logs
}

Options groups the command line options recommended for a Compose implementation (ProjectOptions) and extra options for nerdctl

type UpOptions

type UpOptions struct {
	Detach      bool
	NoColor     bool
	NoLogPrefix bool
	ForceBuild  bool
}