composer

Documentation

Index

• func ServiceHash(o types.ServiceConfig) (string, error)
• type BuildOptions
• type Composer
  • func New(o Options, client *containerd.Client) (*Composer, error)
  • func (c *Composer) Build(ctx context.Context, bo BuildOptions, services []string) error
  • func (c *Composer) Config(ctx context.Context, w io.Writer, co ConfigOptions) error
  • func (c *Composer) Containers(ctx context.Context, services ...string) ([]containerd.Container, error)
  • func (c *Composer) Down(ctx context.Context, downOptions DownOptions) error
  • func (c *Composer) Exec(ctx context.Context, eo ExecOptions) error
  • func (c *Composer) Kill(ctx context.Context, opts KillOptions, services []string) error
  • func (c *Composer) Logs(ctx context.Context, lo LogsOptions, services []string) error
  • func (c *Composer) Port(ctx context.Context, writer io.Writer, po PortOptions) error
  • func (c *Composer) Pull(ctx context.Context, po PullOptions, services []string) error
  • func (c *Composer) Push(ctx context.Context, po PushOptions, services []string) error
  • func (c *Composer) Remove(ctx context.Context, opt RemoveOptions, services []string) error
  • func (c *Composer) Restart(ctx context.Context, opt RestartOptions, services []string) error
  • func (c *Composer) Run(ctx context.Context, ro RunOptions) error
  • func (c *Composer) ServiceNames(services ...string) ([]string, error)
  • func (c *Composer) Services(ctx context.Context) ([]*serviceparser.Service, error)
  • func (c *Composer) Stop(ctx context.Context, opt StopOptions, services []string) error
  • func (c *Composer) Up(ctx context.Context, uo UpOptions, services []string) error
• type ConfigOptions
• type DownOptions
• type ExecOptions
• type KillOptions
• type LogsOptions
• type Options
• type PortOptions
• type PullOptions
• type PushOptions
• type RemoveOptions
• type RestartOptions
• type RunOptions
• type StopOptions
• type UpOptions

Functions

func ServiceHash

func ServiceHash(o types.ServiceConfig) (string, error)

ServiceHash is from https://github.com/docker/compose/blob/v2.2.2/pkg/compose/hash.go#L28-L38

Types

type BuildOptions

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

type Composer

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

func New

func New(o Options, client *containerd.Client) (*Composer, error)

func (*Composer) Build

func (c *Composer) Build(ctx context.Context, bo BuildOptions, services []string) error

func (*Composer) Config

func (c *Composer) Config(ctx context.Context, w io.Writer, co ConfigOptions) error

func (*Composer) Containers

func (c *Composer) Containers(ctx context.Context, services ...string) ([]containerd.Container, error)

func (*Composer) Down

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

func (*Composer) Exec

func (c *Composer) Exec(ctx context.Context, eo ExecOptions) error

Exec executes a given command on a running container specified by `ServiceName` (and `Index` if it has multiple instances).

func (*Composer) Kill

func (c *Composer) Kill(ctx context.Context, opts KillOptions, services []string) error

func (*Composer) Logs

func (c *Composer) Logs(ctx context.Context, lo LogsOptions, services []string) error

func (*Composer) Port

func (c *Composer) Port(ctx context.Context, writer io.Writer, po PortOptions) error

Port gets the corresponding public port of a given private port/protocol on a service container.

func (*Composer) Pull

func (c *Composer) Pull(ctx context.Context, po PullOptions, services []string) error

func (*Composer) Push

func (c *Composer) Push(ctx context.Context, po PushOptions, services []string) error

func (*Composer) Remove

func (c *Composer) Remove(ctx context.Context, opt RemoveOptions, services []string) error

Remove removes stopped containers in `services`.

func (*Composer) Restart

func (c *Composer) Restart(ctx context.Context, opt RestartOptions, services []string) error

Restart restarts running/stopped containers in `services`. It calls `nerdctl restart CONTAINER_ID` to do the actual job.

func (*Composer) Run

func (c *Composer) Run(ctx context.Context, ro RunOptions) error

func (*Composer) ServiceNames

func (c *Composer) ServiceNames(services ...string) ([]string, error)

func (*Composer) Services

func (c *Composer) Services(ctx context.Context) ([]*serviceparser.Service, error)

func (*Composer) Stop

func (c *Composer) Stop(ctx context.Context, opt StopOptions, services []string) error

Stop stops containers in `services` without removing them. It calls `nerdctl stop CONTAINER_ID` to do the actual job.

func (*Composer) Up

func (c *Composer) Up(ctx context.Context, uo UpOptions, services []string) error

type ConfigOptions

type ConfigOptions struct {
	Services bool
	Volumes  bool
	Hash     string
}

type DownOptions

type DownOptions struct {
	RemoveVolumes bool
}

type ExecOptions

type ExecOptions struct {
	ServiceName string
	Index       int
	// params to be passed to `nerdctl exec`
	Detach      bool
	Interactive bool
	Tty         bool
	Privileged  bool
	User        string
	WorkDir     string
	Env         []string
	Args        []string
}

ExecOptions stores options passed from users as flags and args.

type KillOptions

type KillOptions struct {
	Signal string
}

type LogsOptions

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

type Options

type Options struct {
	Project          string // empty for default
	ProjectDirectory string
	ConfigPaths      []string
	EnvFile          string
	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, platform string, ps *serviceparser.Service, quiet bool) error
	DebugPrintFull   bool // full debug print, may leak secret env var to logs
	Experimental     bool // enable experimental features
}

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

type PortOptions

type PortOptions struct {
	ServiceName string
	Index       int
	Port        int
	Protocol    string
}

PortOptions has args for getting the public port of a given private port/protocol in a service container.

type PullOptions

type PullOptions struct {
	Quiet bool
}

type PushOptions

type PushOptions struct {
}

type RemoveOptions

type RemoveOptions struct {
	Stop    bool
	Volumes bool
}

RemoveOptions stores all options when removing compose containers: Stop: if true, remove using `rm -f`; if false, check and skip running containers. Volumes: if remove anonymous volumes associated with the container.

type RestartOptions

type RestartOptions struct {
	Timeout *uint
}

RestartOptions stores all option input from `nerdctl compose restart`

type RunOptions

type RunOptions struct {
	ServiceName string
	Args        []string

	NoBuild       bool
	NoColor       bool
	NoLogPrefix   bool
	ForceBuild    bool
	IPFS          bool
	QuietPull     bool
	RemoveOrphans bool

	Name         string
	Detach       bool
	NoDeps       bool
	Tty          bool
	Interactive  bool
	Rm           bool
	User         string
	Volume       []string
	Entrypoint   []string
	Env          []string
	Label        []string
	WorkDir      string
	ServicePorts bool
	Publish      []string
}

type StopOptions

type StopOptions struct {
	Timeout *uint
}

StopOptions stores all option input from `nerdctl compose stop`

type UpOptions

type UpOptions struct {
	Detach        bool
	NoBuild       bool
	NoColor       bool
	NoLogPrefix   bool
	ForceBuild    bool
	IPFS          bool
	QuietPull     bool
	RemoveOrphans bool
	Scale         map[string]uint64 // map of service name to replicas
}