123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785 |
- package types // import "github.com/docker/docker/api/types"
- import (
- "errors"
- "fmt"
- "io"
- "os"
- "strings"
- "time"
- "github.com/docker/docker/api/types/container"
- "github.com/docker/docker/api/types/filters"
- "github.com/docker/docker/api/types/mount"
- "github.com/docker/docker/api/types/network"
- "github.com/docker/docker/api/types/registry"
- "github.com/docker/docker/api/types/swarm"
- "github.com/docker/go-connections/nat"
- )
- // RootFS returns Image's RootFS description including the layer IDs.
- type RootFS struct {
- Type string `json:",omitempty"`
- Layers []string `json:",omitempty"`
- }
- // ImageInspect contains response of Engine API:
- // GET "/images/{name:.*}/json"
- type ImageInspect struct {
- // ID is the content-addressable ID of an image.
- //
- // This identified is a content-addressable digest calculated from the
- // image's configuration (which includes the digests of layers used by
- // the image).
- //
- // Note that this digest differs from the `RepoDigests` below, which
- // holds digests of image manifests that reference the image.
- ID string `json:"Id"`
- // RepoTags is a list of image names/tags in the local image cache that
- // reference this image.
- //
- // Multiple image tags can refer to the same imagem and this list may be
- // empty if no tags reference the image, in which case the image is
- // "untagged", in which case it can still be referenced by its ID.
- RepoTags []string
- // RepoDigests is a list of content-addressable digests of locally available
- // image manifests that the image is referenced from. Multiple manifests can
- // refer to the same image.
- //
- // These digests are usually only available if the image was either pulled
- // from a registry, or if the image was pushed to a registry, which is when
- // the manifest is generated and its digest calculated.
- RepoDigests []string
- // Parent is the ID of the parent image.
- //
- // Depending on how the image was created, this field may be empty and
- // is only set for images that were built/created locally. This field
- // is empty if the image was pulled from an image registry.
- Parent string
- // Comment is an optional message that can be set when committing or
- // importing the image.
- Comment string
- // Created is the date and time at which the image was created, formatted in
- // RFC 3339 nano-seconds (time.RFC3339Nano).
- Created string
- // Container is the ID of the container that was used to create the image.
- //
- // Depending on how the image was created, this field may be empty.
- Container string
- // ContainerConfig is an optional field containing the configuration of the
- // container that was last committed when creating the image.
- //
- // Previous versions of Docker builder used this field to store build cache,
- // and it is not in active use anymore.
- ContainerConfig *container.Config
- // DockerVersion is the version of Docker that was used to build the image.
- //
- // Depending on how the image was created, this field may be empty.
- DockerVersion string
- // Author is the name of the author that was specified when committing the
- // image, or as specified through MAINTAINER (deprecated) in the Dockerfile.
- Author string
- Config *container.Config
- // Architecture is the hardware CPU architecture that the image runs on.
- Architecture string
- // Variant is the CPU architecture variant (presently ARM-only).
- Variant string `json:",omitempty"`
- // OS is the Operating System the image is built to run on.
- Os string
- // OsVersion is the version of the Operating System the image is built to
- // run on (especially for Windows).
- OsVersion string `json:",omitempty"`
- // Size is the total size of the image including all layers it is composed of.
- Size int64
- // VirtualSize is the total size of the image including all layers it is
- // composed of.
- //
- // In versions of Docker before v1.10, this field was calculated from
- // the image itself and all of its parent images. Docker v1.10 and up
- // store images self-contained, and no longer use a parent-chain, making
- // this field an equivalent of the Size field.
- //
- // This field is kept for backward compatibility, but may be removed in
- // a future version of the API.
- VirtualSize int64 // TODO(thaJeztah): deprecate this field
- // GraphDriver holds information about the storage driver used to store the
- // container's and image's filesystem.
- GraphDriver GraphDriverData
- // RootFS contains information about the image's RootFS, including the
- // layer IDs.
- RootFS RootFS
- // Metadata of the image in the local cache.
- //
- // This information is local to the daemon, and not part of the image itself.
- Metadata ImageMetadata
- }
- // ImageMetadata contains engine-local data about the image
- type ImageMetadata struct {
- // LastTagTime is the date and time at which the image was last tagged.
- LastTagTime time.Time `json:",omitempty"`
- }
- // Container contains response of Engine API:
- // GET "/containers/json"
- type Container struct {
- ID string `json:"Id"`
- Names []string
- Image string
- ImageID string
- Command string
- Created int64
- Ports []Port
- SizeRw int64 `json:",omitempty"`
- SizeRootFs int64 `json:",omitempty"`
- Labels map[string]string
- State string
- Status string
- HostConfig struct {
- NetworkMode string `json:",omitempty"`
- }
- NetworkSettings *SummaryNetworkSettings
- Mounts []MountPoint
- }
- // CopyConfig contains request body of Engine API:
- // POST "/containers/"+containerID+"/copy"
- type CopyConfig struct {
- Resource string
- }
- // ContainerPathStat is used to encode the header from
- // GET "/containers/{name:.*}/archive"
- // "Name" is the file or directory name.
- type ContainerPathStat struct {
- Name string `json:"name"`
- Size int64 `json:"size"`
- Mode os.FileMode `json:"mode"`
- Mtime time.Time `json:"mtime"`
- LinkTarget string `json:"linkTarget"`
- }
- // ContainerStats contains response of Engine API:
- // GET "/stats"
- type ContainerStats struct {
- Body io.ReadCloser `json:"body"`
- OSType string `json:"ostype"`
- }
- // Ping contains response of Engine API:
- // GET "/_ping"
- type Ping struct {
- APIVersion string
- OSType string
- Experimental bool
- BuilderVersion BuilderVersion
- // SwarmStatus provides information about the current swarm status of the
- // engine, obtained from the "Swarm" header in the API response.
- //
- // It can be a nil struct if the API version does not provide this header
- // in the ping response, or if an error occurred, in which case the client
- // should use other ways to get the current swarm status, such as the /swarm
- // endpoint.
- SwarmStatus *swarm.Status
- }
- // ComponentVersion describes the version information for a specific component.
- type ComponentVersion struct {
- Name string
- Version string
- Details map[string]string `json:",omitempty"`
- }
- // Version contains response of Engine API:
- // GET "/version"
- type Version struct {
- Platform struct{ Name string } `json:",omitempty"`
- Components []ComponentVersion `json:",omitempty"`
- // The following fields are deprecated, they relate to the Engine component and are kept for backwards compatibility
- Version string
- APIVersion string `json:"ApiVersion"`
- MinAPIVersion string `json:"MinAPIVersion,omitempty"`
- GitCommit string
- GoVersion string
- Os string
- Arch string
- KernelVersion string `json:",omitempty"`
- Experimental bool `json:",omitempty"`
- BuildTime string `json:",omitempty"`
- }
- // 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.
- type Commit struct {
- ID string // ID is the actual commit ID of external tool.
- Expected string // Expected is the commit ID of external tool expected by dockerd as set at build time.
- }
- // Info contains response of Engine API:
- // GET "/info"
- type Info struct {
- ID string
- Containers int
- ContainersRunning int
- ContainersPaused int
- ContainersStopped int
- Images int
- Driver string
- DriverStatus [][2]string
- SystemStatus [][2]string `json:",omitempty"` // SystemStatus is only propagated by the Swarm standalone API
- Plugins PluginsInfo
- MemoryLimit bool
- SwapLimit bool
- KernelMemory bool `json:",omitempty"` // Deprecated: kernel 5.4 deprecated kmem.limit_in_bytes
- KernelMemoryTCP bool `json:",omitempty"` // KernelMemoryTCP is not supported on cgroups v2.
- CPUCfsPeriod bool `json:"CpuCfsPeriod"`
- CPUCfsQuota bool `json:"CpuCfsQuota"`
- CPUShares bool
- CPUSet bool
- PidsLimit bool
- IPv4Forwarding bool
- BridgeNfIptables bool
- BridgeNfIP6tables bool `json:"BridgeNfIp6tables"`
- Debug bool
- NFd int
- OomKillDisable bool
- NGoroutines int
- SystemTime string
- LoggingDriver string
- CgroupDriver string
- CgroupVersion string `json:",omitempty"`
- NEventsListener int
- KernelVersion string
- OperatingSystem string
- OSVersion string
- OSType string
- Architecture string
- IndexServerAddress string
- RegistryConfig *registry.ServiceConfig
- NCPU int
- MemTotal int64
- GenericResources []swarm.GenericResource
- DockerRootDir string
- HTTPProxy string `json:"HttpProxy"`
- HTTPSProxy string `json:"HttpsProxy"`
- NoProxy string
- Name string
- Labels []string
- ExperimentalBuild bool
- ServerVersion string
- ClusterStore string `json:",omitempty"` // Deprecated: host-discovery and overlay networks with external k/v stores are deprecated
- ClusterAdvertise string `json:",omitempty"` // Deprecated: host-discovery and overlay networks with external k/v stores are deprecated
- Runtimes map[string]Runtime
- DefaultRuntime string
- Swarm swarm.Info
- // LiveRestoreEnabled determines whether containers should be kept
- // running when the daemon is shutdown or upon daemon start if
- // running containers are detected
- LiveRestoreEnabled bool
- Isolation container.Isolation
- InitBinary string
- ContainerdCommit Commit
- RuncCommit Commit
- InitCommit Commit
- SecurityOptions []string
- ProductLicense string `json:",omitempty"`
- DefaultAddressPools []NetworkAddressPool `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
- }
- // KeyValue holds a key/value pair
- type KeyValue struct {
- Key, Value string
- }
- // NetworkAddressPool is a temp struct used by Info struct
- type NetworkAddressPool struct {
- Base string
- Size int
- }
- // SecurityOpt contains the name and options of a security option
- type SecurityOpt struct {
- Name string
- Options []KeyValue
- }
- // DecodeSecurityOptions decodes a security options string slice to a type safe
- // SecurityOpt
- func DecodeSecurityOptions(opts []string) ([]SecurityOpt, error) {
- so := []SecurityOpt{}
- for _, opt := range opts {
- // support output from a < 1.13 docker daemon
- if !strings.Contains(opt, "=") {
- so = append(so, SecurityOpt{Name: opt})
- continue
- }
- secopt := SecurityOpt{}
- split := strings.Split(opt, ",")
- for _, s := range split {
- kv := strings.SplitN(s, "=", 2)
- if len(kv) != 2 {
- return nil, fmt.Errorf("invalid security option %q", s)
- }
- if kv[0] == "" || kv[1] == "" {
- return nil, errors.New("invalid empty security option")
- }
- if kv[0] == "name" {
- secopt.Name = kv[1]
- continue
- }
- secopt.Options = append(secopt.Options, KeyValue{Key: kv[0], Value: kv[1]})
- }
- so = append(so, secopt)
- }
- return so, nil
- }
- // PluginsInfo is a temp struct holding Plugins name
- // registered with docker daemon. It is used by Info struct
- type PluginsInfo struct {
- // List of Volume plugins registered
- Volume []string
- // List of Network plugins registered
- Network []string
- // List of Authorization plugins registered
- Authorization []string
- // List of Log plugins registered
- Log []string
- }
- // ExecStartCheck is a temp struct used by execStart
- // Config fields is part of ExecConfig in runconfig package
- type ExecStartCheck struct {
- // ExecStart will first check if it's detached
- Detach bool
- // Check if there's a tty
- Tty bool
- }
- // HealthcheckResult stores information about a single run of a healthcheck probe
- type HealthcheckResult struct {
- Start time.Time // Start is the time this check started
- End time.Time // End is the time this check ended
- ExitCode int // ExitCode meanings: 0=healthy, 1=unhealthy, 2=reserved (considered unhealthy), else=error running probe
- Output string // Output from last check
- }
- // Health states
- const (
- NoHealthcheck = "none" // Indicates there is no healthcheck
- Starting = "starting" // Starting indicates that the container is not yet ready
- Healthy = "healthy" // Healthy indicates that the container is running correctly
- Unhealthy = "unhealthy" // Unhealthy indicates that the container has a problem
- )
- // Health stores information about the container's healthcheck results
- type Health struct {
- Status string // Status is one of Starting, Healthy or Unhealthy
- FailingStreak int // FailingStreak is the number of consecutive failures
- Log []*HealthcheckResult // Log contains the last few results (oldest first)
- }
- // ContainerState stores container's running state
- // it's part of ContainerJSONBase and will return by "inspect" command
- type ContainerState struct {
- Status string // String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
- Running bool
- Paused bool
- Restarting bool
- OOMKilled bool
- Dead bool
- Pid int
- ExitCode int
- Error string
- StartedAt string
- FinishedAt string
- Health *Health `json:",omitempty"`
- }
- // ContainerNode stores information about the node that a container
- // is running on. It's only used by the Docker Swarm standalone API
- type ContainerNode struct {
- ID string
- IPAddress string `json:"IP"`
- Addr string
- Name string
- Cpus int
- Memory int64
- Labels map[string]string
- }
- // ContainerJSONBase contains response of Engine API:
- // GET "/containers/{name:.*}/json"
- type ContainerJSONBase struct {
- ID string `json:"Id"`
- Created string
- Path string
- Args []string
- State *ContainerState
- Image string
- ResolvConfPath string
- HostnamePath string
- HostsPath string
- LogPath string
- Node *ContainerNode `json:",omitempty"` // Node is only propagated by Docker Swarm standalone API
- Name string
- RestartCount int
- Driver string
- Platform string
- MountLabel string
- ProcessLabel string
- AppArmorProfile string
- ExecIDs []string
- HostConfig *container.HostConfig
- GraphDriver GraphDriverData
- SizeRw *int64 `json:",omitempty"`
- SizeRootFs *int64 `json:",omitempty"`
- }
- // ContainerJSON is newly used struct along with MountPoint
- type ContainerJSON struct {
- *ContainerJSONBase
- Mounts []MountPoint
- Config *container.Config
- NetworkSettings *NetworkSettings
- }
- // NetworkSettings exposes the network settings in the api
- type NetworkSettings struct {
- NetworkSettingsBase
- DefaultNetworkSettings
- Networks map[string]*network.EndpointSettings
- }
- // SummaryNetworkSettings provides a summary of container's networks
- // in /containers/json
- type SummaryNetworkSettings struct {
- Networks map[string]*network.EndpointSettings
- }
- // NetworkSettingsBase holds basic information about networks
- type NetworkSettingsBase struct {
- Bridge string // Bridge is the Bridge name the network uses(e.g. `docker0`)
- SandboxID string // SandboxID uniquely represents a container's network stack
- HairpinMode bool // HairpinMode specifies if hairpin NAT should be enabled on the virtual interface
- LinkLocalIPv6Address string // LinkLocalIPv6Address is an IPv6 unicast address using the link-local prefix
- LinkLocalIPv6PrefixLen int // LinkLocalIPv6PrefixLen is the prefix length of an IPv6 unicast address
- Ports nat.PortMap // Ports is a collection of PortBinding indexed by Port
- SandboxKey string // SandboxKey identifies the sandbox
- SecondaryIPAddresses []network.Address
- SecondaryIPv6Addresses []network.Address
- }
- // DefaultNetworkSettings holds network information
- // during the 2 release deprecation period.
- // It will be removed in Docker 1.11.
- type DefaultNetworkSettings struct {
- EndpointID string // EndpointID uniquely represents a service endpoint in a Sandbox
- Gateway string // Gateway holds the gateway address for the network
- GlobalIPv6Address string // GlobalIPv6Address holds network's global IPv6 address
- GlobalIPv6PrefixLen int // GlobalIPv6PrefixLen represents mask length of network's global IPv6 address
- IPAddress string // IPAddress holds the IPv4 address for the network
- IPPrefixLen int // IPPrefixLen represents mask length of network's IPv4 address
- IPv6Gateway string // IPv6Gateway holds gateway address specific for IPv6
- MacAddress string // MacAddress holds the MAC address for the network
- }
- // MountPoint represents a mount point configuration inside the container.
- // This is used for reporting the mountpoints in use by a container.
- type MountPoint struct {
- // Type is the type of mount, see `Type<foo>` definitions in
- // github.com/docker/docker/api/types/mount.Type
- Type mount.Type `json:",omitempty"`
- // Name is the name reference to the underlying data defined by `Source`
- // e.g., the volume name.
- Name string `json:",omitempty"`
- // Source is the source location of the mount.
- //
- // For volumes, this contains the storage location of the volume (within
- // `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains
- // the source (host) part of the bind-mount. For `tmpfs` mount points, this
- // field is empty.
- Source string
- // Destination is the path relative to the container root (`/`) where the
- // Source is mounted inside the container.
- Destination string
- // Driver is the volume driver used to create the volume (if it is a volume).
- Driver string `json:",omitempty"`
- // Mode is a comma separated list of options supplied by the user when
- // creating the bind/volume mount.
- //
- // The default is platform-specific (`"z"` on Linux, empty on Windows).
- Mode string
- // RW indicates whether the mount is mounted writable (read-write).
- RW bool
- // Propagation describes how mounts are propagated from the host into the
- // mount point, and vice-versa. Refer to the Linux kernel documentation
- // for details:
- // https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt
- //
- // This field is not used on Windows.
- Propagation mount.Propagation
- }
- // NetworkResource is the body of the "get network" http response message
- type NetworkResource struct {
- Name string // Name is the requested name of the network
- ID string `json:"Id"` // ID uniquely identifies a network on a single machine
- Created time.Time // Created is the time the network created
- Scope string // Scope describes the level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level)
- Driver string // Driver is the Driver name used to create the network (e.g. `bridge`, `overlay`)
- EnableIPv6 bool // EnableIPv6 represents whether to enable IPv6
- IPAM network.IPAM // IPAM is the network's IP Address Management
- Internal bool // Internal represents if the network is used internal only
- Attachable bool // Attachable represents if the global scope is manually attachable by regular containers from workers in swarm mode.
- Ingress bool // Ingress indicates the network is providing the routing-mesh for the swarm cluster.
- ConfigFrom network.ConfigReference // ConfigFrom specifies the source which will provide the configuration for this network.
- ConfigOnly bool // ConfigOnly networks are place-holder networks for network configurations to be used by other networks. ConfigOnly networks cannot be used directly to run containers or services.
- Containers map[string]EndpointResource // Containers contains endpoints belonging to the network
- Options map[string]string // Options holds the network specific options to use for when creating the network
- Labels map[string]string // Labels holds metadata specific to the network being created
- Peers []network.PeerInfo `json:",omitempty"` // List of peer nodes for an overlay network
- Services map[string]network.ServiceInfo `json:",omitempty"`
- }
- // EndpointResource contains network resources allocated and used for a container in a network
- type EndpointResource struct {
- Name string
- EndpointID string
- MacAddress string
- IPv4Address string
- IPv6Address string
- }
- // NetworkCreate is the expected body of the "create network" http request message
- type NetworkCreate struct {
- // Check for networks with duplicate names.
- // Network is primarily keyed based on a random ID and not on the name.
- // Network name is strictly a user-friendly alias to the network
- // which is uniquely identified using ID.
- // And there is no guaranteed way to check for duplicates.
- // Option CheckDuplicate is there to provide a best effort checking of any networks
- // which has the same name but it is not guaranteed to catch all name collisions.
- CheckDuplicate bool
- Driver string
- Scope string
- EnableIPv6 bool
- IPAM *network.IPAM
- Internal bool
- Attachable bool
- Ingress bool
- ConfigOnly bool
- ConfigFrom *network.ConfigReference
- Options map[string]string
- Labels map[string]string
- }
- // NetworkCreateRequest is the request message sent to the server for network create call.
- type NetworkCreateRequest struct {
- NetworkCreate
- Name string
- }
- // NetworkCreateResponse is the response message sent by the server for network create call
- type NetworkCreateResponse struct {
- ID string `json:"Id"`
- Warning string
- }
- // NetworkConnect represents the data to be used to connect a container to the network
- type NetworkConnect struct {
- Container string
- EndpointConfig *network.EndpointSettings `json:",omitempty"`
- }
- // NetworkDisconnect represents the data to be used to disconnect a container from the network
- type NetworkDisconnect struct {
- Container string
- Force bool
- }
- // NetworkInspectOptions holds parameters to inspect network
- type NetworkInspectOptions struct {
- Scope string
- Verbose bool
- }
- // Checkpoint represents the details of a checkpoint
- type Checkpoint struct {
- Name string // Name is the name of the checkpoint
- }
- // Runtime describes an OCI runtime
- type Runtime struct {
- Path string `json:"path"`
- Args []string `json:"runtimeArgs,omitempty"`
- // This is exposed here only for internal use
- // It is not currently supported to specify custom shim configs
- Shim *ShimConfig `json:"-"`
- }
- // ShimConfig is used by runtime to configure containerd shims
- type ShimConfig struct {
- Binary string
- Opts interface{}
- }
- // DiskUsageObject represents an object type used for disk usage query filtering.
- type DiskUsageObject string
- const (
- // ContainerObject represents a container DiskUsageObject.
- ContainerObject DiskUsageObject = "container"
- // ImageObject represents an image DiskUsageObject.
- ImageObject DiskUsageObject = "image"
- // VolumeObject represents a volume DiskUsageObject.
- VolumeObject DiskUsageObject = "volume"
- // BuildCacheObject represents a build-cache DiskUsageObject.
- BuildCacheObject DiskUsageObject = "build-cache"
- )
- // DiskUsageOptions holds parameters for system disk usage query.
- type DiskUsageOptions struct {
- // Types specifies what object types to include in the response. If empty,
- // all object types are returned.
- Types []DiskUsageObject
- }
- // DiskUsage contains response of Engine API:
- // GET "/system/df"
- type DiskUsage struct {
- LayersSize int64
- Images []*ImageSummary
- Containers []*Container
- Volumes []*Volume
- BuildCache []*BuildCache
- BuilderSize int64 `json:",omitempty"` // Deprecated: deprecated in API 1.38, and no longer used since API 1.40.
- }
- // ContainersPruneReport contains the response for Engine API:
- // POST "/containers/prune"
- type ContainersPruneReport struct {
- ContainersDeleted []string
- SpaceReclaimed uint64
- }
- // VolumesPruneReport contains the response for Engine API:
- // POST "/volumes/prune"
- type VolumesPruneReport struct {
- VolumesDeleted []string
- SpaceReclaimed uint64
- }
- // ImagesPruneReport contains the response for Engine API:
- // POST "/images/prune"
- type ImagesPruneReport struct {
- ImagesDeleted []ImageDeleteResponseItem
- SpaceReclaimed uint64
- }
- // BuildCachePruneReport contains the response for Engine API:
- // POST "/build/prune"
- type BuildCachePruneReport struct {
- CachesDeleted []string
- SpaceReclaimed uint64
- }
- // NetworksPruneReport contains the response for Engine API:
- // POST "/networks/prune"
- type NetworksPruneReport struct {
- NetworksDeleted []string
- }
- // SecretCreateResponse contains the information returned to a client
- // on the creation of a new secret.
- type SecretCreateResponse struct {
- // ID is the id of the created secret.
- ID string
- }
- // SecretListOptions holds parameters to list secrets
- type SecretListOptions struct {
- Filters filters.Args
- }
- // ConfigCreateResponse contains the information returned to a client
- // on the creation of a new config.
- type ConfigCreateResponse struct {
- // ID is the id of the created config.
- ID string
- }
- // ConfigListOptions holds parameters to list configs
- type ConfigListOptions struct {
- Filters filters.Args
- }
- // PushResult contains the tag, manifest digest, and manifest size from the
- // push. It's used to signal this information to the trust code in the client
- // so it can sign the manifest if necessary.
- type PushResult struct {
- Tag string
- Digest string
- Size int
- }
- // BuildResult contains the image id of a successful build
- type BuildResult struct {
- ID string
- }
- // BuildCache contains information about a build cache record
- type BuildCache struct {
- ID string
- Parent string
- Type string
- Description string
- InUse bool
- Shared bool
- Size int64
- CreatedAt time.Time
- LastUsedAt *time.Time
- UsageCount int
- }
- // BuildCachePruneOptions hold parameters to prune the build cache
- type BuildCachePruneOptions struct {
- All bool
- KeepStorage int64
- Filters filters.Args
- }
|