backend
packageThis package is not in the latest version of its module.
Details
Valid go.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package backend includes types to send information to server backends.
Index¶
- type BuildConfig
- type CommitConfig
- type ContainerAttachConfig
- type ContainerCreateConfig
- type ContainerInspectOptions
- type ContainerRmConfig
- type ContainerStatsConfig
- type CreateImageConfig
- type DiskUsage
- type DiskUsageOptions
- type ExecInspect
- type ExecProcessConfig
- type ExecStartConfig
- type GetImageAndLayerOptions
- type GetImageOpts
- type ImageInspectOpts
- type LogAttr
- type LogMessage
- type LogSelector
- type NetworkListConfig
- type PartialLogMetaData
- type PluginDisableConfig
- type PluginEnableConfig
- type PluginRmConfig
- type ProgressWriter
- type PullOption
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBuildConfig¶
type BuildConfig struct {Sourceio.ReadCloserProgressWriterProgressWriterOptions *build.ImageBuildOptions}BuildConfig is the configuration used by a BuildManager to start a build
typeCommitConfig¶
type CommitConfig struct {AuthorstringCommentstringConfig *container.Config// TODO(thaJeztah); change this to [dockerspec.DockerOCIImageConfig]ContainerConfig *container.ConfigContainerIDstringContainerMountLabelstringContainerOSstringParentImageIDstring}CommitConfig is the configuration for creating an image as part of a build.
typeContainerAttachConfig¶
type ContainerAttachConfig struct {GetStreams func(multiplexedbool, cancel func()) (io.ReadCloser,io.Writer,io.Writer,error)UseStdinboolUseStdoutboolUseStderrboolLogsboolStreamboolDetachKeysstring// Used to signify that streams must be multiplexed by producer as endpoint can't manage multiple streams.// This is typically set by HTTP endpoint, while websocket can transport raw streamsMuxStreamsbool}ContainerAttachConfig holds the streams to use when connecting to a container to view logs.
typeContainerCreateConfig¶
type ContainerCreateConfig struct {NamestringConfig *container.ConfigHostConfig *container.HostConfigNetworkingConfig *network.NetworkingConfigPlatform *ocispec.PlatformDefaultReadOnlyNonRecursivebool}ContainerCreateConfig is the parameter set to ContainerCreate()
typeContainerInspectOptions¶
type ContainerInspectOptions struct {// Size controls whether to propagate the container's size fields.Sizebool}ContainerInspectOptions defines options for the backend.ContainerInspectcall.
typeContainerRmConfig¶
type ContainerRmConfig struct {ForceRemove, RemoveVolume, RemoveLinkbool}ContainerRmConfig holds arguments for the container removeoperation. This struct is used to tell the backend what operationsto perform.
typeContainerStatsConfig¶
ContainerStatsConfig holds information for configuring the runtimebehavior of a backend.ContainerStats() call.
typeCreateImageConfig¶
type CreateImageConfig struct {Tagreference.NamedTaggedPauseboolAuthorstringCommentstringConfig *container.ConfigChanges []string}CreateImageConfig is the configuration for creating an image from acontainer.
typeDiskUsage¶
type DiskUsage struct {Images *image.DiskUsageContainers *container.DiskUsageVolumes *volume.DiskUsageBuildCache *build.CacheDiskUsage}DiskUsage contains the information returned by the backend for theGET "/system/df" endpoint.
typeDiskUsageOptions¶
type DiskUsageOptions struct {// Containers controls whether container disk usage should be computed.Containersbool// Images controls whether image disk usage should be computed.Imagesbool// Volumes controls whether volume disk usage should be computed.Volumesbool}DiskUsageOptions holds parameters for system disk usage query.
typeExecInspect¶
type ExecInspect struct {IDstringRunningboolExitCode *intProcessConfig *ExecProcessConfigOpenStdinboolOpenStderrboolOpenStdoutboolCanRemoveboolContainerIDstringDetachKeys []bytePidint}ExecInspect holds information about a running process startedwith docker exec.
typeExecProcessConfig¶
type ExecProcessConfig struct {Ttybool `json:"tty"`Entrypointstring `json:"entrypoint"`Arguments []string `json:"arguments"`Privileged *bool `json:"privileged,omitempty"`Userstring `json:"user,omitempty"`}ExecProcessConfig holds information about the exec processrunning on the host.
typeExecStartConfig¶
type ExecStartConfig struct {Stdinio.ReaderStdoutio.WriterStderrio.WriterConsoleSize *[2]uint `json:",omitempty"`}ExecStartConfig holds the options to start container's exec.
typeGetImageAndLayerOptions¶
type GetImageAndLayerOptions struct {PullOptionPullOptionAuthConfig map[string]registry.AuthConfigOutputio.WriterPlatform *ocispec.Platform}GetImageAndLayerOptions are the options supported by GetImageAndReleasableLayer
typeGetImageOpts¶
GetImageOpts holds parameters to retrieve image informationfrom the backend.
typeImageInspectOpts¶
ImageInspectOpts holds parameters to inspect an image.
typeLogMessage¶
type LogMessage struct {Line []byteSourcestringTimestamptime.TimeAttrs []LogAttrPLogMetaData *PartialLogMetaData// 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)Errerror}LogMessage is datastructure that represents piece of output produced by somecontainer. The Line member is a slice of an array whose contents can bechanged after a log driver's Log() method returns.
typeLogSelector¶
LogSelector is a list of services and tasks that should be returned as partof a log stream. It is similar to swarmapi.LogSelector, with the differencethat the names don't have to be resolved to IDs; this is mostly to avoidaccidents later where a swarmapi LogSelector might have been incorrectlyused verbatim (and to avoid the handler having to import swarmapi types)
typeNetworkListConfig¶
type NetworkListConfig struct {// TODO(@cpuguy83): naming is hard, this is pulled from what was being used in the router before moving hereDetailedboolVerbosebool}NetworkListConfig stores the options available for listing networks
typePartialLogMetaData¶
type PartialLogMetaData struct {Lastbool// true if this message is last of a partialIDstring// identifies group of messages comprising a single recordOrdinalint// ordering of message in partial group}PartialLogMetaData provides meta data for a partial log message. Messagesexceeding a predefined size are split into chunks with this metadata. Theexpectation is for the logger endpoints to assemble the chunks using thismetadata.
typePluginDisableConfig¶
type PluginDisableConfig struct {ForceDisablebool}PluginDisableConfig holds arguments for plugin disable.
typePluginEnableConfig¶
type PluginEnableConfig struct {Timeoutint}PluginEnableConfig holds arguments for plugin enable
typePluginRmConfig¶
type PluginRmConfig struct {ForceRemovebool}PluginRmConfig holds arguments for plugin remove.
typeProgressWriter¶added inv1.12.0
type ProgressWriter struct {Outputio.WriterStdoutFormatterio.WriterStderrFormatterio.WriterAuxFormatter *streamformatter.AuxFormatterProgressReaderFunc func(io.ReadCloser)io.ReadCloser}ProgressWriter is a data object to transport progress streams to the client
typePullOption¶
type PullOptionint
PullOption defines different modes for accessing images
const (// PullOptionNoPull only returns local imagesPullOptionNoPullPullOption =iota// PullOptionForcePull always tries to pull a ref from the registry firstPullOptionForcePull// PullOptionPreferLocal uses local image if it exists, otherwise pullsPullOptionPreferLocal)