Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Container ¶
type Container interface {
io.Closer
ID() string
CloseAfterStream(stream *Stream) error
Background() error
Start(logPrefix string, logs io.Writer, restart <-chan time.Time) (status int64, err error)
Shell(tty TTY, shell ...string) (err error)
HealthCheck() <-chan string
Commit(ref string) (imageID string, err error)
UploadTarTo(tar io.Reader, path string) error
StreamFileTo(stream Stream, path string) error
StreamTarTo(stream Stream, path string) error
StreamFileFrom(path string) (Stream, error)
StreamTarFrom(path string) (Stream, error)
Mkdir(path string) error
}
type ContainerConfig ¶
type ContainerConfig struct {
Name string
// Internal
Hostname string
User string
Image string
WorkingDir string
Port string
Env []string
Entrypoint []string
Cmd []string
SkipProxy bool
// External
Binds []string
NetContainer string
HostIP string
HostPort string
Memory int64 // in bytes
DiskQuota int64 // in bytes
// Healthcheck
Test []string
Interval time.Duration
Timeout time.Duration
StartPeriod time.Duration
Retries int
// Control
Exit <-chan struct{} // default: inherit from engine
Check <-chan time.Time // default: 1 second intervals
}
type Engine ¶
type Engine interface {
NewContainer(config *ContainerConfig) (Container, error)
NewImage() Image
Close() error
}
type EngineConfig ¶
type EngineConfig struct {
Proxy ProxyConfig
Exit <-chan struct{}
}
type ProxyConfig ¶
type RegistryCreds ¶
type Stream ¶
type Stream struct {
io.ReadCloser
*StreamState
}
type StreamState ¶
type StreamState struct {
Size int64
// contains filtered or unexported fields
}
Click to show internal directories.
Click to hide internal directories.