 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package backend includes types to send information to server backends.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildConfig ¶
type BuildConfig struct {
	Source         io.ReadCloser
	ProgressWriter ProgressWriter
	Options        *types.ImageBuildOptions
}
    BuildConfig is the configuration used by a BuildManager to start a build
type ContainerAttachConfig ¶
type ContainerAttachConfig struct {
	GetStreams func() (io.ReadCloser, io.Writer, io.Writer, error)
	UseStdin   bool
	UseStdout  bool
	UseStderr  bool
	Logs       bool
	Stream     bool
	DetachKeys string
	// Used to signify that streams are multiplexed and therefore need a StdWriter to encode stdout/stderr messages accordingly.
	// TODO @cpuguy83: This shouldn't be needed. It was only added so that http and websocket endpoints can use the same function, and the websocket function was not using a stdwriter prior to this change...
	// HOWEVER, the websocket endpoint is using a single stream and SHOULD be encoded with stdout/stderr as is done for HTTP since it is still just a single stream.
	// Since such a change is an API change unrelated to the current changeset we'll keep it as is here and change separately.
	MuxStreams bool
}
    ContainerAttachConfig holds the streams to use when connecting to a container to view logs.
type ContainerCommitConfig ¶ added in v1.12.0
type ContainerCommitConfig struct {
	types.ContainerCommitConfig
	Changes []string
	// TODO: ContainerConfig is only used by the dockerfile Builder, so remove it
	// once the Builder has been updated to use a different interface
	ContainerConfig *container.Config
}
    ContainerCommitConfig is a wrapper around types.ContainerCommitConfig that also transports configuration changes for a container.
type ContainerStatsConfig ¶
ContainerStatsConfig holds information for configuring the runtime behavior of a backend.ContainerStats() call.
type ExecInspect ¶
type ExecInspect struct {
	ID            string
	Running       bool
	ExitCode      *int
	ProcessConfig *ExecProcessConfig
	OpenStdin     bool
	OpenStderr    bool
	OpenStdout    bool
	CanRemove     bool
	ContainerID   string
	DetachKeys    []byte
	Pid           int
}
    ExecInspect holds information about a running process started with docker exec.
type ExecProcessConfig ¶
type ExecProcessConfig struct {
	Tty        bool     `json:"tty"`
	Entrypoint string   `json:"entrypoint"`
	Arguments  []string `json:"arguments"`
	Privileged *bool    `json:"privileged,omitempty"`
	User       string   `json:"user,omitempty"`
}
    ExecProcessConfig holds information about the exec process running on the host.
type GetImageAndLayerOptions ¶
type GetImageAndLayerOptions struct {
	PullOption PullOption
	AuthConfig map[string]types.AuthConfig
	Output     io.Writer
	OS         string
}
    GetImageAndLayerOptions are the options supported by GetImageAndReleasableLayer
type LogMessage ¶
type LogMessage struct {
	Line      []byte
	Source    string
	Timestamp time.Time
	Attrs     []LogAttr
	Partial   bool
	// Err is an error associated with a message. Completeness of a message
	// with Err is not expected, tho it may be partially complete (fields may
	// be missing, gibberish, or nil)
	Err error
}
    LogMessage is datastructure that represents piece of output produced by some container. The Line member is a slice of an array whose contents can be changed after a log driver's Log() method returns. changes to this struct need to be reflect in the reset method in daemon/logger/logger.go
type LogSelector ¶
LogSelector is a list of services and tasks that should be returned as part of a log stream. It is similar to swarmapi.LogSelector, with the difference that the names don't have to be resolved to IDs; this is mostly to avoid accidents later where a swarmapi LogSelector might have been incorrectly used verbatim (and to avoid the handler having to import swarmapi types)
type ProgressWriter ¶ added in v1.12.0
type ProgressWriter struct {
	Output             io.Writer
	StdoutFormatter    io.Writer
	StderrFormatter    io.Writer
	AuxFormatter       *streamformatter.AuxFormatter
	ProgressReaderFunc func(io.ReadCloser) io.ReadCloser
}
    ProgressWriter is a data object to transport progress streams to the client
type PullOption ¶
type PullOption int
PullOption defines different modes for accessing images
const ( // PullOptionNoPull only returns local images PullOptionNoPull PullOption = iota // PullOptionForcePull always tries to pull a ref from the registry first PullOptionForcePull // PullOptionPreferLocal uses local image if it exists, otherwise pulls PullOptionPreferLocal )