types

package
v27.0.3+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RegistryAuthFromSpec         = "spec"
	RegistryAuthFromPreviousSpec = "previous-spec"
)

Values for RegistryAuthFrom in ServiceUpdateOptions

View Source 
const (
	// MediaTypeRawStream is vendor specific MIME-Type set for raw TTY streams
	MediaTypeRawStream = "application/vnd.docker.raw-stream"

	// MediaTypeMultiplexedStream is vendor specific MIME-Type set for stdin/stdout/stderr multiplexed streams
	MediaTypeMultiplexedStream = "application/vnd.docker.multiplexed-stream"
)
View Source 
const (
	NoHealthcheck = container.NoHealthcheck // Deprecated: use [container.NoHealthcheck].
	Starting      = container.Starting      // Deprecated: use [container.Starting].
	Healthy       = container.Healthy       // Deprecated: use [container.Healthy].
	Unhealthy     = container.Unhealthy     // Deprecated: use [container.Unhealthy].
)

Health states

Variables

This section is empty.

Functions

This section is empty.

Types

type BuildCache 

type BuildCache struct {
	// ID is the unique ID of the build cache record.
	ID string
	// Parent is the ID of the parent build cache record.
	//
	// Deprecated: deprecated in API v1.42 and up, as it was deprecated in BuildKit; use Parents instead.
	Parent string `json:"Parent,omitempty"`
	// Parents is the list of parent build cache record IDs.
	Parents []string `json:" Parents,omitempty"`
	// Type is the cache record type.
	Type string
	// Description is a description of the build-step that produced the build cache.
	Description string
	// InUse indicates if the build cache is in use.
	InUse bool
	// Shared indicates if the build cache is shared.
	Shared bool
	// Size is the amount of disk space used by the build cache (in bytes).
	Size int64
	// CreatedAt is the date and time at which the build cache was created.
	CreatedAt time.Time
	// LastUsedAt is the date and time at which the build cache was last used.
	LastUsedAt *time.Time
	UsageCount int
}

BuildCache contains information about a build cache record.

type BuildCachePruneOptions 

type BuildCachePruneOptions struct {
	All         bool
	KeepStorage int64
	Filters     filters.Args
}

BuildCachePruneOptions hold parameters to prune the build cache

type BuildCachePruneReport 

type BuildCachePruneReport struct {
	CachesDeleted  []string
	SpaceReclaimed uint64
}

BuildCachePruneReport contains the response for Engine API: POST "/build/prune"

type BuildResult 

type BuildResult struct {
	ID string
}

BuildResult contains the image id of a successful build

type BuilderVersion 

type BuilderVersion string

BuilderVersion sets the version of underlying builder to use 

const (
	// BuilderV1 is the first generation builder in docker daemon
	BuilderV1 BuilderVersion = "1"
	// BuilderBuildKit is builder based on moby/buildkit project
	BuilderBuildKit BuilderVersion = "2"
)

type CloseWriter 

type CloseWriter interface {
	CloseWrite() error
}

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

type ComponentVersion 

type ComponentVersion struct {
	Name    string
	Version string
	Details map[string]string `json:",omitempty"`
}

ComponentVersion describes the version information for a specific component.

type ConfigCreateResponse 

type ConfigCreateResponse struct {
	// ID is the id of the created config.
	ID string
}

ConfigCreateResponse contains the information returned to a client on the creation of a new config.

type ConfigListOptions 

type ConfigListOptions struct {
	Filters filters.Args
}

ConfigListOptions holds parameters to list configs

type Container deprecated 

type Container = container.Summary

Container contains response of Engine API: GET "/containers/json"

Deprecated: use container.Summary.

type ContainerJSON deprecated 

type ContainerJSON = container.InspectResponse

ContainerJSON is the response for the GET "/containers/{name:.*}/json" endpoint.

Deprecated: use container.InspectResponse. It will be removed in the next release.

type ContainerJSONBase deprecated 

type ContainerJSONBase = container.ContainerJSONBase

ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json" for API version 1.18 and older.

Deprecated: use container.InspectResponse or container.ContainerJSONBase. It will be removed in the next release.

type ContainerState deprecated 

type ContainerState = container.State

ContainerState stores container's running state

Deprecated: use container.State.

type DefaultNetworkSettings deprecated 

type DefaultNetworkSettings = container.DefaultNetworkSettings

DefaultNetworkSettings holds network information during the 2 release deprecation period. It will be removed in Docker 1.11.

Deprecated: use container.DefaultNetworkSettings.

