garden: github.com/cloudfoundry-incubator/garden Index | Files | Directories

package garden

import "github.com/cloudfoundry-incubator/garden"

Index

Package Files

backend.go client.go container.go errors.go net_in.go net_out_rule.go

func NewServiceUnavailableError Uses

func NewServiceUnavailableError(cause string) error

func NewUnrecoverableError Uses

func NewUnrecoverableError(symptom string) error

type Backend Uses

type Backend interface {
    Client

    Start() error
    Stop()

    GraceTime(Container) time.Duration
}

type BandwidthLimits Uses

type BandwidthLimits struct {
    RateInBytesPerSecond      uint64 `json:"rate,omitempty"`
    BurstRateInBytesPerSecond uint64 `json:"burst,omitempty"`
}

type BindMount Uses

type BindMount struct {
    // SrcPath contains the path of the directory to be mounted.
    SrcPath string `json:"src_path,omitempty"`

    // DstPath contains the path of the mount point in the container. If the
    // directory does not exist, it is created.
    DstPath string `json:"dst_path,omitempty"`

    // Mode must be either "RO" or "RW". Alternatively, mode may be omitted and defaults to RO.
    // If mode is "RO", a read-only mount point is created.
    // If mode is "RW", a read-write mount point is created.
    Mode BindMountMode `json:"mode,omitempty"`

    // BindMountOrigin must be either "Host" or "Container". Alternatively, origin may be omitted and
    // defaults to "Host".
    // If origin is "Host", src_path denotes a path in the host.
    // If origin is "Container", src_path denotes a path in the container.
    Origin BindMountOrigin `json:"origin,omitempty"`
}

BindMount specifies parameters for a single mount point.

Each mount point is mounted (with the bind option) into the container's file system. The effective permissions of the mount point are the permissions of the source directory if the mode is read-write and the permissions of the source directory with the write bits turned off if the mode of the mount point is read-only.

type BindMountMode Uses

type BindMountMode uint8
const BindMountModeRO BindMountMode = 0
const BindMountModeRW BindMountMode = 1

type BindMountOrigin Uses

type BindMountOrigin uint8
const BindMountOriginContainer BindMountOrigin = 1
const BindMountOriginHost BindMountOrigin = 0

type CPULimits Uses

type CPULimits struct {
    Weight uint64 `json:"weight,omitempty"`
    // Deprecated: Use Weight instead.
    LimitInShares uint64 `json:"limit_in_shares,omitempty"`
}

type Capacity Uses

type Capacity struct {
    MemoryInBytes uint64 `json:"memory_in_bytes,omitempty"`
    // Total size of the image plugin store volume.
    // NB: It is recommended to use `SchedulableDiskInBytes` for scheduling purposes
    DiskInBytes uint64 `json:"disk_in_bytes,omitempty"`
    // Total scratch space (in bytes) available to containers. This is the size the image plugin store get grow up to.
    SchedulableDiskInBytes uint64 `json:"schedulable_disk_in_bytes,omitempty"`
    MaxContainers          uint64 `json:"max_containers,omitempty"`
}

type Client Uses

type Client interface {
    // Pings the garden server. Checks connectivity to the server. The server may, optionally, respond with specific
    // errors indicating health issues.
    //
    // Errors:
    // * garden.UnrecoverableError indicates that the garden server has entered an error state from which it cannot recover
    Ping() error

    // Capacity returns the physical capacity of the server's machine.
    //
    // Errors:
    // * None.
    Capacity() (Capacity, error)

    // Create creates a new container.
    //
    // Errors:
    // * When the handle, if specified, is already taken.
    // * When one of the bind_mount paths does not exist.
    // * When resource allocations fail (subnet, user ID, etc).
    Create(ContainerSpec) (Container, error)

    // Destroy destroys a container.
    //
    // When a container is destroyed, its resource allocations are released,
    // its filesystem is removed, and all references to its handle are removed.
    //
    // All resources that have been acquired during the lifetime of the container are released.
    // Examples of these resources are its subnet, its UID, and ports that were redirected to the container.
    //
    // TODO: list the resources that can be acquired during the lifetime of a container.
    //
    // Errors:
    // * TODO.
    Destroy(handle string) error

    // Containers lists all containers filtered by Properties (which are ANDed together).
    //
    // Errors:
    // * None.
    Containers(Properties) ([]Container, error)

    // BulkInfo returns info or error for a list of containers.
    BulkInfo(handles []string) (map[string]ContainerInfoEntry, error)

    // BulkMetrics returns metrics or error for a list of containers.
    BulkMetrics(handles []string) (map[string]ContainerMetricsEntry, error)

    // Lookup returns the container with the specified handle.
    //
    // Errors:
    // * Container not found.
    Lookup(handle string) (Container, error)
}

