package
28.0.1+incompatible
Repository: https://github.com/dotcloud/docker.git
Documentation: pkg.go.dev

# Functions

ValidateRestartPolicy validates the given RestartPolicy.

# Constants

cgroup namespace modes for containers.
cgroup namespace modes for containers.
cgroup namespace modes for containers.
ChangeAdd represents the add operation.
ChangeDelete represents the delete operation.
ChangeModify represents the modify operation.
Healthy indicates that the container is running correctly.
IpcMode constants.
IpcMode constants.
IpcMode constants.
IpcMode constants.
IpcMode constants.
IsolationDefault is the default isolation mode on current daemon.
IsolationEmpty is unspecified (same behavior as default).
IsolationHyperV is HyperV isolation mode.
IsolationProcess is process isolation mode.
Available logging modes.
Available logging modes.
Available logging modes.
MinimumDuration puts a minimum on user configured duration.
Indicates there is no healthcheck.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Starting indicates that the container is not yet ready.
Unhealthy indicates that the container has a problem.
Possible WaitCondition Values.
Possible WaitCondition Values.
Possible WaitCondition Values.

# Structs

AttachOptions holds parameters to attach to a container.
BlkioStatEntry is one small entity to store a piece of Blkio stats Not used on Windows.
BlkioStats stores All IO service stats for data read and write.
CommitOptions holds parameters to commit changes into a container.
Config contains the configuration data about a container.
ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json" for API version 1.18 and older.
CopyToContainerOptions holds information about files to copy into a container.
CPUStats aggregates and wraps all CPU related info of container.
CPUUsage stores All CPU stats aggregated since container inception.
CreateRequest is the request message sent to the server for container create calls.
CreateResponse ContainerCreateResponse OK response to ContainerCreate operation swagger:model CreateResponse.
DefaultNetworkSettings holds network information during the 2 release deprecation period.
DeviceMapping represents the device mapping between the host and the container.
DeviceRequest represents a request for devices from a device driver.
ExecInspect holds information returned by exec inspect.
ExecOptions is a small subset of the Config struct that holds the configuration for the exec feature of docker.
ExecStartOptions is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package.
FilesystemChange Change in the container's filesystem.
Health stores information about the container's healthcheck results.
HealthcheckResult stores information about a single run of a healthcheck probe.
HostConfig the non-portable Config structure of a container.
InspectResponse is the response for the GET "/containers/{name:.*}/json" endpoint.
ListOptions holds parameters to list containers with.
LogConfig represents the logging configuration of the container.
LogsOptions holds parameters to filter logs with.
MemoryStats aggregates all memory stats since container inception on Linux.
MountPoint represents a mount point configuration inside the container.
NetworkSettings exposes the network settings in the api.
NetworkSettingsBase holds networking state for a container when inspecting it.
NetworkSettingsSummary provides a summary of container's networks in /containers/json.
NetworkStats aggregates the network stats of one container.
PathStat is used to encode the header from GET "/containers/{name:.*}/archive" "Name" is the file or directory name.
PidsStats contains the stats of a container's pids.
Port An open port on a container swagger:model Port.
PruneReport contains the response for Engine API: POST "/containers/prune".
RemoveOptions holds parameters to remove containers.
ResizeOptions holds parameters to resize a TTY.
Resources contains container's resources (cgroups config, ulimits...).
RestartPolicy represents the restart policies of the container.
StartOptions holds parameters to start containers.
State stores container's running state it's part of ContainerJSONBase and returned by "inspect" command.
StatsResponse aggregates all types of stats of one container.
StatsResponseReader wraps an io.ReadCloser to read (a stream of) stats for a container, as produced by the GET "/stats" endpoint.
StopOptions holds the options to stop or restart a container.
StorageStats is the disk I/O stats for read/write on Windows.
Summary contains response of Engine API: GET "/containers/json".
ThrottlingData stores CPU throttling stats of one running container.
TopResponse ContainerTopResponse Container "top" response.
UpdateConfig holds the mutable attributes of a Container.
UpdateResponse ContainerUpdateResponse Response for a successful container-update.
WaitExitError container waiting error, if any swagger:model WaitExitError.
WaitResponse ContainerWaitResponse OK response to ContainerWait operation swagger:model WaitResponse.

# Type aliases

CgroupnsMode represents the cgroup namespace mode of the container.
CgroupSpec represents the cgroup to use for the container.
ChangeType Kind of change Can be one of: - `0`: Modified ("C") - `1`: Added ("A") - `2`: Deleted ("D") swagger:model ChangeType.
CommitResponse response for the commit API call, containing the ID of the image that was produced.
ContainerTopOKBody OK response to ContainerTop operation Deprecated: use [TopResponse].
ContainerUpdateOKBody OK response to ContainerUpdate operation Deprecated: use [UpdateResponse].
ExecAttachOptions is a temp struct used by execAttach.
ExecCreateResponse is the response for a successful exec-create request.
HealthConfig holds configuration settings for the HEALTHCHECK feature.
IpcMode represents the container ipc stack.
Isolation represents the isolation technology of a container.
LogMode is a type to define the available modes for logging These modes affect how logs are handled when log messages start piling up.
NetworkMode represents the container network stack.
PidMode represents the pid namespace of the container.
No description provided by the author
Stats is Ultimate struct aggregating all types of stats of one container Deprecated: use [StatsResponse] instead.
Ulimit is an alias for [units.Ulimit], which may be moving to a different location or become a local type.
UsernsMode represents userns mode in the container.
UTSMode represents the UTS namespace of the container.
WaitCondition is a type used to specify a container state for which to wait.