composer

package
v2.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 10, 2024 License: Apache-2.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// RecreateNever specifies never recreating existing service containers
	RecreateNever = "never"
	// RecreateForce specifies always force-recreating service containers
	RecreateForce = "force"
	// RecreateDiverged specifies only recreating service containers which diverges from compose model.
	// (Unimplemented, currently equal to `RecreateNever`) In docker-compose,
	// service config is hashed and stored in a label.
	// FYI: https://github.com/docker/compose/blob/v2.14.1/pkg/compose/convergence.go#L244
	RecreateDiverged = "diverged"
)

FYI: https://github.com/docker/compose/blob/v2.14.1/pkg/api/api.go#L423

Variables

This section is empty.

Functions

func Lock added in v2.0.2 

func Lock(dataRoot string, address string) error

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

func Unlock added in v2.0.2 

func Unlock() error

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, 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) Copy 

func (c *Composer) Copy(ctx context.Context, co CopyOptions) error

func (*Composer) Create 

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

Create creates containers for given services.

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

func (c *Composer) Pause(ctx context.Context, services []string, writer io.Writer) error

Pause pauses service containers belonging to `services`.

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(svcs ...string) ([]string, error)

ServiceNames returns service names in dependency order.

func (*Composer) Services 

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

Services returns the parsed Service objects in dependency order.

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

func (c *Composer) Unpause(ctx context.Context, services []string, writer io.Writer) error

Unpause unpauses service containers belonging to `services`.

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 CopyOptions 

type CopyOptions struct {
	Source      string
	Destination string
	Index       int
	FollowLink  bool
	DryRun      bool
}

type CreateOptions 

type CreateOptions struct {
	Build         bool
	NoBuild       bool
	ForceRecreate bool
	NoRecreate    bool
	Pull          *string
}

CreateOptions stores all option input from `nerdctl compose create`

type DownOptions 

type DownOptions struct {
	RemoveVolumes bool
	RemoveOrphans 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 {
	AbortOnContainerExit bool
	Follow               bool
	Timestamps           bool
	Tail                 string
	NoColor              bool
	NoLogPrefix          bool
	LatestRun            bool
}

type Options 

type Options struct {
	Project          string // empty for default
	ProjectDirectory string
	ConfigPaths      []string
	Profiles         []string
	Services         []string
	EnvFile          string
	NerdctlCmd       string
	NerdctlArgs      []string
	NetworkInUse     func(ctx context.Context, netName string) (bool, error)
	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
	IPFSAddress      string
}

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
	QuietPull     bool
	RemoveOrphans bool

	Name         string
	Detach       bool
	NoDeps       bool
	Tty          bool
	SigProxy     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 {
	AbortOnContainerExit bool
	Detach               bool
	NoBuild              bool
	NoColor              bool
	NoLogPrefix          bool
	ForceBuild           bool
	IPFS                 bool
	QuietPull            bool
	RemoveOrphans        bool
	ForceRecreate        bool
	NoRecreate           bool
	Scale                map[string]int // map of service name to replicas
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.