go:generate counterfeiter . Client

type Container Uses

type Container interface {
    Handle() string

    // Stop stops a container.
    //
    // If kill is false, garden stops a container by sending the processes running inside it the SIGTERM signal.
    // It then waits for the processes to terminate before returning a response.
    // If one or more processes do not terminate within 10 seconds,
    // garden sends these processes the SIGKILL signal, killing them ungracefully.
    //
    // If kill is true, garden stops a container by sending the processing running inside it a SIGKILL signal.
    //
    // It is possible to copy files in to and out of a stopped container.
    // It is only when a container is destroyed that its filesystem is cleaned up.
    //
    // Errors:
    // * None.
    Stop(kill bool) error

    // Returns information about a container.
    Info() (ContainerInfo, error)

    // StreamIn streams data into a file in a container.
    //
    // Errors:
    // *  TODO.
    StreamIn(spec StreamInSpec) error

    // StreamOut streams a file out of a container.
    //
    // Errors:
    // * TODO.
    StreamOut(spec StreamOutSpec) (io.ReadCloser, error)

    // Returns the current bandwidth limits set for the container.
    CurrentBandwidthLimits() (BandwidthLimits, error)

    // Returns the current CPU limts set for the container.
    CurrentCPULimits() (CPULimits, error)

    // Returns the current disk limts set for the container.
    CurrentDiskLimits() (DiskLimits, error)

    // Returns the current memory limts set for the container.
    CurrentMemoryLimits() (MemoryLimits, error)

    // Map a port on the host to a port in the container so that traffic to the
    // host port is forwarded to the container port. This is deprecated in
    // favour of passing NetIn configuration in the ContainerSpec at creation
    // time.
    //
    // If a host port is not given, a port will be acquired from the server's port
    // pool.
    //
    // If a container port is not given, the port will be the same as the
    // host port.
    //
    // The resulting host and container ports are returned in that order.
    //
    // Errors:
    // * When no port can be acquired from the server's port pool.
    NetIn(hostPort, containerPort uint32) (uint32, uint32, error)

    // Whitelist outbound network traffic. This is deprecated in favour of passing
    // NetOut configuration in the ContainerSpec at creation time.
    //
    // If the configuration directive deny_networks is not used,
    // all networks are already whitelisted and this command is effectively a no-op.
    //
    // Later NetOut calls take precedence over earlier calls, which is
    // significant only in relation to logging.
    //
    // Errors:
    // * An error is returned if the NetOut call fails.
    NetOut(netOutRule NetOutRule) error

    // A Bulk call for NetOut. This is deprecated in favour of passing
    // NetOut configuration in the ContainerSpec at creation time.
    //
    // Errors:
    // * An error is returned if any of the NetOut calls fail.
    BulkNetOut(netOutRules []NetOutRule) error

    // Run a script inside a container.
    //
    // The root user will be mapped to a non-root UID in the host unless the container (not this process) was created with 'privileged' true.
    //
    // Errors:
    // * TODO.
    Run(ProcessSpec, ProcessIO) (Process, error)

    // Attach starts streaming the output back to the client from a specified process.
    //
    // Errors:
    // * processID does not refer to a running process.
    Attach(processID string, io ProcessIO) (Process, error)

    // Metrics returns the current set of metrics for a container
    Metrics() (Metrics, error)

    // Sets the grace time.
    SetGraceTime(graceTime time.Duration) error

    // Properties returns the current set of properties
    Properties() (Properties, error)

    // Property returns the value of the property with the specified name.
    //
    // Errors:
    // * When the property does not exist on the container.
    Property(name string) (string, error)

    // Set a named property on a container to a specified value.
    //
    // Errors:
    // * None.
    SetProperty(name string, value string) error

    // Remove a property with the specified name from a container.
    //
    // Errors:
    // * None.
    RemoveProperty(name string) error
}

type ContainerBandwidthStat Uses

type ContainerBandwidthStat struct {
    InRate   uint64
    InBurst  uint64
    OutRate  uint64
    OutBurst uint64
}

type ContainerCPUStat Uses

type ContainerCPUStat struct {
    Usage  uint64
    User   uint64
    System uint64
}

type ContainerDiskStat Uses

