AttachOptions holds parameters to attach to a container.
type BlkioStatEntry struct {
Major uint64 `json:"major"`
Minor uint64 `json:"minor"`
Op string `json:"op"`
Value uint64 `json:"value"`
}
BlkioStatEntry is one small entity to store a piece of Blkio stats Not used on Windows.
type BlkioStats struct {
IoServiceBytesRecursive []BlkioStatEntry `json:"io_service_bytes_recursive"`
IoServicedRecursive []BlkioStatEntry `json:"io_serviced_recursive"`
IoQueuedRecursive []BlkioStatEntry `json:"io_queue_recursive"`
IoServiceTimeRecursive []BlkioStatEntry `json:"io_service_time_recursive"`
IoWaitTimeRecursive []BlkioStatEntry `json:"io_wait_time_recursive"`
IoMergedRecursive []BlkioStatEntry `json:"io_merged_recursive"`
IoTimeRecursive []BlkioStatEntry `json:"io_time_recursive"`
SectorsRecursive []BlkioStatEntry `json:"sectors_recursive"`
}
BlkioStats stores All IO service stats for data read and write. This is a Linux specific structure as the differences between expressing block I/O on Windows and Linux are sufficiently significant to make little sense attempting to morph into a combined structure.
type CPUStats struct {
CPUUsage CPUUsage `json:"cpu_usage"`
SystemUsage uint64 `json:"system_cpu_usage,omitempty"`
OnlineCPUs uint32 `json:"online_cpus,omitempty"`
ThrottlingData ThrottlingData `json:"throttling_data,omitempty"`
}
CPUStats aggregates and wraps all CPU related info of container
type CPUUsage struct {
TotalUsage uint64 `json:"total_usage"`
PercpuUsage []uint64 `json:"percpu_usage,omitempty"`
UsageInKernelmode uint64 `json:"usage_in_kernelmode"`
UsageInUsermode uint64 `json:"usage_in_usermode"`
}
CPUUsage stores All CPU stats aggregated since container inception.
CgroupSpec represents the cgroup to use for the container.
Container returns the ID or name of the container whose cgroup will be used.
IsContainer indicates whether the container is using another container cgroup
Valid indicates whether the cgroup spec is valid.
CgroupnsMode represents the cgroup namespace mode of the container
cgroup namespace modes for containers
IsEmpty indicates whether the container cgroup namespace mode is unset
IsHost indicates whether the container shares the host's cgroup namespace
IsPrivate indicates whether the container uses its own private cgroup namespace
Valid indicates whether the cgroup namespace mode is valid
ChangeType Kind of change
Can be one of:
- `0`: Modified ("C") - `1`: Added ("A") - `2`: Deleted ("D")
swagger:model ChangeType
CommitOptions holds parameters to commit changes into a container.
CommitResponse response for the commit API call, containing the ID of the image that was produced.
Config contains the configuration data about a container. It should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information *should* appear in HostConfig. All fields added to this struct must be marked `omitempty` to keep getting predictable hashes from the old `v1Compatibility` configuration.
ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json" for API version 1.18 and older.
TODO(thaJeztah): combine ContainerJSONBase and InspectResponse into a single struct. The split between ContainerJSONBase (ContainerJSONBase) and InspectResponse (InspectResponse) was done in commit 6deaa58ba5f051039643cedceee97c8695e2af74 (https://github.com/moby/moby/pull/13675). ContainerJSONBase contained all fields for API < 1.19, and InspectResponse held fields that were added in API 1.19 and up. Given that the minimum supported API version is now 1.24, we no longer use the separate type.
ContainerState is a string representation of the container's current state.
It currently is an alias for string, but may become a distinct type in the future.
type CopyToContainerOptions struct {
AllowOverwriteDirWithFile bool
CopyUIDGID bool
}
CopyToContainerOptions holds information about files to copy into a container
CreateRequest is the request message sent to the server for container create calls. It is a config wrapper that holds the container Config (portable) and the corresponding HostConfig (non-portable) and network.NetworkingConfig.
type CreateResponse struct {
ID string `json:"Id"`
Warnings []string `json:"Warnings"`
}
CreateResponse ContainerCreateResponse
OK response to ContainerCreate operation ¶swagger:model CreateResponse
DefaultNetworkSettings holds network information during the 2 release deprecation period. It will be removed in Docker 1.11.
type DeviceMapping struct {
PathOnHost string
PathInContainer string
CgroupPermissions string
}
DeviceMapping represents the device mapping between the host and the container.
DeviceRequest represents a request for devices from a device driver. Used by GPU device drivers.
DiskUsage contains disk usage for containers.
ExecAttachOptions is a temp struct used by execAttach.
TODO(thaJeztah): make this a separate type; ContainerExecAttach does not use the Detach option, and cannot run detached.
ExecCreateResponse is the response for a successful exec-create request. It holds the ID of the exec that was created.
TODO(thaJeztah): make this a distinct type.
type ExecInspect struct {
ExecID string `json:"ID"`
ContainerID string `json:"ContainerID"`
Running bool `json:"Running"`
ExitCode int `json:"ExitCode"`
Pid int `json:"Pid"`
}
ExecInspect holds information returned by exec inspect.
It is used by the client to unmarshal a ExecInspectResponse, but currently only provides a subset of the information included in that type.
TODO(thaJeztah): merge ExecInspect and ExecInspectResponse,
type ExecInspectResponse struct {
ID string `json:"ID"`
Running bool `json:"Running"`
ExitCode *int `json:"ExitCode"`
ProcessConfig *ExecProcessConfig
OpenStdin bool `json:"OpenStdin"`
OpenStderr bool `json:"OpenStderr"`
OpenStdout bool `json:"OpenStdout"`
CanRemove bool `json:"CanRemove"`
ContainerID string `json:"ContainerID"`
DetachKeys []byte `json:"DetachKeys"`
Pid int `json:"Pid"`
}
ExecInspectResponse is the API response for the "GET /exec/{id}/json" endpoint and holds information about and exec.
ExecOptions is a small subset of the Config struct that holds the configuration for the exec feature of docker.
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 ExecStartOptions struct {
Detach bool
Tty bool
ConsoleSize *[2]uint `json:",omitempty"`
}
ExecStartOptions is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package
type FilesystemChange struct {
Kind ChangeType `json:"Kind"`
Path string `json:"Path"`
}
FilesystemChange Change in the container's filesystem.
swagger:model FilesystemChange
Health stores information about the container's healthcheck results
HealthConfig holds configuration settings for the HEALTHCHECK feature.
HealthStatus is a string representation of the container's health.
It currently is an alias for string, but may become a distinct type in future.
HealthSummary stores a summary of 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. Here, "non-portable" means "dependent of the host we are running on". Portable information *should* appear in Config.
InspectResponse is the response for the GET "/containers/{name:.*}/json" endpoint.
IpcMode represents the container ipc stack.
const ( IPCModeNone IpcMode = "none" IPCModeHost IpcMode = "host" IPCModeContainer IpcMode = "container" IPCModePrivate IpcMode = "private" IPCModeShareable IpcMode = "shareable" )
IpcMode constants
Container returns the name of the container ipc stack is going to be used.
IsContainer indicates whether the container uses another container's ipc namespace.
IsEmpty indicates whether container IpcMode is empty
IsHost indicates whether the container shares the host's ipc namespace.
IsNone indicates whether container IpcMode is set to "none".
IsPrivate indicates whether the container uses its own private ipc namespace which can not be shared.
IsShareable indicates whether the container's ipc namespace can be shared with another container.
Valid indicates whether the ipc mode is valid.
Isolation represents the isolation technology of a container. The supported values are platform specific
Isolation modes for containers
IsDefault indicates the default isolation technology of a container. On Linux this is the native driver. On Windows, this is a Windows Server Container.
IsHyperV indicates the use of a Hyper-V partition for isolation
IsProcess indicates the use of process isolation
IsValid indicates if an isolation technology is valid
ListOptions holds parameters to list containers with.
LogConfig represents the logging configuration of the 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.
const ( LogModeUnset LogMode = "" LogModeBlocking LogMode = "blocking" LogModeNonBlock LogMode = "non-blocking" )
Available logging modes
LogsOptions holds parameters to filter logs with.
type MemoryStats struct {
Usage uint64 `json:"usage,omitempty"`
MaxUsage uint64 `json:"max_usage,omitempty"`
Stats map[string]uint64 `json:"stats,omitempty"`
Failcnt uint64 `json:"failcnt,omitempty"`
Limit uint64 `json:"limit,omitempty"`
Commit uint64 `json:"commitbytes,omitempty"`
CommitPeak uint64 `json:"commitpeakbytes,omitempty"`
PrivateWorkingSet uint64 `json:"privateworkingset,omitempty"`
}
MemoryStats aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only.
MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
NetworkMode represents the container network stack.
ConnectedContainer is the id of the container which network this container is connected to.
IsBridge indicates whether container uses the bridge network stack
IsContainer indicates whether container uses a container network stack.
IsDefault indicates whether container uses the default network stack.
IsHost indicates whether container uses the host network stack.
IsNone indicates whether container isn't using a network stack.
IsPrivate indicates whether container uses its private network stack.
IsUserDefined indicates user-created network
NetworkName returns the name of the network stack.
UserDefined indicates user-created network
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
type NetworkStats struct {
RxBytes uint64 `json:"rx_bytes"`
RxPackets uint64 `json:"rx_packets"`
RxErrors uint64 `json:"rx_errors"`
RxDropped uint64 `json:"rx_dropped"`
TxBytes uint64 `json:"tx_bytes"`
TxPackets uint64 `json:"tx_packets"`
TxErrors uint64 `json:"tx_errors"`
TxDropped uint64 `json:"tx_dropped"`
EndpointID string `json:"endpoint_id,omitempty"`
InstanceID string `json:"instance_id,omitempty"`
}
NetworkStats aggregates the network stats of one container
type PathStat struct {
Name string `json:"name"`
Size int64 `json:"size"`
Mode os.FileMode `json:"mode"`
Mtime time.Time `json:"mtime"`
LinkTarget string `json:"linkTarget"`
}
PathStat is used to encode the header from GET "/containers/{name:.*}/archive" "Name" is the file or directory name.
PidMode represents the pid namespace of the container.
Container returns the name of the container whose pid namespace is going to be used.
IsContainer indicates whether the container uses a container's pid namespace.
IsHost indicates whether the container uses the host's pid namespace.
IsPrivate indicates whether the container uses its own new pid namespace.
Valid indicates whether the pid namespace is valid.
type PidsStats struct {
Current uint64 `json:"current,omitempty"`
Limit uint64 `json:"limit,omitempty"`
}
PidsStats contains the stats of a container's pids
type Port struct {
IP string `json:"IP,omitempty"`
PrivatePort uint16 `json:"PrivatePort"`
PublicPort uint16 `json:"PublicPort,omitempty"`
Type string `json:"Type"`
}
Port An open port on a container Example: {"PrivatePort":8080,"PublicPort":80,"Type":"tcp"}
swagger:model Port
PortBinding represents a binding between a Host IP address and a [HostPort].
It is currently an alias for nat.PortBinding but may become a concrete type in a future release.
PortMap is a collection of PortBinding indexed by [HostPort].
It is currently an alias for nat.PortMap but may become a concrete type in a future release.
PortRangeProto is a string containing port number and protocol in the format "80/tcp", or a port range and protocol in the format "80-83/tcp".
It is currently an alias for nat.Port but may become a concrete type in a future release.
PortSet is a collection of structs indexed by [HostPort].
It is currently an alias for nat.PortSet but may become a concrete type in a future release.
type PruneReport struct {
ContainersDeleted []string
SpaceReclaimed uint64
}
PruneReport contains the response for Engine API: POST "/containers/prune"
type RemoveOptions struct {
RemoveVolumes bool
RemoveLinks bool
Force bool
}
RemoveOptions holds parameters to remove containers.
type ResizeOptions struct {
Height uint
Width uint
}
ResizeOptions holds parameters to resize a TTY. It can be used to resize container TTYs and exec process TTYs too.
Resources contains container's resources (cgroups config, ulimits...)
RestartPolicy represents the restart policies of the container.
IsAlways indicates whether the container has the "always" restart policy. This means the container will automatically restart regardless of the exit status.
IsNone indicates whether the container has the "no" restart policy. This means the container will not automatically restart when exiting.
IsOnFailure indicates whether the container has the "on-failure" restart policy. This means the container will automatically restart of exiting with a non-zero exit status.
IsSame compares two RestartPolicy to see if they are the same
IsUnlessStopped indicates whether the container has the "unless-stopped" restart policy. This means the container will automatically restart unless user has put it to stopped state.
type StartOptions struct {
CheckpointID string
CheckpointDir string
}
StartOptions holds parameters to start containers.
State stores container's running state it's part of ContainerJSONBase and returned by "inspect" command
type StatsResponse struct {
Name string `json:"name,omitempty"`
ID string `json:"id,omitempty"`
Read time.Time `json:"read"`
PreRead time.Time `json:"preread"`
PidsStats PidsStats `json:"pids_stats,omitempty"`
BlkioStats BlkioStats `json:"blkio_stats,omitempty"`
NumProcs uint32 `json:"num_procs"`
StorageStats StorageStats `json:"storage_stats,omitempty"`
CPUStats CPUStats `json:"cpu_stats,omitempty"`
PreCPUStats CPUStats `json:"precpu_stats,omitempty"`
MemoryStats MemoryStats `json:"memory_stats,omitempty"`
Networks map[string]NetworkStats `json:"networks,omitempty"`
}
StatsResponse aggregates all types of stats of one container.
type StopOptions struct {
Signal string `json:",omitempty"`
Timeout *int `json:",omitempty"`
}
StopOptions holds the options to stop or restart a container.
type StorageStats struct {
ReadCountNormalized uint64 `json:"read_count_normalized,omitempty"`
ReadSizeBytes uint64 `json:"read_size_bytes,omitempty"`
WriteCountNormalized uint64 `json:"write_count_normalized,omitempty"`
WriteSizeBytes uint64 `json:"write_size_bytes,omitempty"`
}
StorageStats is the disk I/O stats for read/write on Windows.
Summary contains response of Engine API: GET "/containers/json"
type ThrottlingData struct {
Periods uint64 `json:"periods"`
ThrottledPeriods uint64 `json:"throttled_periods"`
ThrottledTime uint64 `json:"throttled_time"`
}
ThrottlingData stores CPU throttling stats of one running container. Not used on Windows.
type TopResponse struct {
Processes [][]string `json:"Processes"`
Titles []string `json:"Titles"`
}
TopResponse ContainerTopResponse
Container "top" response.
swagger:model TopResponse
UTSMode represents the UTS namespace of the container.
IsHost indicates whether the container uses the host's UTS namespace.
IsPrivate indicates whether the container uses its private UTS namespace.
Valid indicates whether the UTS namespace is valid.
type Ulimit = units.Ulimit
Ulimit is an alias for units.Ulimit, which may be moving to a different location or become a local type. This alias is to help transitioning.
Users are recommended to use this alias instead of using units.Ulimit directly.
UpdateConfig holds the mutable attributes of a Container. Those attributes can be updated at runtime.
type UpdateResponse struct {
Warnings []string `json:"Warnings"`
}
UpdateResponse ContainerUpdateResponse
Response for a successful container-update.
swagger:model UpdateResponse
UsernsMode represents userns mode in the container.
IsHost indicates whether the container uses the host's userns.
IsPrivate indicates whether the container uses the a private userns.
Valid indicates whether the userns is valid.
WaitCondition is a type used to specify a container state for which to wait.
Possible WaitCondition Values.
WaitConditionNotRunning (default) is used to wait for any of the non-running states: "created", "exited", "dead", "removing", or "removed".
WaitConditionNextExit is used to wait for the next time the state changes to a non-running state. If the state is currently "created" or "exited", this would cause Wait() to block until either the container runs and exits or is removed.
WaitConditionRemoved is used to wait for the container to be removed.
type WaitExitError struct {
Message string `json:"Message,omitempty"`
}
WaitExitError container waiting error, if any
swagger:model WaitExitError
type WaitResponse struct {
Error *WaitExitError `json:"Error,omitempty"`
StatusCode int64 `json:"StatusCode"`
}
WaitResponse ContainerWaitResponse
OK response to ContainerWait operation ¶swagger:model WaitResponse
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4