type DiskUsage 

type DiskUsage struct {
	LayersSize  int64
	Images      []*image.Summary
	Containers  []*container.Summary
	Volumes     []*volume.Volume
	BuildCache  []*BuildCache
	BuilderSize int64 `json:",omitempty"` // Deprecated: deprecated in API 1.38, and no longer used since API 1.40.
}

DiskUsage contains response of Engine API: GET "/system/df"

type DiskUsageObject 

type DiskUsageObject string

DiskUsageObject represents an object type used for disk usage query filtering. 

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"
)

type DiskUsageOptions 

type DiskUsageOptions struct {
	// Types specifies what object types to include in the response. If empty,
	// all object types are returned.
	Types []DiskUsageObject
}

DiskUsageOptions holds parameters for system disk usage query.

type ErrorResponse 

type ErrorResponse struct {

	// The error message.
	// Required: true
	Message string `json:"message"`
}

ErrorResponse Represents an error. swagger:model ErrorResponse

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error returns the error message

type GraphDriverData deprecated 

type GraphDriverData = storage.DriverData

GraphDriverData Information about the storage driver used to store the container's and image's filesystem.

Deprecated: use storage.DriverData.

type Health deprecated 

type Health = container.Health

Health stores information about the container's healthcheck results.

Deprecated: use container.Health.

type HealthcheckResult deprecated 

type HealthcheckResult = container.HealthcheckResult

HealthcheckResult stores information about a single run of a healthcheck probe.

Deprecated: use container.HealthcheckResult.

type HijackedResponse 

type HijackedResponse struct {
	Conn   net.Conn
	Reader *bufio.Reader
	// contains filtered or unexported fields
}

HijackedResponse holds connection information for a hijacked request.

func NewHijackedResponse 

func NewHijackedResponse(conn net.Conn, mediaType string) HijackedResponse

NewHijackedResponse intializes a HijackedResponse type

func (*HijackedResponse) Close 

func (h *HijackedResponse) Close()

Close closes the hijacked connection and reader.

func (*HijackedResponse) CloseWrite 

func (h *HijackedResponse) CloseWrite() error

CloseWrite closes a readWriter for writing.

func (*HijackedResponse) MediaType 

func (h *HijackedResponse) MediaType() (string, bool)

MediaType let client know if HijackedResponse hold a raw or multiplexed stream. returns false if HTTP Content-Type is not relevant, and container must be inspected

type IDResponse 

type IDResponse struct {

	// The id of the newly created object.
	// Required: true
	ID string `json:"Id"`
}

IDResponse Response to an API call that returns just an Id swagger:model IdResponse

type ImageBuildOptions 

type ImageBuildOptions struct {
	Tags           []string
	SuppressOutput bool
	RemoteContext  string
	NoCache        bool
	Remove         bool
	ForceRemove    bool
	PullParent     bool
	Isolation      container.Isolation
	CPUSetCPUs     string
	CPUSetMems     string
	CPUShares      int64
	CPUQuota       int64
	CPUPeriod      int64
	Memory         int64
	MemorySwap     int64
	CgroupParent   string
	NetworkMode    string
	ShmSize        int64
	Dockerfile     string
	Ulimits        []*container.Ulimit
	// BuildArgs needs to be a *string instead of just a string so that
	// we can tell the difference between "" (empty string) and no value
	// at all (nil). See the parsing of buildArgs in
	// api/server/router/build/build_routes.go for even more info.
	BuildArgs   map[string]*string
	AuthConfigs map[string]registry.AuthConfig
	Context     io.Reader
	Labels      map[string]string
	// squash the resulting image's layers to the parent
	// preserves the original image and creates a new one from the parent with all
	// the changes applied to a single layer
	Squash bool
	// CacheFrom specifies images that are used for matching cache. Images
	// specified here do not need to have a valid parent chain to match cache.
	CacheFrom   []string
	SecurityOpt []string
	ExtraHosts  []string // List of extra hosts
	Target      string
	SessionID   string
	Platform    string
	// Version specifies the version of the underlying builder to use
	Version BuilderVersion
	// BuildID is an optional identifier that can be passed together with the
	// build request. The same identifier can be used to gracefully cancel the
	// build with the cancel request.
	BuildID string
	// Outputs defines configurations for exporting build results. Only supported
	// in BuildKit mode
	Outputs []ImageBuildOutput
}

ImageBuildOptions holds the information necessary to build images.

type ImageBuildOutput 

type ImageBuildOutput struct {
	Type  string
	Attrs map[string]string
}