type ContainerDiskStat struct {
    TotalBytesUsed      uint64
    TotalInodesUsed     uint64
    ExclusiveBytesUsed  uint64
    ExclusiveInodesUsed uint64
}

type ContainerInfo Uses

type ContainerInfo struct {
    State         string        // Either "active" or "stopped".
    Events        []string      // List of events that occurred for the container. It currently includes only "oom" (Out Of Memory) event if it occurred.
    HostIP        string        // The IP address of the gateway which controls the host side of the container's virtual ethernet pair.
    ContainerIP   string        // The IP address of the container side of the container's virtual ethernet pair.
    ExternalIP    string        //
    ContainerPath string        // The path to the directory holding the container's files (both its control scripts and filesystem).
    ProcessIDs    []string      // List of running processes.
    Properties    Properties    // List of properties defined for the container.
    MappedPorts   []PortMapping //
}

ContainerInfo holds information about a container.

type ContainerInfoEntry Uses

type ContainerInfoEntry struct {
    Info ContainerInfo
    Err  *Error
}

type ContainerMemoryStat Uses

type ContainerMemoryStat struct {
    ActiveAnon              uint64 `json:"active_anon"`
    ActiveFile              uint64 `json:"active_file"`
    Cache                   uint64 `json:"cache"`
    HierarchicalMemoryLimit uint64 `json:"hierarchical_memory_limit"`
    InactiveAnon            uint64 `json:"inactive_anon"`
    InactiveFile            uint64 `json:"inactive_file"`
    MappedFile              uint64 `json:"mapped_file"`
    Pgfault                 uint64 `json:"pgfault"`
    Pgmajfault              uint64 `json:"pgmajfault"`
    Pgpgin                  uint64 `json:"pgpgin"`
    Pgpgout                 uint64 `json:"pgpgout"`
    Rss                     uint64 `json:"rss"`
    TotalActiveAnon         uint64 `json:"total_active_anon"`
    TotalActiveFile         uint64 `json:"total_active_file"`
    TotalCache              uint64 `json:"total_cache"`
    TotalInactiveAnon       uint64 `json:"total_inactive_anon"`
    TotalInactiveFile       uint64 `json:"total_inactive_file"`
    TotalMappedFile         uint64 `json:"total_mapped_file"`
    TotalPgfault            uint64 `json:"total_pgfault"`
    TotalPgmajfault         uint64 `json:"total_pgmajfault"`
    TotalPgpgin             uint64 `json:"total_pgpgin"`
    TotalPgpgout            uint64 `json:"total_pgpgout"`
    TotalRss                uint64 `json:"total_rss"`
    TotalUnevictable        uint64 `json:"total_unevictable"`
    Unevictable             uint64 `json:"unevictable"`
    Swap                    uint64 `json:"swap"`
    HierarchicalMemswLimit  uint64 `json:"hierarchical_memsw_limit"`
    TotalSwap               uint64 `json:"total_swap"`
    // A memory usage total which reports memory usage in the same way that limits are enforced.
    // This value includes memory consumed by nested containers.
    TotalUsageTowardLimit uint64
}

type ContainerMetricsEntry Uses

type ContainerMetricsEntry struct {
    Metrics Metrics
    Err     *Error
}

type ContainerNetworkStat Uses

type ContainerNetworkStat struct {
    RxBytes uint64
    TxBytes uint64
}

type ContainerNotFoundError Uses

type ContainerNotFoundError struct {
    Handle string
}

func (ContainerNotFoundError) Error Uses

func (err ContainerNotFoundError) Error() string

type ContainerPidStat Uses

type ContainerPidStat struct {
    Current uint64
    Max     uint64
}

type ContainerSpec Uses

