commands

Documentation

Index

• type Attach
  • func (command *Attach) Execute(maybeHandle []string) error
• type Create
  • func (command *Create) Execute(args []string) error
• type Destroy
  • func (command *Destroy) Execute(handles []string) error
• type GlobalOptions
• type IPFlag
  • func (f IPFlag) IP() net.IP
  • func (f *IPFlag) UnmarshalFlag(value string) error
• type List
  • func (command *List) Execute(args []string) error
• type NetIn
  • func (command *NetIn) Execute(maybeHandle []string) error
• type NetOut
  • func (command *NetOut) Execute(maybeHandle []string) error
• type Ping
  • func (command *Ping) Execute(args []string) error
• type Properties
  • func (command *Properties) Execute(maybeHandle []string) error
• type Run
  • func (command *Run) Execute(maybeHandle []string) error
• type Shell
  • func (command *Shell) Execute(maybeHandle []string) error
• type StreamIn
  • func (command *StreamIn) Execute(maybeHandle []string) error
• type StreamOut
  • func (command *StreamOut) Execute(maybeHandle []string) error
• type TargetFlag
  • func (target *TargetFlag) UnmarshalFlag(address string) error

Types

type Attach

type Attach struct {
	Process string `short:"p" long:"pid" description:"process id to connect to" required:"true"`
}

func (*Attach) Execute

func (command *Attach) Execute(maybeHandle []string) error

type Create

type Create struct {
	Handle     string        `short:"n" long:"handle" description:"name to give container"`
	RootFS     string        `short:"r" long:"rootfs" description:"rootfs image with which to create the container"`
	Env        []string      `short:"e" long:"env" description:"set environment variables"`
	Grace      time.Duration `short:"g" long:"grace" description:"grace time (resetting ttl) of container"`
	Privileged bool          `short:"p" long:"privileged" description:"privileged user in the container is privileged in the host"`
	Network    string        `long:"network" description:"the subnet of the container"`
	BindMounts []string      `short:"m" long:"bind-mount" description:"bind mount host-path:container-path"`
	NetIn      []string      `short:"i" long:"net-in" description:"map a host port to a container port"`
	NetOut     []string      `short:"o" long:"net-out" description:"whitelist outbound network traffic"`
}

func (*Create) Execute

func (command *Create) Execute(args []string) error

type Destroy

type Destroy struct{}

func (*Destroy) Execute

func (command *Destroy) Execute(handles []string) error

type GlobalOptions

type GlobalOptions struct {
	Target TargetFlag `short:"t" long:"target" description:"garden endpoint" default:"127.0.0.1:7777" env:"GAOL_TARGET"`
}

var Globals GlobalOptions

type IPFlag

type IPFlag net.IP

func (IPFlag) IP

func (f IPFlag) IP() net.IP

func (*IPFlag) UnmarshalFlag

func (f *IPFlag) UnmarshalFlag(value string) error

type List

type List struct {
	Properties []string `short:"p" long:"properties" description:"filter by properties (name=value)"`
	Verbose    bool     `short:"v" long:"verbose" description:"print additional details about each container"`
	Separator  string   `long:"separator" description:"separator to print between containers in verbose mode"`
}

func (*List) Execute

func (command *List) Execute(args []string) error

type NetIn

type NetIn struct {
	Port uint16 `short:"p" long:"port" description:"container port" required:"true"`
}

func (*NetIn) Execute

func (command *NetIn) Execute(maybeHandle []string) error

type NetOut

type NetOut struct {
	Protocol  string `` /* 129-byte string literal not displayed */
	StartIP   IPFlag `long:"ip-start" required:"true" description:"start of IP range to whitelist, inclusive"`
	EndIP     IPFlag `long:"ip-end" required:"true" description:"end of IP range to whitelist, inclusive"`
	StartPort uint16 `long:"port-start" required:"true" description:"start of port range to whitelist, inclusive"`
	EndPort   uint16 `long:"port-end" required:"true" description:"end of port range to whitelist, inclusive"`
}

func (*NetOut) Execute

func (command *NetOut) Execute(maybeHandle []string) error

type Ping

type Ping struct{}

func (*Ping) Execute

func (command *Ping) Execute(args []string) error

type Properties

type Properties struct {
	AsJSON bool `short:"j" long:"json" description:"format output as json"`
}

func (*Properties) Execute

func (command *Properties) Execute(maybeHandle []string) error

type Run

type Run struct {
	Attach  bool     `short:"a" long:"attach" description:"attach to the process after it has started"`
	Dir     string   `short:"d" long:"dir" description:"current working directory of process"`
	User    string   `short:"u" long:"user" description:"user to run the process as" default:"root"`
	Command string   `short:"c" long:"command" description:"command to run in container"`
	Env     []string `short:"e" long:"env" description:"set environment variables"`
}

func (*Run) Execute

func (command *Run) Execute(maybeHandle []string) error

type Shell

type Shell struct {
	User string `short:"u" long:"user" description:"user to open shell as" default:"root"`
}

func (*Shell) Execute

func (command *Shell) Execute(maybeHandle []string) error

type StreamIn

type StreamIn struct {
	Destination string `short:"d" long:"destination" description:"destination path in the container" required:"true"`
	User        string `short:"u" long:"user" description:"user to write the files as"`
}

func (*StreamIn) Execute

func (command *StreamIn) Execute(maybeHandle []string) error

type StreamOut

type StreamOut struct {
	Source string `short:"s" long:"source" description:"source path in the container" required:"true"`
	User   string `short:"u" long:"user" description:"user to read the files as"`
}

func (*StreamOut) Execute

func (command *StreamOut) Execute(maybeHandle []string) error

type TargetFlag

type TargetFlag struct {
	Network string
	Address string
}

func (*TargetFlag) UnmarshalFlag

func (target *TargetFlag) UnmarshalFlag(address string) error