system
packageThis package is not in the latest version of its module.
Details
Validgo.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¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeCommit¶
type Commit struct {// ID is the actual commit ID or version of external tool.IDstring}Commit holds the Git-commit (SHA1) that a binary was built from, as reportedin the version-string of external tools, such as containerd, or runC.
typeComponentVersion¶
type ComponentVersion struct {NamestringVersionstring// Details contains Key/value pairs of strings with additional information// about the component. These values are intended for informational purposes// only, and their content is not defined, and not part of the API// specification.//// These messages can be printed by the client as information to the user.Details map[string]string `json:",omitempty"`}ComponentVersion describes the version information for a specific component.
typeContainerdInfo¶
type ContainerdInfo struct {// Address is the path to the containerd socket.Addressstring `json:",omitempty"`// Namespaces is the containerd namespaces used by the daemon.NamespacesContainerdNamespaces}ContainerdInfo holds information about the containerd instance used by the daemon.
typeContainerdNamespaces¶
type ContainerdNamespaces struct {// Containers holds the default containerd namespace used for// containers managed by the daemon.//// The default namespace for containers is "moby", but will be// suffixed with the `<uid>.<gid>` of the remapped `root` if// user-namespaces are enabled and the containerd image-store// is used.Containersstring// Plugins holds the default containerd namespace used for// plugins managed by the daemon.//// The default namespace for plugins is "moby", but will be// suffixed with the `<uid>.<gid>` of the remapped `root` if// user-namespaces are enabled and the containerd image-store// is used.Pluginsstring}ContainerdNamespaces reflects the containerd namespaces used by the daemon.
These namespaces can be configured in the daemon configuration, and areconsidered to be used exclusively by the daemon,
As these namespaces are considered to be exclusively accessedby the daemon, it is not recommended to change these values,or to change them to a value that is used by other systems,such as cri-containerd.
typeDeviceInfo¶
type DeviceInfo struct {// Source indicates the origin device driver.Sourcestring `json:"Source"`// ID is the unique identifier for the device.// Example: CDI FQDN like "vendor.com/gpu=0", or other driver-specific device IDIDstring `json:"ID"`}DeviceInfo represents a discoverable device from a device driver.
typeDiskUsage¶
type DiskUsage struct {ImageUsage *image.DiskUsage `json:"ImageUsage,omitempty"`ContainerUsage *container.DiskUsage `json:"ContainerUsage,omitempty"`VolumeUsage *volume.DiskUsage `json:"VolumeUsage,omitempty"`BuildCacheUsage *build.DiskUsage `json:"BuildCacheUsage,omitempty"`}DiskUsage contains response of Engine API:GET "/system/df"
typeDiskUsageObject¶
type DiskUsageObjectstring
DiskUsageObject represents an object type used for disk usage query filtering.
const (// ContainerObject represents a container DiskUsageObject.ContainerObjectDiskUsageObject = "container"// ImageObject represents an image DiskUsageObject.ImageObjectDiskUsageObject = "image"// VolumeObject represents a volume DiskUsageObject.VolumeObjectDiskUsageObject = "volume"// BuildCacheObject represents a build-cache DiskUsageObject.BuildCacheObjectDiskUsageObject = "build-cache")
typeFirewallInfo¶
type FirewallInfo struct {// Driver is the name of the firewall backend driver.Driverstring `json:"Driver"`// Info is a list of label/value pairs, containing information related to the firewall.Info [][2]string `json:"Info,omitempty"`}FirewallInfo describes the firewall backend.
typeInfo¶
type Info struct {IDstringContainersintContainersRunningintContainersPausedintContainersStoppedintImagesintDriverstringDriverStatus [][2]stringSystemStatus [][2]string `json:",omitempty"`// SystemStatus is only propagated by the Swarm standalone APIPluginsPluginsInfoMemoryLimitboolSwapLimitboolCPUCfsPeriodbool `json:"CpuCfsPeriod"`CPUCfsQuotabool `json:"CpuCfsQuota"`CPUSharesboolCPUSetboolPidsLimitboolIPv4ForwardingboolDebugboolNFdintOomKillDisableboolNGoroutinesintSystemTimestringLoggingDriverstringCgroupDriverstringCgroupVersionstring `json:",omitempty"`NEventsListenerintKernelVersionstringOperatingSystemstringOSVersionstringOSTypestringArchitecturestringIndexServerAddressstringRegistryConfig *registry.ServiceConfigNCPUintMemTotalint64GenericResources []swarm.GenericResourceDockerRootDirstringHTTPProxystring `json:"HttpProxy"`HTTPSProxystring `json:"HttpsProxy"`NoProxystringNamestringLabels []stringExperimentalBuildboolServerVersionstringRuntimes map[string]RuntimeWithStatusDefaultRuntimestringSwarmswarm.Info// LiveRestoreEnabled determines whether containers should be kept// running when the daemon is shutdown or upon daemon start if// running containers are detectedLiveRestoreEnabledboolIsolationcontainer.IsolationInitBinarystringContainerdCommitCommitRuncCommitCommitInitCommitCommitSecurityOptions []stringProductLicensestring `json:",omitempty"`DefaultAddressPools []NetworkAddressPool `json:",omitempty"`FirewallBackend *FirewallInfo `json:"FirewallBackend,omitempty"`CDISpecDirs []stringDiscoveredDevices []DeviceInfo `json:",omitempty"`Containerd *ContainerdInfo `json:",omitempty"`// Warnings contains a slice of warnings that occurred while collecting// system information. These warnings are intended to be informational// messages for the user, and are not intended to be parsed / used for// other purposes, as they do not have a fixed format.Warnings []string}Info contains response of Engine API:GET "/info"
typeNetworkAddressPool¶
NetworkAddressPool is a temp struct used byInfo struct.
typePlatformInfo¶
type PlatformInfo struct {// Name is the name of the platform (for example, "Docker Engine - Community",// or "Docker Desktop 4.49.0 (208003)")Namestring}PlatformInfo holds information about the platform (product name) theserver is running on.
typePluginsInfo¶
type PluginsInfo struct {// List of Volume plugins registeredVolume []string// List of Network plugins registeredNetwork []string// List of Authorization plugins registeredAuthorization []string// List of Log plugins registeredLog []string}PluginsInfo is a temp struct holding Plugins nameregistered with docker daemon. It is used byInfo struct
typeRuntime¶
type Runtime struct {Pathstring `json:"path,omitempty"`Args []string `json:"runtimeArgs,omitempty"`Typestring `json:"runtimeType,omitempty"`Options map[string]any `json:"options,omitempty"`}Runtime describes an OCI runtime
typeRuntimeWithStatus¶
RuntimeWithStatus extendsRuntime to hold [RuntimeStatus].
typeVersionResponse¶
type VersionResponse struct {// Platform is the platform (product name) the server is running on.PlatformPlatformInfo `json:",omitempty"`// Version is the version of the daemon.Versionstring// APIVersion is the highest API version supported by the server.APIVersionstring `json:"ApiVersion"`// MinAPIVersion is the minimum API version the server supports.MinAPIVersionstring `json:"MinAPIVersion,omitempty"`// Os is the operating system the server runs on.Osstring// Arch is the hardware architecture the server runs on.Archstring// Components contains version information for the components making// up the server. Information in this field is for informational// purposes, and not part of the API contract.Components []ComponentVersion `json:",omitempty"`GitCommitstring `json:",omitempty"`GoVersionstring `json:",omitempty"`KernelVersionstring `json:",omitempty"`Experimentalbool `json:",omitempty"`BuildTimestring `json:",omitempty"`}VersionResponse contains information about the Docker server host.GET "/version"