type ContainerSpec struct {

    // Handle, if specified, is used to refer to the
    // container in future requests. If it is not specified,
    // garden uses its internal container ID as the container handle.
    Handle string `json:"handle,omitempty"`

    // GraceTime can be used to specify how long a container can go
    // unreferenced by any client connection. After this time, the container will
    // automatically be destroyed. If not specified, the container will be
    // subject to the globally configured grace time.
    GraceTime time.Duration `json:"grace_time,omitempty"`

    // Deprecated in favour of Image property
    RootFSPath string `json:"rootfs,omitempty"`

    // Image contains a URI referring to the root file system for the container.
    // The URI scheme must either be the empty string or "docker".
    //
    // A URI with an empty scheme determines the path of a root file system.
    // If this path is empty, a default root file system is used.
    // Other parts of the URI are ignored.
    //
    // A URI with scheme "docker" refers to a Docker image. The path in the URI
    // (without the leading /) identifies a Docker image as the repository name
    // in the default Docker registry. If a fragment is specified in the URI, this
    // determines the tag associated with the image.
    // If a host is specified in the URI, this determines the Docker registry to use.
    // If no host is specified in the URI, a default Docker registry is used.
    // Other parts of the URI are ignored.
    //
    // Examples:
    // * "/some/path"
    // * "docker:///onsi/grace-busybox"
    // * "docker://index.docker.io/busybox"
    Image ImageRef `json:"image,omitempty"`

    // * bind_mounts: a list of mount point descriptions which will result in corresponding mount
    // points being created in the container's file system.
    //
    // An error is returned if:
    // * one or more of the mount points has a non-existent source directory, or
    // * one or more of the mount points cannot be created.
    BindMounts []BindMount `json:"bind_mounts,omitempty"`

    // Network determines the subnet and IP address of a container.
    //
    // If not specified, a /30 subnet is allocated from a default network pool.
    //
    // If specified, it takes the form a.b.c.d/n where a.b.c.d is an IP address and n is the number of
    // bits in the network prefix. a.b.c.d masked by the first n bits is the network address of a subnet
    // called the subnet address. If the remaining bits are zero (i.e. a.b.c.d *is* the subnet address),
    // the container is allocated an unused IP address from the subnet. Otherwise, the container is given
    // the IP address a.b.c.d.
    //
    // The container IP address cannot be the subnet address or the broadcast address of the subnet
    // (all non prefix bits set) or the address one less than the broadcast address (which is reserved).
    //
    // Multiple containers may share a subnet by passing the same subnet address on the corresponding
    // create calls. Containers on the same subnet can communicate with each other over IP
    // without restriction. In particular, they are not affected by packet filtering.
    //
    // Note that a container can use TCP, UDP, and ICMP, although its external access is governed
    // by filters (see Container.NetOut()) and by any implementation-specific filters.
    //
    // An error is returned if:
    // * the IP address cannot be allocated or is already in use,
    // * the subnet specified overlaps the default network pool, or
    // * the subnet specified overlaps (but does not equal) a subnet that has
    //   already had a container allocated from it.
    Network string `json:"network,omitempty"`

    // Properties is a sequence of string key/value pairs providing arbitrary
    // data about the container. The keys are assumed to be unique but this is not
    // enforced via the protocol.
    Properties Properties `json:"properties,omitempty"`

    // TODO
    Env []string `json:"env,omitempty"`

    // If Privileged is true the container does not have a user namespace and the root user in the container
    // is the same as the root user in the host. Otherwise, the container has a user namespace and the root
    // user in the container is mapped to a non-root user in the host. Defaults to false.
    Privileged bool `json:"privileged,omitempty"`

    // Limits to be applied to the newly created container.
    Limits Limits `json:"limits,omitempty"`

    // Whitelist outbound network traffic.
    //
    // If the configuration directive deny_networks is not used,
    // all networks are already whitelisted and passing any rules is effectively a no-op.
    //
    // Later programmatic NetOut calls take precedence over these rules, which is
    // significant only in relation to logging.
    NetOut []NetOutRule `json:"netout_rules,omitempty"`

    // Map a port on the host to a port in the container so that traffic to the
    // host port is forwarded to the container port.
    //
    // If a host port is not given, a port will be acquired from the server's port
    // pool.
    //
    // If a container port is not given, the port will be the same as the
    // host port.
    NetIn []NetIn `json:"netin,omitempty"`
}

ContainerSpec specifies the parameters for creating a container. All parameters are optional.

type DiskLimitScope Uses

type DiskLimitScope uint8
const DiskLimitScopeExclusive DiskLimitScope = 1
const DiskLimitScopeTotal DiskLimitScope = 0

type DiskLimits Uses

type DiskLimits struct {
    InodeSoft uint64 `json:"inode_soft,omitempty"`
    InodeHard uint64 `json:"inode_hard,omitempty"`

    ByteSoft uint64 `json:"byte_soft,omitempty"`
    ByteHard uint64 `json:"byte_hard,omitempty"`

    Scope DiskLimitScope `json:"scope,omitempty"`
}

type Error Uses

type Error struct {
    Err error
}

func NewError Uses

func NewError(err string) *Error

func (Error) Error Uses

func (m Error) Error() string

func (Error) MarshalJSON Uses

