interface.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. package client
  2. import (
  3. "io"
  4. "net"
  5. "time"
  6. "github.com/docker/docker/api/types"
  7. "github.com/docker/docker/api/types/container"
  8. "github.com/docker/docker/api/types/events"
  9. "github.com/docker/docker/api/types/filters"
  10. "github.com/docker/docker/api/types/image"
  11. "github.com/docker/docker/api/types/network"
  12. "github.com/docker/docker/api/types/registry"
  13. "github.com/docker/docker/api/types/swarm"
  14. volumetypes "github.com/docker/docker/api/types/volume"
  15. "golang.org/x/net/context"
  16. )
  17. // CommonAPIClient is the common methods between stable and experimental versions of APIClient.
  18. type CommonAPIClient interface {
  19. ConfigAPIClient
  20. ContainerAPIClient
  21. DistributionAPIClient
  22. ImageAPIClient
  23. NodeAPIClient
  24. NetworkAPIClient
  25. PluginAPIClient
  26. ServiceAPIClient
  27. SwarmAPIClient
  28. SecretAPIClient
  29. SystemAPIClient
  30. VolumeAPIClient
  31. ClientVersion() string
  32. DaemonHost() string
  33. ServerVersion(ctx context.Context) (types.Version, error)
  34. NegotiateAPIVersion(ctx context.Context)
  35. NegotiateAPIVersionPing(types.Ping)
  36. DialSession(ctx context.Context, proto string, meta map[string][]string) (net.Conn, error)
  37. }
  38. // ContainerAPIClient defines API client methods for the containers
  39. type ContainerAPIClient interface {
  40. ContainerAttach(ctx context.Context, container string, options types.ContainerAttachOptions) (types.HijackedResponse, error)
  41. ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.IDResponse, error)
  42. ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, containerName string) (container.ContainerCreateCreatedBody, error)
  43. ContainerDiff(ctx context.Context, container string) ([]container.ContainerChangeResponseItem, error)
  44. ContainerExecAttach(ctx context.Context, execID string, config types.ExecConfig) (types.HijackedResponse, error)
  45. ContainerExecCreate(ctx context.Context, container string, config types.ExecConfig) (types.IDResponse, error)
  46. ContainerExecInspect(ctx context.Context, execID string) (types.ContainerExecInspect, error)
  47. ContainerExecResize(ctx context.Context, execID string, options types.ResizeOptions) error
  48. ContainerExecStart(ctx context.Context, execID string, config types.ExecStartCheck) error
  49. ContainerExport(ctx context.Context, container string) (io.ReadCloser, error)
  50. ContainerInspect(ctx context.Context, container string) (types.ContainerJSON, error)
  51. ContainerInspectWithRaw(ctx context.Context, container string, getSize bool) (types.ContainerJSON, []byte, error)
  52. ContainerKill(ctx context.Context, container, signal string) error
  53. ContainerList(ctx context.Context, options types.ContainerListOptions) ([]types.Container, error)
  54. ContainerLogs(ctx context.Context, container string, options types.ContainerLogsOptions) (io.ReadCloser, error)
  55. ContainerPause(ctx context.Context, container string) error
  56. ContainerRemove(ctx context.Context, container string, options types.ContainerRemoveOptions) error
  57. ContainerRename(ctx context.Context, container, newContainerName string) error
  58. ContainerResize(ctx context.Context, container string, options types.ResizeOptions) error
  59. ContainerRestart(ctx context.Context, container string, timeout *time.Duration) error
  60. ContainerStatPath(ctx context.Context, container, path string) (types.ContainerPathStat, error)
  61. ContainerStats(ctx context.Context, container string, stream bool) (types.ContainerStats, error)
  62. ContainerStart(ctx context.Context, container string, options types.ContainerStartOptions) error
  63. ContainerStop(ctx context.Context, container string, timeout *time.Duration) error
  64. ContainerTop(ctx context.Context, container string, arguments []string) (container.ContainerTopOKBody, error)
  65. ContainerUnpause(ctx context.Context, container string) error
  66. ContainerUpdate(ctx context.Context, container string, updateConfig container.UpdateConfig) (container.ContainerUpdateOKBody, error)
  67. ContainerWait(ctx context.Context, container string, condition container.WaitCondition) (<-chan container.ContainerWaitOKBody, <-chan error)
  68. CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)
  69. CopyToContainer(ctx context.Context, container, path string, content io.Reader, options types.CopyToContainerOptions) error
  70. ContainersPrune(ctx context.Context, pruneFilters filters.Args) (types.ContainersPruneReport, error)
  71. }
  72. // DistributionAPIClient defines API client methods for the registry
  73. type DistributionAPIClient interface {
  74. DistributionInspect(ctx context.Context, image, encodedRegistryAuth string) (registry.DistributionInspect, error)
  75. }
  76. // ImageAPIClient defines API client methods for the images
  77. type ImageAPIClient interface {
  78. ImageBuild(ctx context.Context, context io.Reader, options types.ImageBuildOptions) (types.ImageBuildResponse, error)
  79. BuildCachePrune(ctx context.Context) (*types.BuildCachePruneReport, error)
  80. ImageCreate(ctx context.Context, parentReference string, options types.ImageCreateOptions) (io.ReadCloser, error)
  81. ImageHistory(ctx context.Context, image string) ([]image.HistoryResponseItem, error)
  82. ImageImport(ctx context.Context, source types.ImageImportSource, ref string, options types.ImageImportOptions) (io.ReadCloser, error)
  83. ImageInspectWithRaw(ctx context.Context, image string) (types.ImageInspect, []byte, error)
  84. ImageList(ctx context.Context, options types.ImageListOptions) ([]types.ImageSummary, error)
  85. ImageLoad(ctx context.Context, input io.Reader, quiet bool) (types.ImageLoadResponse, error)
  86. ImagePull(ctx context.Context, ref string, options types.ImagePullOptions) (io.ReadCloser, error)
  87. ImagePush(ctx context.Context, ref string, options types.ImagePushOptions) (io.ReadCloser, error)
  88. ImageRemove(ctx context.Context, image string, options types.ImageRemoveOptions) ([]types.ImageDeleteResponseItem, error)
  89. ImageSearch(ctx context.Context, term string, options types.ImageSearchOptions) ([]registry.SearchResult, error)
  90. ImageSave(ctx context.Context, images []string) (io.ReadCloser, error)
  91. ImageTag(ctx context.Context, image, ref string) error
  92. ImagesPrune(ctx context.Context, pruneFilter filters.Args) (types.ImagesPruneReport, error)
  93. }
  94. // NetworkAPIClient defines API client methods for the networks
  95. type NetworkAPIClient interface {
  96. NetworkConnect(ctx context.Context, networkID, container string, config *network.EndpointSettings) error
  97. NetworkCreate(ctx context.Context, name string, options types.NetworkCreate) (types.NetworkCreateResponse, error)
  98. NetworkDisconnect(ctx context.Context, networkID, container string, force bool) error
  99. NetworkInspect(ctx context.Context, networkID string, options types.NetworkInspectOptions) (types.NetworkResource, error)
  100. NetworkInspectWithRaw(ctx context.Context, networkID string, options types.NetworkInspectOptions) (types.NetworkResource, []byte, error)
  101. NetworkList(ctx context.Context, options types.NetworkListOptions) ([]types.NetworkResource, error)
  102. NetworkRemove(ctx context.Context, networkID string) error
  103. NetworksPrune(ctx context.Context, pruneFilter filters.Args) (types.NetworksPruneReport, error)
  104. }
  105. // NodeAPIClient defines API client methods for the nodes
  106. type NodeAPIClient interface {
  107. NodeInspectWithRaw(ctx context.Context, nodeID string) (swarm.Node, []byte, error)
  108. NodeList(ctx context.Context, options types.NodeListOptions) ([]swarm.Node, error)
  109. NodeRemove(ctx context.Context, nodeID string, options types.NodeRemoveOptions) error
  110. NodeUpdate(ctx context.Context, nodeID string, version swarm.Version, node swarm.NodeSpec) error
  111. }
  112. // PluginAPIClient defines API client methods for the plugins
  113. type PluginAPIClient interface {
  114. PluginList(ctx context.Context, filter filters.Args) (types.PluginsListResponse, error)
  115. PluginRemove(ctx context.Context, name string, options types.PluginRemoveOptions) error
  116. PluginEnable(ctx context.Context, name string, options types.PluginEnableOptions) error
  117. PluginDisable(ctx context.Context, name string, options types.PluginDisableOptions) error
  118. PluginInstall(ctx context.Context, name string, options types.PluginInstallOptions) (io.ReadCloser, error)
  119. PluginUpgrade(ctx context.Context, name string, options types.PluginInstallOptions) (io.ReadCloser, error)
  120. PluginPush(ctx context.Context, name string, registryAuth string) (io.ReadCloser, error)
  121. PluginSet(ctx context.Context, name string, args []string) error
  122. PluginInspectWithRaw(ctx context.Context, name string) (*types.Plugin, []byte, error)
  123. PluginCreate(ctx context.Context, createContext io.Reader, options types.PluginCreateOptions) error
  124. }
  125. // ServiceAPIClient defines API client methods for the services
  126. type ServiceAPIClient interface {
  127. ServiceCreate(ctx context.Context, service swarm.ServiceSpec, options types.ServiceCreateOptions) (types.ServiceCreateResponse, error)
  128. ServiceInspectWithRaw(ctx context.Context, serviceID string, options types.ServiceInspectOptions) (swarm.Service, []byte, error)
  129. ServiceList(ctx context.Context, options types.ServiceListOptions) ([]swarm.Service, error)
  130. ServiceRemove(ctx context.Context, serviceID string) error
  131. ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (types.ServiceUpdateResponse, error)
  132. ServiceLogs(ctx context.Context, serviceID string, options types.ContainerLogsOptions) (io.ReadCloser, error)
  133. TaskLogs(ctx context.Context, taskID string, options types.ContainerLogsOptions) (io.ReadCloser, error)
  134. TaskInspectWithRaw(ctx context.Context, taskID string) (swarm.Task, []byte, error)
  135. TaskList(ctx context.Context, options types.TaskListOptions) ([]swarm.Task, error)
  136. }
  137. // SwarmAPIClient defines API client methods for the swarm
  138. type SwarmAPIClient interface {
  139. SwarmInit(ctx context.Context, req swarm.InitRequest) (string, error)
  140. SwarmJoin(ctx context.Context, req swarm.JoinRequest) error
  141. SwarmGetUnlockKey(ctx context.Context) (types.SwarmUnlockKeyResponse, error)
  142. SwarmUnlock(ctx context.Context, req swarm.UnlockRequest) error
  143. SwarmLeave(ctx context.Context, force bool) error
  144. SwarmInspect(ctx context.Context) (swarm.Swarm, error)
  145. SwarmUpdate(ctx context.Context, version swarm.Version, swarm swarm.Spec, flags swarm.UpdateFlags) error
  146. }
  147. // SystemAPIClient defines API client methods for the system
  148. type SystemAPIClient interface {
  149. Events(ctx context.Context, options types.EventsOptions) (<-chan events.Message, <-chan error)
  150. Info(ctx context.Context) (types.Info, error)
  151. RegistryLogin(ctx context.Context, auth types.AuthConfig) (registry.AuthenticateOKBody, error)
  152. DiskUsage(ctx context.Context) (types.DiskUsage, error)
  153. Ping(ctx context.Context) (types.Ping, error)
  154. }
  155. // VolumeAPIClient defines API client methods for the volumes
  156. type VolumeAPIClient interface {
  157. VolumeCreate(ctx context.Context, options volumetypes.VolumesCreateBody) (types.Volume, error)
  158. VolumeInspect(ctx context.Context, volumeID string) (types.Volume, error)
  159. VolumeInspectWithRaw(ctx context.Context, volumeID string) (types.Volume, []byte, error)
  160. VolumeList(ctx context.Context, filter filters.Args) (volumetypes.VolumesListOKBody, error)
  161. VolumeRemove(ctx context.Context, volumeID string, force bool) error
  162. VolumesPrune(ctx context.Context, pruneFilter filters.Args) (types.VolumesPruneReport, error)
  163. }
  164. // SecretAPIClient defines API client methods for secrets
  165. type SecretAPIClient interface {
  166. SecretList(ctx context.Context, options types.SecretListOptions) ([]swarm.Secret, error)
  167. SecretCreate(ctx context.Context, secret swarm.SecretSpec) (types.SecretCreateResponse, error)
  168. SecretRemove(ctx context.Context, id string) error
  169. SecretInspectWithRaw(ctx context.Context, name string) (swarm.Secret, []byte, error)
  170. SecretUpdate(ctx context.Context, id string, version swarm.Version, secret swarm.SecretSpec) error
  171. }
  172. // ConfigAPIClient defines API client methods for configs
  173. type ConfigAPIClient interface {
  174. ConfigList(ctx context.Context, options types.ConfigListOptions) ([]swarm.Config, error)
  175. ConfigCreate(ctx context.Context, config swarm.ConfigSpec) (types.ConfigCreateResponse, error)
  176. ConfigRemove(ctx context.Context, id string) error
  177. ConfigInspectWithRaw(ctx context.Context, name string) (swarm.Config, []byte, error)
  178. ConfigUpdate(ctx context.Context, id string, version swarm.Version, config swarm.ConfigSpec) error
  179. }