ImageBuildOutput defines configuration for exporting a build result

type ImageBuildResponse 

type ImageBuildResponse struct {
	Body   io.ReadCloser
	OSType string
}

ImageBuildResponse holds information returned by a server after building an image.

type ImageInspect deprecated 

type ImageInspect = image.InspectResponse

ImageInspect contains response of Engine API: GET "/images/{name:.*}/json"

Deprecated: use image.InspectResponse.

type MountPoint deprecated 

type MountPoint = container.MountPoint

MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.

Deprecated: use container.MountPoint.

type NetworkSettings deprecated 

type NetworkSettings = container.NetworkSettings

NetworkSettings exposes the network settings in the api.

Deprecated: use container.NetworkSettings.

type NetworkSettingsBase deprecated 

type NetworkSettingsBase = container.NetworkSettingsBase

NetworkSettingsBase holds networking state for a container when inspecting it.

Deprecated: use container.NetworkSettingsBase.

type NodeListOptions 

type NodeListOptions struct {
	Filters filters.Args
}

NodeListOptions holds parameters to list nodes with.

type NodeRemoveOptions 

type NodeRemoveOptions struct {
	Force bool
}

NodeRemoveOptions holds parameters to remove nodes with.

type 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
}

Ping contains response of Engine API: GET "/_ping"

type Plugin 

type Plugin struct {

	// config
	// Required: true
	Config PluginConfig `json:"Config"`

	// True if the plugin is running. False if the plugin is not running, only installed.
	// Required: true
	Enabled bool `json:"Enabled"`

	// Id
	ID string `json:"Id,omitempty"`

	// name
	// Required: true
	Name string `json:"Name"`

	// plugin remote reference used to push/pull the plugin
	PluginReference string `json:"PluginReference,omitempty"`

	// settings
	// Required: true
	Settings PluginSettings `json:"Settings"`
}

Plugin A plugin for the Engine API swagger:model Plugin

type PluginConfig 

type PluginConfig struct {

	// args
	// Required: true
	Args PluginConfigArgs `json:"Args"`

	// description
	// Required: true
	Description string `json:"Description"`

	// Docker Version used to create the plugin
	DockerVersion string `json:"DockerVersion,omitempty"`

	// documentation
	// Required: true
	Documentation string `json:"Documentation"`

	// entrypoint
	// Required: true
	Entrypoint []string `json:"Entrypoint"`

	// env
	// Required: true
	Env []PluginEnv `json:"Env"`

	// interface
	// Required: true
	Interface PluginConfigInterface `json:"Interface"`

	// ipc host
	// Required: true
	IpcHost bool `json:"IpcHost"`

	// linux
	// Required: true
	Linux PluginConfigLinux `json:"Linux"`

	// mounts
	// Required: true
	Mounts []PluginMount `json:"Mounts"`

	// network
	// Required: true
	Network PluginConfigNetwork `json:"Network"`

	// pid host
	// Required: true
	PidHost bool `json:"PidHost"`

	// propagated mount
	// Required: true
	PropagatedMount string `json:"PropagatedMount"`

	// user
	User PluginConfigUser `json:"User,omitempty"`

	// work dir
	// Required: true
	WorkDir string `json:"WorkDir"`

	// rootfs
	Rootfs *PluginConfigRootfs `json:"rootfs,omitempty"`
}

PluginConfig The config of a plugin. swagger:model PluginConfig

type PluginConfigArgs 

type PluginConfigArgs struct {

	// description
	// Required: true
	Description string `json:"Description"`

	// name
	// Required: true
	Name string `json:"Name"`

	// settable
	// Required: true
	Settable []string `json:"Settable"`

	// value
	// Required: true
	Value []string `json:"Value"`
}

PluginConfigArgs plugin config args swagger:model PluginConfigArgs

type PluginConfigInterface 

type PluginConfigInterface struct {

	// Protocol to use for clients connecting to the plugin.
	ProtocolScheme string `json:"ProtocolScheme,omitempty"`

	// socket
	// Required: true
	Socket string `json:"Socket"`

	// types
	// Required: true
	Types []PluginInterfaceType `json:"Types"`
}

PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface

type PluginConfigLinux 

type PluginConfigLinux struct {

	// allow all devices
	// Required: true
	AllowAllDevices bool `json:"AllowAllDevices"`

	// capabilities
	// Required: true
	Capabilities []string `json:"Capabilities"`

	// devices
	// Required: true
	Devices []PluginDevice `json:"Devices"`
}