func (m Error) MarshalJSON() ([]byte, error)

func (Error) StatusCode Uses

func (m Error) StatusCode() int

func (*Error) UnmarshalJSON Uses

func (m *Error) UnmarshalJSON(data []byte) error

type ExecutableNotFoundError Uses

type ExecutableNotFoundError struct {
    Message string
}

func (ExecutableNotFoundError) Error Uses

func (err ExecutableNotFoundError) Error() string

type ICMPCode Uses

type ICMPCode uint8

func ICMPControlCode Uses

func ICMPControlCode(code uint8) *ICMPCode

ICMPControlCode creates a value for the Code field in ICMPControl

type ICMPControl Uses

type ICMPControl struct {
    Type ICMPType  `json:"type,omitempty"`
    Code *ICMPCode `json:"code,omitempty"`
}

type ICMPType Uses

type ICMPType uint8

type IPRange Uses

type IPRange struct {
    Start net.IP `json:"start,omitempty"`
    End   net.IP `json:"end,omitempty"`
}

func IPRangeFromIP Uses

func IPRangeFromIP(ip net.IP) IPRange

IPRangeFromIP creates an IPRange containing a single IP

func IPRangeFromIPNet Uses

func IPRangeFromIPNet(ipNet *net.IPNet) IPRange

IPRangeFromIPNet creates an IPRange containing the same IPs as a given IPNet

type ImageRef Uses

type ImageRef struct {
    URI      string `json:"uri,omitempty"`
    Username string `json:"username,omitempty"`
    Password string `json:"password,omitempty"`
}

type Limits Uses

type Limits struct {
    Bandwidth BandwidthLimits `json:"bandwidth_limits,omitempty"`
    CPU       CPULimits       `json:"cpu_limits,omitempty"`
    Disk      DiskLimits      `json:"disk_limits,omitempty"`
    Memory    MemoryLimits    `json:"memory_limits,omitempty"`
    Pid       PidLimits       `json:"pid_limits,omitempty"`
}

type MemoryLimits Uses

type MemoryLimits struct {
    //	Memory usage limit in bytes.
    LimitInBytes uint64 `json:"limit_in_bytes,omitempty"`
}

type Metrics Uses

type Metrics struct {
    MemoryStat     ContainerMemoryStat
    CPUStat        ContainerCPUStat
    DiskStat       ContainerDiskStat
    NetworkStat    ContainerNetworkStat
    PidStat        ContainerPidStat
    Age            time.Duration
    CPUEntitlement uint64
}

type NetIn Uses

type NetIn struct {
    // Host port from which to forward traffic to the container
    HostPort uint32 `json:"host_port"`

    // Container port to which host traffic will be forwarded
    ContainerPort uint32 `json:"container_port"`
}

type NetOutRule Uses

type NetOutRule struct {
    // the protocol to be whitelisted
    Protocol Protocol `json:"protocol,omitempty"`

    // a list of ranges of IP addresses to whitelist; Start to End inclusive; default all
    Networks []IPRange `json:"networks,omitempty"`

    // a list of ranges of ports to whitelist; Start to End inclusive; ignored if Protocol is ICMP; default all
    Ports []PortRange `json:"ports,omitempty"`

    // specifying which ICMP codes to whitelist; ignored if Protocol is not ICMP; default all
    ICMPs *ICMPControl `json:"icmps,omitempty"`

    // if true, logging is enabled; ignored if Protocol is not TCP or All; default false
    Log bool `json:"log,omitempty"`
}

type PidLimits Uses

type PidLimits struct {
    // Limits the number of pids a container may create before new forks or clones are disallowed to processes in the container.
    // Note: this may only be enforced when a process attempts to fork, so it does not guarantee that a new container.Run(ProcessSpec)
    // will not succeed even if the limit has been exceeded, but the process will not be able to spawn further processes or threads.
    Max uint64 `json:"max,omitempty"`
}

type PortMapping Uses

type PortMapping struct {
    HostPort      uint32
    ContainerPort uint32
}

type PortRange Uses

type PortRange struct {
    Start uint16 `json:"start,omitempty"`
    End   uint16 `json:"end,omitempty"`
}

func PortRangeFromPort Uses

func PortRangeFromPort(port uint16) PortRange

PortRangeFromPort creates a PortRange containing a single port

type Process Uses

type Process interface {
    ID() string
    Wait() (int, error)
    SetTTY(TTYSpec) error
    Signal(Signal) error
}

type ProcessIO Uses

