package
17.12.1-ce-rc2+incompatible
Repository: https://github.com/raz0rcoder/dockerce.git
Documentation: pkg.go.dev

# Packages

Package backend includes types to send information to server backends.
No description provided by the author
No description provided by the author
No description provided by the author
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

DecodeSecurityOptions decodes a security options string slice to a type safe SecurityOpt.

# Constants

Define actions for Seccomp rules.
Define actions for Seccomp rules.
Define actions for Seccomp rules.
Define actions for Seccomp rules.
Define actions for Seccomp rules.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Additional architectures permitted to be used for system calls By default only the native architecture of the kernel is permitted.
Healthy indicates that the container is running correctly.
Indicates there is no healthcheck.
Define operators for syscall arguments in Seccomp.
Define operators for syscall arguments in Seccomp.
Define operators for syscall arguments in Seccomp.
Define operators for syscall arguments in Seccomp.
Define operators for syscall arguments in Seccomp.
Define operators for syscall arguments in Seccomp.
Define operators for syscall arguments in Seccomp.
Values for RegistryAuthFrom in ServiceUpdateOptions.
Values for RegistryAuthFrom in ServiceUpdateOptions.
Starting indicates that the container is not yet ready.
Unhealthy indicates that the container has a problem.

# Structs

Architecture is used to represent a specific architecture and its sub-architectures.
Arg used for matching specific syscall arguments in Seccomp.
AuthConfig contains authorization information for connecting to a Registry.
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.
BuildCachePruneReport contains the response for Engine API: POST "/build/prune".
BuildResult contains the image id of a successful build.
Checkpoint represents the details of a checkpoint.
CheckpointCreateOptions holds parameters to create a checkpoint from a container.
CheckpointDeleteOptions holds parameters to delete a checkpoint from a container.
CheckpointListOptions holds parameters to list checkpoints for a container.
Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.
ComponentVersion describes the version information for a specific component.
ConfigCreateResponse contains the information returned to a client on the creation of a new config.
ConfigListOptions holds parameters to list configs.
Container contains response of Engine API: GET "/containers/json".
ContainerAttachOptions holds parameters to attach to a container.
ContainerCommitConfig contains build configs for commit operation, and is used when making a commit with the current state of the container.
ContainerCommitOptions holds parameters to commit changes into a container.
ContainerCreateConfig is the parameter set to ContainerCreate().
ContainerExecInspect holds information returned by exec inspect.
ContainerJSON is newly used struct along with MountPoint.
ContainerJSONBase contains response of Engine API: GET "/containers/{name:.*}/json".
ContainerListOptions holds parameters to list containers with.
ContainerLogsOptions holds parameters to filter logs with.
ContainerNode stores information about the node that a container is running on.
ContainerPathStat is used to encode the header from GET "/containers/{name:.*}/archive" "Name" is the file or directory name.
ContainerRemoveOptions holds parameters to remove containers.
ContainerRmConfig holds arguments for the container remove operation.
ContainersPruneReport contains the response for Engine API: POST "/containers/prune".
ContainerStartOptions holds parameters to start containers.
ContainerState stores container's running state it's part of ContainerJSONBase and will return by "inspect" command.
ContainerStats contains response of Engine API: GET "/stats".
CopyConfig contains request body of Engine API: POST "/containers/"+containerID+"/copy".
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.
DefaultNetworkSettings holds network information during the 2 release deprecation period.
DiskUsage contains response of Engine API: GET "/system/df".
EndpointResource contains network resources allocated and used for a container in a network.
ErrorResponse Represents an error.
EventsOptions holds parameters to filter events with.
ExecConfig is a small subset of the Config struct that holds the configuration for the exec feature of docker.
ExecStartCheck is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package.
Filter is used to conditionally apply Seccomp rules.
GraphDriverData Information about a container's graph driver.
Health stores information about the container's healthcheck results.
HealthcheckResult stores information about a single run of a healthcheck probe.
HijackedResponse holds connection information for a hijacked request.
IDResponse Response to an API call that returns just an Id swagger:model IdResponse.
ImageBuildOptions holds the information necessary to build images.
ImageBuildResponse holds information returned by a server after building an image.
ImageCreateOptions holds information to create images.
ImageDeleteResponseItem image delete response item swagger:model ImageDeleteResponseItem.
ImageImportOptions holds information to import images from the client host.
ImageImportSource holds source information for ImageImport.
ImageInspect contains response of Engine API: GET "/images/{name:.*}/json".
ImageListOptions holds parameters to filter the list of images with.
ImageLoadResponse returns information to the client about a load process.
ImageMetadata contains engine-local data about the image.
ImagePullOptions holds information to pull images.
ImageRemoveOptions holds parameters to remove images.
ImageSearchOptions holds parameters to search images with.
ImagesPruneReport contains the response for Engine API: POST "/images/prune".
ImageSummary image summary swagger:model ImageSummary.
Info contains response of Engine API: GET "/info".
KeyValue holds a key/value pair.
MemoryStats aggregates all memory stats since container inception on Linux.
MountPoint represents a mount point configuration inside the container.
NetworkConnect represents the data to be used to connect a container to the network.
NetworkCreate is the expected body of the "create network" http request message.
NetworkCreateRequest is the request message sent to the server for network create call.
NetworkCreateResponse is the response message sent by the server for network create call.
NetworkDisconnect represents the data to be used to disconnect a container from the network.
NetworkInspectOptions holds parameters to inspect network.
NetworkListOptions holds parameters to filter the list of networks with.
NetworkResource is the body of the "get network" http response message.
NetworkSettings exposes the network settings in the api.
NetworkSettingsBase holds basic information about networks.
NetworksPruneReport contains the response for Engine API: POST "/networks/prune".
NetworkStats aggregates the network stats of one container.
NodeListOptions holds parameters to list nodes with.
NodeRemoveOptions holds parameters to remove nodes with.
PidsStats contains the stats of a container's pids.
Ping contains response of Engine API: GET "/_ping".
Plugin A plugin for the Engine API swagger:model Plugin.
PluginConfig The config of a plugin.
PluginConfigArgs plugin config args swagger:model PluginConfigArgs.
PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface.
PluginConfigLinux plugin config linux swagger:model PluginConfigLinux.
PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork.
PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs.
PluginConfigUser plugin config user swagger:model PluginConfigUser.
PluginCreateOptions hold all options to plugin create.
PluginDevice plugin device swagger:model PluginDevice.
PluginDisableConfig holds arguments for plugin disable.
PluginDisableOptions holds parameters to disable plugins.
PluginEnableConfig holds arguments for plugin enable.
PluginEnableOptions holds parameters to enable plugins.
PluginEnv plugin env swagger:model PluginEnv.
PluginInstallOptions holds parameters to install a plugin.
PluginInterfaceType plugin interface type swagger:model PluginInterfaceType.
PluginMount plugin mount swagger:model PluginMount.
PluginPrivilege describes a permission the user has to accept upon installing a plugin.
PluginRemoveOptions holds parameters to remove plugins.
PluginRmConfig holds arguments for plugin remove.
PluginSettings Settings that can be modified by users.
PluginsInfo is a temp struct holding Plugins name registered with docker daemon.
Port An open port on a container swagger:model Port.
PushResult contains the tag, manifest digest, and manifest size from the push.
ResizeOptions holds parameters to resize a tty.
RootFS returns Image's RootFS description including the layer IDs.
Runtime describes an OCI runtime.
Seccomp represents the config for a seccomp profile for syscall restriction.
SecretCreateResponse contains the information returned to a client on the creation of a new secret.
SecretListOptions holds parameters to list secrets.
SecurityOpt contains the name and options of a security option.
ServiceCreateOptions contains the options to use when creating a service.
ServiceCreateResponse contains the information returned to a client on the creation of a new service.
ServiceInspectOptions holds parameters related to the "service inspect" operation.
ServiceListOptions holds parameters to list services with.
ServiceUpdateOptions contains the options to be used for updating services.
ServiceUpdateResponse service update response swagger:model ServiceUpdateResponse.
Stats is Ultimate struct aggregating all types of stats of one container.
StatsJSON is newly used Networks.
StorageStats is the disk I/O stats for read/write on Windows.
SummaryNetworkSettings provides a summary of container's networks in /containers/json.
SwarmUnlockKeyResponse contains the response for Engine API: GET /swarm/unlockkey.
Syscall is used to match a group of syscalls in Seccomp.
TaskListOptions holds parameters to list tasks with.
ThrottlingData stores CPU throttling stats of one running container.
Version contains response of Engine API: GET "/version".
Volume volume swagger:model Volume.
VolumesPruneReport contains the response for Engine API: POST "/volumes/prune".
VolumeUsageData Usage details about the volume.

# Interfaces

CloseWriter is an interface that implements structs that close input streams to prevent from writing.

# Type aliases

Action taken upon Seccomp rule match.
Arch used for architectures.
ImagePushOptions holds information to push images.
Operator used to match syscall arguments in Seccomp.
PluginPrivileges is a list of PluginPrivilege.
PluginsListResponse contains the response for the Engine API.
RequestPrivilegeFunc is a function interface that clients can supply to retry operations after getting an authorization error.