Documentation
¶
Overview ¶
Package types catalogs github.com/moby/moby/api/types/system for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/engine/system/types), not in renamed aliases.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Commit ¶
Commit wraps system.Commit.
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.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#Commit GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type Commit from system.
type ComponentVersion ¶
type ComponentVersion = system.ComponentVersion
ComponentVersion wraps system.ComponentVersion.
ComponentVersion describes the version information for a specific component.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#ComponentVersion GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/version_response.go Kind: struct Usecase: wrap the Engine API type ComponentVersion from system.
type ContainerdInfo ¶
type ContainerdInfo = system.ContainerdInfo
ContainerdInfo wraps system.ContainerdInfo.
ContainerdInfo holds information about the containerd instance used by the daemon.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#ContainerdInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type ContainerdInfo from system.
type ContainerdNamespaces ¶
type ContainerdNamespaces = system.ContainerdNamespaces
ContainerdNamespaces wraps system.ContainerdNamespaces.
ContainerdNamespaces reflects the containerd namespaces used by the daemon.
These namespaces can be configured in the daemon configuration, and are considered to be used exclusively by the daemon,
As these namespaces are considered to be exclusively accessed by 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.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#ContainerdNamespaces GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type ContainerdNamespaces from system.
type DeviceInfo ¶
type DeviceInfo = system.DeviceInfo
DeviceInfo wraps system.DeviceInfo.
DeviceInfo represents a discoverable device from a device driver.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#DeviceInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type DeviceInfo from system.
type DiskUsage ¶
DiskUsage wraps system.DiskUsage.
DiskUsage contains response of Engine API: GET "/system/df"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#DiskUsage GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/disk_usage.go Kind: struct References: github.com/moby/moby/api/types/build.DiskUsage, github.com/moby/moby/api/types/container.DiskUsage, github.com/moby/moby/api/types/image.DiskUsage, github.com/moby/moby/api/types/volume.DiskUsage Usecase: wrap the Engine API type DiskUsage from system.
type DiskUsageObject ¶
type DiskUsageObject = system.DiskUsageObject
DiskUsageObject wraps system.DiskUsageObject.
DiskUsageObject represents an object type used for disk usage query filtering.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#DiskUsageObject GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/disk_usage.go Kind: named:string Underlying: string Usecase: wrap the Engine API type DiskUsageObject from system.
type FirewallInfo ¶
type FirewallInfo = system.FirewallInfo
FirewallInfo wraps system.FirewallInfo.
FirewallInfo describes the firewall backend.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#FirewallInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type FirewallInfo from system.
type Info ¶
Info wraps system.Info.
Info contains response of Engine API: GET "/info"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#Info GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct References: github.com/moby/moby/api/types/container.Isolation, github.com/moby/moby/api/types/registry.ServiceConfig, github.com/moby/moby/api/types/swarm.GenericResource, github.com/moby/moby/api/types/swarm.Info Usecase: wrap the Engine API type Info from system.
type NRIInfo ¶
NRIInfo wraps system.NRIInfo.
NRIInfo describes the NRI configuration.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#NRIInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type NRIInfo from system.
type NetworkAddressPool ¶
type NetworkAddressPool = system.NetworkAddressPool
NetworkAddressPool wraps system.NetworkAddressPool.
NetworkAddressPool is a temp struct used by Info struct.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#NetworkAddressPool GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct References: net/netip.Prefix Usecase: wrap the Engine API type NetworkAddressPool from system.
type PlatformInfo ¶
type PlatformInfo = system.PlatformInfo
PlatformInfo wraps system.PlatformInfo.
PlatformInfo holds information about the platform (product name) the server is running on.
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#PlatformInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/version_response.go Kind: struct Usecase: wrap the Engine API type PlatformInfo from system.
type PluginsInfo ¶
type PluginsInfo = system.PluginsInfo
PluginsInfo wraps system.PluginsInfo.
PluginsInfo is a temp struct holding Plugins name registered with docker daemon. It is used by Info struct
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#PluginsInfo GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/info.go Kind: struct Usecase: wrap the Engine API type PluginsInfo from system.
type Runtime ¶
Runtime wraps system.Runtime.
Runtime describes an OCI runtime ¶
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#Runtime GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/runtime.go Kind: struct Usecase: wrap the Engine API type Runtime from system.
type RuntimeWithStatus ¶
type RuntimeWithStatus = system.RuntimeWithStatus
RuntimeWithStatus wraps system.RuntimeWithStatus.
RuntimeWithStatus extends Runtime to hold [RuntimeStatus].
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#RuntimeWithStatus GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/runtime.go Kind: struct Usecase: wrap the Engine API type RuntimeWithStatus from system.
type VersionResponse ¶
type VersionResponse = system.VersionResponse
VersionResponse wraps system.VersionResponse.
VersionResponse contains information about the Docker server host. GET "/version"
Source: https://pkg.go.dev/github.com/moby/moby/api/types/system#VersionResponse GitHub: https://github.com/moby/moby/blob/api/v1.56.1/api/types/system/version_response.go Kind: struct Usecase: wrap the Engine API type VersionResponse from system.