type ProcessIO struct {
    Stdin  io.Reader
    Stdout io.Writer
    Stderr io.Writer
}

type ProcessLimits Uses

type ProcessLimits struct {
    CPU    CPULimits    `json:"cpu_limits,omitempty"`
    Memory MemoryLimits `json:"memory_limits,omitempty"`
}

type ProcessNotFoundError Uses

type ProcessNotFoundError struct {
    ProcessID string
}

func (ProcessNotFoundError) Error Uses

func (err ProcessNotFoundError) Error() string

type ProcessSpec Uses

type ProcessSpec struct {
    // ID for the process. If empty, an ID will be generated.
    ID  string `json:"id,omitempty"`

    // Path to command to execute.
    Path string `json:"path,omitempty"`

    // Arguments to pass to command.
    Args []string `json:"args,omitempty"`

    // Environment variables.
    Env []string `json:"env,omitempty"`

    // Working directory (default: home directory).
    Dir string `json:"dir,omitempty"`

    // The name of a user in the container to run the process as.
    // This must either be a username, or uid:gid.
    User string `json:"user,omitempty"`

    // Resource limits
    Limits ResourceLimits `json:"rlimits,omitempty"`

    // Limits to be applied to the newly created process
    OverrideContainerLimits *ProcessLimits `json:"limits,omitempty"`

    // Execute with a TTY for stdio.
    TTY *TTYSpec `json:"tty,omitempty"`

    // Execute process in own root filesystem, different from the other processes
    // in the container.
    Image ImageRef `json:"image,omitempty"`

    // Bind mounts to be applied to the process's filesystem
    // An error is returned if ProcessSpec.Image is not also set.
    BindMounts []BindMount `json:"bind_mounts,omitempty"`
}

ProcessSpec contains parameters for running a script inside a container.

type Properties Uses

type Properties map[string]string

type Protocol Uses

type Protocol uint8
const (
    ProtocolAll Protocol = iota
    ProtocolTCP
    ProtocolUDP
    ProtocolICMP
)

type ResourceLimits Uses

type ResourceLimits struct {
    As         *uint64 `json:"as,omitempty"`
    Core       *uint64 `json:"core,omitempty"`
    Cpu        *uint64 `json:"cpu,omitempty"`
    Data       *uint64 `json:"data,omitempty"`
    Fsize      *uint64 `json:"fsize,omitempty"`
    Locks      *uint64 `json:"locks,omitempty"`
    Memlock    *uint64 `json:"memlock,omitempty"`
    Msgqueue   *uint64 `json:"msgqueue,omitempty"`
    Nice       *uint64 `json:"nice,omitempty"`
    Nofile     *uint64 `json:"nofile,omitempty"`
    Nproc      *uint64 `json:"nproc,omitempty"`
    Rss        *uint64 `json:"rss,omitempty"`
    Rtprio     *uint64 `json:"rtprio,omitempty"`
    Sigpending *uint64 `json:"sigpending,omitempty"`
    Stack      *uint64 `json:"stack,omitempty"`
}

Resource limits.

Please refer to the manual page of getrlimit for a description of the individual fields: http://www.kernel.org/doc/man-pages/online/pages/man2/getrlimit.2.html

type ServiceUnavailableError Uses

type ServiceUnavailableError struct {
    Cause string
}

func (ServiceUnavailableError) Error Uses

func (err ServiceUnavailableError) Error() string

type Signal Uses

type Signal int
const (
    SignalTerminate Signal = iota
    SignalKill
)

type StreamInSpec Uses

type StreamInSpec struct {
    Path      string
    User      string
    TarStream io.Reader
}

type StreamOutSpec Uses

type StreamOutSpec struct {
    Path string
    User string
}

type TTYSpec Uses

type TTYSpec struct {
    WindowSize *WindowSize `json:"window_size,omitempty"`
}

type UnrecoverableError Uses

type UnrecoverableError struct {
    Symptom string
}

func (UnrecoverableError) Error Uses

func (err UnrecoverableError) Error() string

type WindowSize Uses

type WindowSize struct {
    Columns int `json:"columns,omitempty"`
    Rows    int `json:"rows,omitempty"`
}

Directories

PathSynopsis
client
client/connection
client/connection/connectionfakesCode generated by counterfeiter.
gardenfakesCode generated by counterfeiter.
routes
server
server/bomberman
server/streamer
server/timebomb
transport

Package garden imports 6 packages (graph) and is imported by 166 packages. Updated 2019-10-10. Refresh now. Tools for package owners.