PluginConfigLinux plugin config linux swagger:model PluginConfigLinux

type PluginConfigNetwork 

type PluginConfigNetwork struct {

	// type
	// Required: true
	Type string `json:"Type"`
}

PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork

type PluginConfigRootfs 

type PluginConfigRootfs struct {

	// diff ids
	DiffIds []string `json:"diff_ids"`

	// type
	Type string `json:"type,omitempty"`
}

PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs

type PluginConfigUser 

type PluginConfigUser struct {

	// g ID
	GID uint32 `json:"GID,omitempty"`

	// UID
	UID uint32 `json:"UID,omitempty"`
}

PluginConfigUser plugin config user swagger:model PluginConfigUser

type PluginCreateOptions 

type PluginCreateOptions struct {
	RepoName string
}

PluginCreateOptions hold all options to plugin create.

type PluginDevice 

type PluginDevice struct {

	// description
	// Required: true
	Description string `json:"Description"`

	// name
	// Required: true
	Name string `json:"Name"`

	// path
	// Required: true
	Path *string `json:"Path"`

	// settable
	// Required: true
	Settable []string `json:"Settable"`
}

PluginDevice plugin device swagger:model PluginDevice

type PluginDisableOptions 

type PluginDisableOptions struct {
	Force bool
}

PluginDisableOptions holds parameters to disable plugins.

type PluginEnableOptions 

type PluginEnableOptions struct {
	Timeout int
}

PluginEnableOptions holds parameters to enable plugins.

type PluginEnv 

type PluginEnv struct {

	// description
	// Required: true
	Description string `json:"Description"`

	// name
	// Required: true
	Name string `json:"Name"`

	// settable
	// Required: true
	Settable []string `json:"Settable"`

	// value
	// Required: true
	Value *string `json:"Value"`
}

PluginEnv plugin env swagger:model PluginEnv

type PluginInstallOptions 

type PluginInstallOptions struct {
	Disabled              bool
	AcceptAllPermissions  bool
	RegistryAuth          string // RegistryAuth is the base64 encoded credentials for the registry
	RemoteRef             string // RemoteRef is the plugin name on the registry
	PrivilegeFunc         RequestPrivilegeFunc
	AcceptPermissionsFunc func(context.Context, PluginPrivileges) (bool, error)
	Args                  []string
}

PluginInstallOptions holds parameters to install a plugin.

type PluginInterfaceType 

type PluginInterfaceType struct {

	// capability
	// Required: true
	Capability string `json:"Capability"`

	// prefix
	// Required: true
	Prefix string `json:"Prefix"`

	// version
	// Required: true
	Version string `json:"Version"`
}

PluginInterfaceType plugin interface type swagger:model PluginInterfaceType

func (*PluginInterfaceType) MarshalJSON 

func (t *PluginInterfaceType) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler for PluginInterfaceType

func (PluginInterfaceType) String 

func (t PluginInterfaceType) String() string

String implements fmt.Stringer for PluginInterfaceType

func (*PluginInterfaceType) UnmarshalJSON 

func (t *PluginInterfaceType) UnmarshalJSON(p []byte) error

UnmarshalJSON implements json.Unmarshaler for PluginInterfaceType

type PluginMount 

type PluginMount struct {

	// description
	// Required: true
	Description string `json:"Description"`

	// destination
	// Required: true
	Destination string `json:"Destination"`

	// name
	// Required: true
	Name string `json:"Name"`

	// options
	// Required: true
	Options []string `json:"Options"`

	// settable
	// Required: true
	Settable []string `json:"Settable"`

	// source
	// Required: true
	Source *string `json:"Source"`

	// type
	// Required: true
	Type string `json:"Type"`
}

PluginMount plugin mount swagger:model PluginMount

type PluginPrivilege 

type PluginPrivilege struct {
	Name        string
	Description string
	Value       []string
}

PluginPrivilege describes a permission the user has to accept upon installing a plugin.

type PluginPrivileges 

type PluginPrivileges []PluginPrivilege

PluginPrivileges is a list of PluginPrivilege

func (PluginPrivileges) Len 

func (s PluginPrivileges) Len() int

func (PluginPrivileges) Less 

func (s PluginPrivileges) Less(i, j int) bool

func (PluginPrivileges) Swap 

func (s PluginPrivileges) Swap(i, j int)

type PluginRemoveOptions 

type PluginRemoveOptions struct {
	Force bool
}

PluginRemoveOptions holds parameters to remove plugins.

type PluginSettings 

