Documentation
¶
Index ¶
- Variables
- func IsErrContainerNotFound(err error) bool
- func IsErrImageNotFound(err error) bool
- func IsErrNetworkNotFound(err error) bool
- func IsErrUnauthorized(err error) bool
- func IsErrVolumeNotFound(err error) bool
- type Client
- func (cli *Client) ClientVersion() string
- func (cli *Client) ContainerAttach(options types.ContainerAttachOptions) (types.HijackedResponse, error)
- func (cli *Client) ContainerCommit(options types.ContainerCommitOptions) (types.ContainerCommitResponse, error)
- func (cli *Client) ContainerCreate(config *runconfig.ContainerConfigWrapper, containerName string) (types.ContainerCreateResponse, error)
- func (cli *Client) ContainerDiff(containerID string) ([]types.ContainerChange, error)
- func (cli *Client) ContainerExecAttach(execID string, config runconfig.ExecConfig) (types.HijackedResponse, error)
- func (cli *Client) ContainerExecCreate(config runconfig.ExecConfig) (types.ContainerExecCreateResponse, error)
- func (cli *Client) ContainerExecInspect(execID string) (types.ContainerExecInspect, error)
- func (cli *Client) ContainerExecResize(options types.ResizeOptions) error
- func (cli *Client) ContainerExecStart(execID string, config types.ExecStartCheck) error
- func (cli *Client) ContainerExport(containerID string) (io.ReadCloser, error)
- func (cli *Client) ContainerInspect(containerID string) (types.ContainerJSON, error)
- func (cli *Client) ContainerInspectWithRaw(containerID string, getSize bool) (types.ContainerJSON, []byte, error)
- func (cli *Client) ContainerKill(containerID, signal string) error
- func (cli *Client) ContainerList(options types.ContainerListOptions) ([]types.Container, error)
- func (cli *Client) ContainerLogs(options types.ContainerLogsOptions) (io.ReadCloser, error)
- func (cli *Client) ContainerPause(containerID string) error
- func (cli *Client) ContainerRemove(options types.ContainerRemoveOptions) error
- func (cli *Client) ContainerRename(containerID, newContainerName string) error
- func (cli *Client) ContainerResize(options types.ResizeOptions) error
- func (cli *Client) ContainerRestart(containerID string, timeout int) error
- func (cli *Client) ContainerStart(containerID string) error
- func (cli *Client) ContainerStatPath(containerID, path string) (types.ContainerPathStat, error)
- func (cli *Client) ContainerStats(containerID string, stream bool) (io.ReadCloser, error)
- func (cli *Client) ContainerStop(containerID string, timeout int) error
- func (cli *Client) ContainerTop(containerID string, arguments []string) (types.ContainerProcessList, error)
- func (cli *Client) ContainerUnpause(containerID string) error
- func (cli *Client) ContainerWait(containerID string) (int, error)
- func (cli *Client) CopyFromContainer(containerID, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)
- func (cli *Client) CopyToContainer(options types.CopyToContainerOptions) error
- func (cli *Client) Events(options types.EventsOptions) (io.ReadCloser, error)
- func (cli *Client) ImageBuild(options types.ImageBuildOptions) (types.ImageBuildResponse, error)
- func (cli *Client) ImageCreate(options types.ImageCreateOptions) (io.ReadCloser, error)
- func (cli *Client) ImageHistory(imageID string) ([]types.ImageHistory, error)
- func (cli *Client) ImageImport(options types.ImageImportOptions) (io.ReadCloser, error)
- func (cli *Client) ImageInspectWithRaw(imageID string, getSize bool) (types.ImageInspect, []byte, error)
- func (cli *Client) ImageList(options types.ImageListOptions) ([]types.Image, error)
- func (cli *Client) ImageLoad(input io.Reader) (io.ReadCloser, error)
- func (cli *Client) ImagePull(options types.ImagePullOptions, privilegeFunc RequestPrivilegeFunc) (io.ReadCloser, error)
- func (cli *Client) ImagePush(options types.ImagePushOptions, privilegeFunc RequestPrivilegeFunc) (io.ReadCloser, error)
- func (cli *Client) ImageRemove(options types.ImageRemoveOptions) ([]types.ImageDelete, error)
- func (cli *Client) ImageSave(imageIDs []string) (io.ReadCloser, error)
- func (cli *Client) ImageSearch(options types.ImageSearchOptions, privilegeFunc RequestPrivilegeFunc) ([]registry.SearchResult, error)
- func (cli *Client) ImageTag(options types.ImageTagOptions) error
- func (cli *Client) Info() (types.Info, error)
- func (cli *Client) NetworkConnect(networkID, containerID string) error
- func (cli *Client) NetworkCreate(options types.NetworkCreate) (types.NetworkCreateResponse, error)
- func (cli *Client) NetworkDisconnect(networkID, containerID string) error
- func (cli *Client) NetworkInspect(networkID string) (types.NetworkResource, error)
- func (cli *Client) NetworkList() ([]types.NetworkResource, error)
- func (cli *Client) NetworkRemove(networkID string) error
- func (cli *Client) RegistryLogin(auth types.AuthConfig) (types.AuthResponse, error)
- func (cli *Client) ServerVersion() (types.Version, error)
- func (cli *Client) VolumeCreate(options types.VolumeCreateRequest) (types.Volume, error)
- func (cli *Client) VolumeInspect(volumeID string) (types.Volume, error)
- func (cli *Client) VolumeList(filter filters.Args) (types.VolumesListResponse, error)
- func (cli *Client) VolumeRemove(volumeID string) error
- type RequestPrivilegeFunc
Constants ¶
This section is empty.
Variables ¶
var ErrConnectionFailed = errors.New("Cannot connect to the Docker daemon. Is the docker daemon running on this host?")
ErrConnectionFailed is a error raised when the connection between the client and the server failed.
Functions ¶
func IsErrContainerNotFound ¶
IsErrContainerNotFound returns true if the error is caused when a container is not found in the docker host.
func IsErrImageNotFound ¶
IsErrImageNotFound returns true if the error is caused when an image is not found in the docker host.
func IsErrNetworkNotFound ¶
IsErrNetworkNotFound returns true if the error is caused when a network is not found in the docker host.
func IsErrUnauthorized ¶
IsErrUnauthorized returns true if the error is caused when an the remote registry authentication fails
func IsErrVolumeNotFound ¶
IsErrVolumeNotFound returns true if the error is caused when a volume is not found in the docker host.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the API client that performs all operations against a docker server.
func NewClient ¶
func NewClient(host string, version string, transport *http.Transport, httpHeaders map[string]string) (*Client, error)
NewClient initializes a new API client for the given host and API version. It won't send any version information if the version number is empty. It uses the transport to create a new http client. It also initializes the custom http headers to add to each request.
func NewEnvClient ¶
NewEnvClient initializes a new API client based on environment variables. Use DOCKER_HOST to set the url to the docker server. Use DOCKER_API_VERSION to set the version of the API to reach, leave empty for latest. Use DOCKER_CERT_PATH to load the tls certificates from.
func (*Client) ClientVersion ¶
ClientVersion returns the version string associated with this instance of the Client. Note that this value can be changed via the DOCKER_API_VERSION env var.
func (*Client) ContainerAttach ¶
func (cli *Client) ContainerAttach(options types.ContainerAttachOptions) (types.HijackedResponse, error)
ContainerAttach attaches a connection to a container in the server. It returns a types.HijackedConnection with the hijacked connection and the a reader to get output. It's up to the called to close the hijacked connection by calling types.HijackedResponse.Close.
func (*Client) ContainerCommit ¶
func (cli *Client) ContainerCommit(options types.ContainerCommitOptions) (types.ContainerCommitResponse, error)
ContainerCommit applies changes into a container and creates a new tagged image.
func (*Client) ContainerCreate ¶
func (cli *Client) ContainerCreate(config *runconfig.ContainerConfigWrapper, containerName string) (types.ContainerCreateResponse, error)
ContainerCreate creates a new container based in the given configuration. It can be associated with a name, but it's not mandatory.
func (*Client) ContainerDiff ¶
func (cli *Client) ContainerDiff(containerID string) ([]types.ContainerChange, error)
ContainerDiff shows differences in a container filesystem since it was started.
func (*Client) ContainerExecAttach ¶
func (cli *Client) ContainerExecAttach(execID string, config runconfig.ExecConfig) (types.HijackedResponse, error)
ContainerExecAttach attaches a connection to an exec process in the server. It returns a types.HijackedConnection with the hijacked connection and the a reader to get output. It's up to the called to close the hijacked connection by calling types.HijackedResponse.Close.
func (*Client) ContainerExecCreate ¶
func (cli *Client) ContainerExecCreate(config runconfig.ExecConfig) (types.ContainerExecCreateResponse, error)
ContainerExecCreate creates a new exec configuration to run an exec process.
func (*Client) ContainerExecInspect ¶
func (cli *Client) ContainerExecInspect(execID string) (types.ContainerExecInspect, error)
ContainerExecInspect returns information about a specific exec process on the docker host.
func (*Client) ContainerExecResize ¶
func (cli *Client) ContainerExecResize(options types.ResizeOptions) error
ContainerExecResize changes the size of the tty for an exec process running inside a container.
func (*Client) ContainerExecStart ¶
func (cli *Client) ContainerExecStart(execID string, config types.ExecStartCheck) error
ContainerExecStart starts an exec process already create in the docker host.
func (*Client) ContainerExport ¶
func (cli *Client) ContainerExport(containerID string) (io.ReadCloser, error)
ContainerExport retrieves the raw contents of a container and returns them as a io.ReadCloser. It's up to the caller to close the stream.
func (*Client) ContainerInspect ¶
func (cli *Client) ContainerInspect(containerID string) (types.ContainerJSON, error)
ContainerInspect returns the container information.
func (*Client) ContainerInspectWithRaw ¶
func (cli *Client) ContainerInspectWithRaw(containerID string, getSize bool) (types.ContainerJSON, []byte, error)
ContainerInspectWithRaw returns the container information and it's raw representation.
func (*Client) ContainerKill ¶
ContainerKill terminates the container process but does not remove the container from the docker host.
func (*Client) ContainerList ¶
ContainerList returns the list of containers in the docker host.
func (*Client) ContainerLogs ¶
func (cli *Client) ContainerLogs(options types.ContainerLogsOptions) (io.ReadCloser, error)
ContainerLogs returns the logs generated by a container in an io.ReadCloser. It's up to the caller to close the stream.
func (*Client) ContainerPause ¶
ContainerPause pauses the main process of a given container without terminating it.
func (*Client) ContainerRemove ¶
func (cli *Client) ContainerRemove(options types.ContainerRemoveOptions) error
ContainerRemove kills and removes a container from the docker host.
func (*Client) ContainerRename ¶
ContainerRename changes the name of a given container.
func (*Client) ContainerResize ¶
func (cli *Client) ContainerResize(options types.ResizeOptions) error
ContainerResize changes the size of the tty for a container.
func (*Client) ContainerRestart ¶
ContainerRestart stops and starts a container again. It makes the daemon to wait for the container to be up again for a specific amount of time, given the timeout.
func (*Client) ContainerStart ¶
ContainerStart sends a request to the docker daemon to start a container.
func (*Client) ContainerStatPath ¶
func (cli *Client) ContainerStatPath(containerID, path string) (types.ContainerPathStat, error)
ContainerStatPath returns Stat information about a path inside the container filesystem.
func (*Client) ContainerStats ¶
ContainerStats returns near realtime stats for a given container. It's up to the caller to close the io.ReadCloser returned.
func (*Client) ContainerStop ¶
ContainerStop stops a container without terminating the process. The process is blocked until the container stops or the timeout expires.
func (*Client) ContainerTop ¶
func (cli *Client) ContainerTop(containerID string, arguments []string) (types.ContainerProcessList, error)
ContainerTop shows process information from within a container.
func (*Client) ContainerUnpause ¶
ContainerUnpause resumes the process execution within a container
func (*Client) ContainerWait ¶
ContainerWait pauses execution util a container is exits. It returns the API status code as response of its readiness.
func (*Client) CopyFromContainer ¶
func (cli *Client) CopyFromContainer(containerID, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)
CopyFromContainer get the content from the container and return it as a Reader to manipulate it in the host. It's up to the caller to close the reader.
func (*Client) CopyToContainer ¶
func (cli *Client) CopyToContainer(options types.CopyToContainerOptions) error
CopyToContainer copies content into the container filesystem.
func (*Client) Events ¶
func (cli *Client) Events(options types.EventsOptions) (io.ReadCloser, error)
Events returns a stream of events in the daemon in a ReadCloser. It's up to the caller to close the stream.
func (*Client) ImageBuild ¶
func (cli *Client) ImageBuild(options types.ImageBuildOptions) (types.ImageBuildResponse, error)
ImageBuild sends request to the daemon to build images. The Body in the response implement an io.ReadCloser and it's up to the caller to close it.
func (*Client) ImageCreate ¶
func (cli *Client) ImageCreate(options types.ImageCreateOptions) (io.ReadCloser, error)
ImageCreate creates a new image based in the parent options. It returns the JSON content in the response body.
func (*Client) ImageHistory ¶
func (cli *Client) ImageHistory(imageID string) ([]types.ImageHistory, error)
ImageHistory returns the changes in an image in history format.
func (*Client) ImageImport ¶
func (cli *Client) ImageImport(options types.ImageImportOptions) (io.ReadCloser, error)
ImageImport creates a new image based in the source options. It returns the JSON content in the response body.
func (*Client) ImageInspectWithRaw ¶
func (cli *Client) ImageInspectWithRaw(imageID string, getSize bool) (types.ImageInspect, []byte, error)
ImageInspectWithRaw returns the image information and it's raw representation.
func (*Client) ImageLoad ¶
ImageLoad loads an image in the docker host from the client host. It's up to the caller to close the io.ReadCloser returned by this function.
func (*Client) ImagePull ¶
func (cli *Client) ImagePull(options types.ImagePullOptions, privilegeFunc RequestPrivilegeFunc) (io.ReadCloser, error)
ImagePull request the docker host to pull an image from a remote registry. It executes the privileged function if the operation is unauthorized and it tries one more time. It's up to the caller to handle the io.ReadCloser and close it properly.
func (*Client) ImagePush ¶
func (cli *Client) ImagePush(options types.ImagePushOptions, privilegeFunc RequestPrivilegeFunc) (io.ReadCloser, error)
ImagePush request the docker host to push an image to a remote registry. It executes the privileged function if the operation is unauthorized and it tries one more time. It's up to the caller to handle the io.ReadCloser and close it properly.
func (*Client) ImageRemove ¶
func (cli *Client) ImageRemove(options types.ImageRemoveOptions) ([]types.ImageDelete, error)
ImageRemove removes an image from the docker host.
func (*Client) ImageSave ¶
func (cli *Client) ImageSave(imageIDs []string) (io.ReadCloser, error)
ImageSave retrieves one or more images from the docker host as a io.ReadCloser. It's up to the caller to store the images and close the stream.
func (*Client) ImageSearch ¶
func (cli *Client) ImageSearch(options types.ImageSearchOptions, privilegeFunc RequestPrivilegeFunc) ([]registry.SearchResult, error)
ImageSearch makes the docker host to search by a term in a remote registry. The list of results is not sorted in any fashion.
func (*Client) ImageTag ¶
func (cli *Client) ImageTag(options types.ImageTagOptions) error
ImageTag tags an image in the docker host
func (*Client) NetworkConnect ¶
NetworkConnect connects a container to an existent network in the docker host.
func (*Client) NetworkCreate ¶
func (cli *Client) NetworkCreate(options types.NetworkCreate) (types.NetworkCreateResponse, error)
NetworkCreate creates a new network in the docker host.
func (*Client) NetworkDisconnect ¶
NetworkDisconnect disconnects a container from an existent network in the docker host.
func (*Client) NetworkInspect ¶
func (cli *Client) NetworkInspect(networkID string) (types.NetworkResource, error)
NetworkInspect returns the information for a specific network configured in the docker host.
func (*Client) NetworkList ¶
func (cli *Client) NetworkList() ([]types.NetworkResource, error)
NetworkList returns the list of networks configured in the docker host.
func (*Client) NetworkRemove ¶
NetworkRemove removes an existent network from the docker host.
func (*Client) RegistryLogin ¶
func (cli *Client) RegistryLogin(auth types.AuthConfig) (types.AuthResponse, error)
RegistryLogin authenticates the docker server with a given docker registry. It returns UnauthorizerError when the authentication fails.
func (*Client) ServerVersion ¶
ServerVersion returns information of the docker client and server host.
func (*Client) VolumeCreate ¶
VolumeCreate creates a volume in the docker host.
func (*Client) VolumeInspect ¶
VolumeInspect returns the information about a specific volume in the docker host.
func (*Client) VolumeList ¶
VolumeList returns the volumes configured in the docker host.
func (*Client) VolumeRemove ¶
VolumeRemove removes a volume from the docker host.
type RequestPrivilegeFunc ¶
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.
Source Files
¶
- client.go
- container_attach.go
- container_commit.go
- container_create.go
- container_inspect.go
- container_list.go
- container_remove.go
- container_rename.go
- container_restart.go
- container_start.go
- container_stats.go
- container_stop.go
- container_top.go
- container_unpause.go
- copy.go
- diff.go
- errors.go
- events.go
- exec.go
- export.go
- hijack.go
- history.go
- image_build.go
- image_create.go
- image_import.go
- image_inspect.go
- image_list.go
- image_load.go
- image_pull.go
- image_push.go
- image_remove.go
- image_save.go
- image_search.go
- image_tag.go
- info.go
- kill.go
- login.go
- logs.go
- network.go
- pause.go
- privileged.go
- request.go
- resize.go
- version.go
- volume.go
- wait.go