type PluginSettings struct {

	// args
	// Required: true
	Args []string `json:"Args"`

	// devices
	// Required: true
	Devices []PluginDevice `json:"Devices"`

	// env
	// Required: true
	Env []string `json:"Env"`

	// mounts
	// Required: true
	Mounts []PluginMount `json:"Mounts"`
}

PluginSettings Settings that can be modified by users. swagger:model PluginSettings

type PluginsListResponse 

type PluginsListResponse []*Plugin

PluginsListResponse contains the response for the Engine API

type Port deprecated 

type Port = container.Port

Port An open port on a container

Deprecated: use container.Port.

type PushResult 

type PushResult struct {
	Tag    string
	Digest string
	Size   int
}

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 RequestPrivilegeFunc 

type RequestPrivilegeFunc func(context.Context) (string, error)

RequestPrivilegeFunc is a function interface that clients can supply to retry operations after getting an authorization error. This function returns the registry authentication header value in base 64 format, or an error if the privilege request fails.

type RootFS deprecated 

type RootFS = image.RootFS

RootFS returns Image's RootFS description including the layer IDs.

Deprecated: use image.RootFS.

type SecretCreateResponse 

type SecretCreateResponse struct {
	// ID is the id of the created secret.
	ID string
}

SecretCreateResponse contains the information returned to a client on the creation of a new secret.

type SecretListOptions 

type SecretListOptions struct {
	Filters filters.Args
}

SecretListOptions holds parameters to list secrets

type ServiceCreateOptions 

type ServiceCreateOptions struct {
	// EncodedRegistryAuth is the encoded registry authorization credentials to
	// use when updating the service.
	//
	// This field follows the format of the X-Registry-Auth header.
	EncodedRegistryAuth string

	// QueryRegistry indicates whether the service update requires
	// contacting a registry. A registry may be contacted to retrieve
	// the image digest and manifest, which in turn can be used to update
	// platform or other information about the service.
	QueryRegistry bool
}

ServiceCreateOptions contains the options to use when creating a service.

type ServiceInspectOptions 

type ServiceInspectOptions struct {
	InsertDefaults bool
}

ServiceInspectOptions holds parameters related to the "service inspect" operation.

type ServiceListOptions 

type ServiceListOptions struct {
	Filters filters.Args

	// Status indicates whether the server should include the service task
	// count of running and desired tasks.
	Status bool
}

ServiceListOptions holds parameters to list services with.

type ServiceUpdateOptions 

type ServiceUpdateOptions struct {
	// EncodedRegistryAuth is the encoded registry authorization credentials to
	// use when updating the service.
	//
	// This field follows the format of the X-Registry-Auth header.
	EncodedRegistryAuth string

	// RegistryAuthFrom specifies where to find the registry authorization
	// credentials if they are not given in EncodedRegistryAuth. Valid
	// values are "spec" and "previous-spec".
	RegistryAuthFrom string

	// Rollback indicates whether a server-side rollback should be
	// performed. When this is set, the provided spec will be ignored.
	// The valid values are "previous" and "none". An empty value is the
	// same as "none".
	Rollback string

	// QueryRegistry indicates whether the service update requires
	// contacting a registry. A registry may be contacted to retrieve
	// the image digest and manifest, which in turn can be used to update
	// platform or other information about the service.
	QueryRegistry bool
}

ServiceUpdateOptions contains the options to be used for updating services.

type SummaryNetworkSettings deprecated 

type SummaryNetworkSettings = container.NetworkSettingsSummary

SummaryNetworkSettings provides a summary of container's networks in /containers/json.

Deprecated: use container.NetworkSettingsSummary.

type SwarmUnlockKeyResponse 

type SwarmUnlockKeyResponse struct {
	// UnlockKey is the unlock key in ASCII-armored format.
	UnlockKey string
}

SwarmUnlockKeyResponse contains the response for Engine API: GET /swarm/unlockkey

type TaskListOptions 

type TaskListOptions struct {
	Filters filters.Args
}

TaskListOptions holds parameters to list tasks with.

type Version 

type Version struct {
	Platform   struct{ Name string } `json:",omitempty"`
	Components []ComponentVersion    `json:",omitempty"`

	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"`
}

Version contains response of Engine API: GET "/version"

Source Files

View all Source files

Directories

Path Synopsis
Package backend includes types to send information to server backends.
 Package backend includes types to send information to server backends.
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
 Package filters provides tools for encoding a mapping of keys to a set of multiple values.
plugins
logdriver
runtime

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.