client

package
v0.0.0-...-2812ca0 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2018 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenTLSConfig 

func GenTLSConfig(key, cert, ca string) (*tls.Config, error)

GenTLSConfig returns a tls config object according to inputting parameters.

Types

type APIClient 

type APIClient struct {
	HTTPCli *http.Client
	// contains filtered or unexported fields
}

APIClient is a API client that performs all operations against a pouch server

func (*APIClient) BaseURL 

func (client *APIClient) BaseURL() string

BaseURL returns the base URL of APIClient

func (*APIClient) ContainerAttach 

func (client *APIClient) ContainerAttach(ctx context.Context, name string, stdin bool) (net.Conn, *bufio.Reader, error)

ContainerAttach attach a container

func (*APIClient) ContainerCreate 

func (client *APIClient) ContainerCreate(ctx context.Context, config types.ContainerConfig, hostConfig *types.HostConfig, networkingConfig *types.NetworkingConfig, containerName string) (*types.ContainerCreateResp, error)

ContainerCreate creates a new container based in the given configuration.

func (*APIClient) ContainerCreateExec 

func (client *APIClient) ContainerCreateExec(ctx context.Context, name string, config *types.ExecCreateConfig) (*types.ExecCreateResp, error)

ContainerCreateExec creates exec process.

func (*APIClient) ContainerGet 

func (client *APIClient) ContainerGet(ctx context.Context, name string) (*types.ContainerJSON, error)

ContainerGet returns the detailed information of container.

func (*APIClient) ContainerList 

func (client *APIClient) ContainerList(ctx context.Context, all bool) ([]*types.Container, error)

ContainerList returns the list of containers.

func (*APIClient) ContainerLogs 

func (client *APIClient) ContainerLogs(ctx context.Context, name string, options types.ContainerLogsOptions) (io.ReadCloser, error)

ContainerLogs return the logs generated by a container in an io.ReadCloser.

func (*APIClient) ContainerPause 

func (client *APIClient) ContainerPause(ctx context.Context, name string) error

ContainerPause pauses a container.

func (*APIClient) ContainerRemove 

func (client *APIClient) ContainerRemove(ctx context.Context, name string, force bool) error

ContainerRemove removes a container.

func (*APIClient) ContainerRename 

func (client *APIClient) ContainerRename(ctx context.Context, id string, name string) error

ContainerRename renames a container.

func (*APIClient) ContainerResize 

func (client *APIClient) ContainerResize(ctx context.Context, name, height, width string) error

ContainerResize resizes the size of container tty.

func (*APIClient) ContainerRestart 

func (client *APIClient) ContainerRestart(ctx context.Context, name string, timeout string) error

ContainerRestart restarts a running container.

func (*APIClient) ContainerStart 

func (client *APIClient) ContainerStart(ctx context.Context, name, detachKeys string) error

ContainerStart starts a created container.

func (*APIClient) ContainerStartExec 

func (client *APIClient) ContainerStartExec(ctx context.Context, execid string, config *types.ExecStartConfig) (net.Conn, *bufio.Reader, error)

ContainerStartExec starts exec process.

func (*APIClient) ContainerStop 

func (client *APIClient) ContainerStop(ctx context.Context, name string, timeout string) error

ContainerStop stops a container.

func (*APIClient) ContainerTop 

func (client *APIClient) ContainerTop(ctx context.Context, name string, arguments []string) (types.ContainerProcessList, error)

ContainerTop shows process information from within a container.

func (*APIClient) ContainerUnpause 

func (client *APIClient) ContainerUnpause(ctx context.Context, name string) error

ContainerUnpause unpauses a container.

func (*APIClient) ContainerUpdate 

func (client *APIClient) ContainerUpdate(ctx context.Context, name string, config *types.UpdateConfig) error

ContainerUpdate updates the configurations of a container.

func (*APIClient) ContainerUpgrade 

func (client *APIClient) ContainerUpgrade(ctx context.Context, name string, config types.ContainerConfig, hostConfig *types.HostConfig) error

ContainerUpgrade upgrade a container with new image and args.

func (*APIClient) GetAPIPath 

func (client *APIClient) GetAPIPath(path string, query url.Values) string

GetAPIPath returns the versioned request path to call the api. It appends the query parameters to the path if they are not empty.

func (*APIClient) ImageInspect 

func (client *APIClient) ImageInspect(ctx context.Context, name string) (types.ImageInfo, error)

ImageInspect requests daemon to inspect an image.

func (*APIClient) ImageList 

func (client *APIClient) ImageList(ctx context.Context) ([]types.ImageInfo, error)

ImageList requests daemon to list all images

func (*APIClient) ImagePull 

func (client *APIClient) ImagePull(ctx context.Context, name, tag, encodedAuth string) (io.ReadCloser, error)

ImagePull requests daemon to pull an image from registry.

func (*APIClient) ImageRemove 

func (client *APIClient) ImageRemove(ctx context.Context, name string, force bool) error

ImageRemove deletes an image.

func (*APIClient) NetworkCreate 

func (client *APIClient) NetworkCreate(ctx context.Context, req *types.NetworkCreateConfig) (*types.NetworkCreateResp, error)

NetworkCreate creates a network.

func (*APIClient) NetworkInspect 

func (client *APIClient) NetworkInspect(ctx context.Context, networkID string) (*types.NetworkInspectResp, error)

NetworkInspect inspects a network.

func (*APIClient) NetworkList 

func (client *APIClient) NetworkList(ctx context.Context) (*types.NetworkListResp, error)

NetworkList lists all the networks.

func (*APIClient) NetworkRemove 

func (client *APIClient) NetworkRemove(ctx context.Context, networkID string) error

NetworkRemove removes a network.

func (*APIClient) RegistryLogin 

func (client *APIClient) RegistryLogin(ctx context.Context, auth *types.AuthConfig) (*types.AuthResponse, error)

RegistryLogin authenticates the server with a given registry to login.

func (*APIClient) SystemInfo 

func (client *APIClient) SystemInfo(ctx context.Context) (*types.SystemInfo, error)

SystemInfo requests daemon for system info.

func (*APIClient) SystemPing 

func (client *APIClient) SystemPing(ctx context.Context) (string, error)

SystemPing shows whether server is ok.

func (*APIClient) SystemVersion 

func (client *APIClient) SystemVersion(ctx context.Context) (*types.SystemVersion, error)

SystemVersion requests daemon for system version.

func (*APIClient) UpdateClientVersion 

func (client *APIClient) UpdateClientVersion(v string)

UpdateClientVersion sets client version new value.

func (*APIClient) VolumeCreate 

func (client *APIClient) VolumeCreate(ctx context.Context, config *types.VolumeCreateConfig) (*types.VolumeInfo, error)

VolumeCreate creates a volume.

func (*APIClient) VolumeInspect 

func (client *APIClient) VolumeInspect(ctx context.Context, name string) (*types.VolumeInfo, error)

VolumeInspect inspects a volume.

func (*APIClient) VolumeList 

func (client *APIClient) VolumeList(ctx context.Context) (*types.VolumeListResp, error)

VolumeList returns the list of volumes.

func (*APIClient) VolumeRemove 

func (client *APIClient) VolumeRemove(ctx context.Context, name string) error

VolumeRemove removes a volume.

type CommonAPIClient 

type CommonAPIClient interface {
	ContainerAPIClient
	ImageAPIClient
	VolumeAPIClient
	SystemAPIClient
	NetworkAPIClient
}

CommonAPIClient defines common methods of api client

func NewAPIClient 

func NewAPIClient(host string, tls TLSConfig) (CommonAPIClient, error)

NewAPIClient initializes a new API client for the given host

type ContainerAPIClient 

type ContainerAPIClient interface {
	ContainerCreate(ctx context.Context, config types.ContainerConfig, hostConfig *types.HostConfig, networkConfig *types.NetworkingConfig, containerName string) (*types.ContainerCreateResp, error)
	ContainerStart(ctx context.Context, name, detachKeys string) error
	ContainerStop(ctx context.Context, name, timeout string) error
	ContainerRemove(ctx context.Context, name string, force bool) error
	ContainerList(ctx context.Context, all bool) ([]*types.Container, error)
	ContainerAttach(ctx context.Context, name string, stdin bool) (net.Conn, *bufio.Reader, error)
	ContainerCreateExec(ctx context.Context, name string, config *types.ExecCreateConfig) (*types.ExecCreateResp, error)
	ContainerStartExec(ctx context.Context, execid string, config *types.ExecStartConfig) (net.Conn, *bufio.Reader, error)
	ContainerGet(ctx context.Context, name string) (*types.ContainerJSON, error)
	ContainerRename(ctx context.Context, id string, name string) error
	ContainerRestart(ctx context.Context, name string, timeout string) error
	ContainerPause(ctx context.Context, name string) error
	ContainerUnpause(ctx context.Context, name string) error
	ContainerUpdate(ctx context.Context, name string, config *types.UpdateConfig) error
	ContainerUpgrade(ctx context.Context, name string, config types.ContainerConfig, hostConfig *types.HostConfig) error
	ContainerTop(ctx context.Context, name string, arguments []string) (types.ContainerProcessList, error)
	ContainerLogs(ctx context.Context, name string, options types.ContainerLogsOptions) (io.ReadCloser, error)
	ContainerResize(ctx context.Context, name, height, width string) error
}

ContainerAPIClient defines methods of Container client.

type ImageAPIClient 

type ImageAPIClient interface {
	ImageList(ctx context.Context) ([]types.ImageInfo, error)
	ImageInspect(ctx context.Context, name string) (types.ImageInfo, error)
	ImagePull(ctx context.Context, name, tag, encodedAuth string) (io.ReadCloser, error)
	ImageRemove(ctx context.Context, name string, force bool) error
}

ImageAPIClient defines methods of Image client.

type NetworkAPIClient 

type NetworkAPIClient interface {
	NetworkCreate(ctx context.Context, req *types.NetworkCreateConfig) (*types.NetworkCreateResp, error)
	NetworkRemove(ctx context.Context, networkID string) error
	NetworkInspect(ctx context.Context, networkID string) (*types.NetworkInspectResp, error)
	NetworkList(ctx context.Context) (*types.NetworkListResp, error)
}

NetworkAPIClient defines methods of Network client.

type RespError 

type RespError struct {
	// contains filtered or unexported fields
}

RespError defines the response error.

func (RespError) Error 

func (e RespError) Error() string

Error implements the error interface.

type Response 

type Response struct {
	StatusCode int
	Status     string
	Body       io.ReadCloser
}

Response wraps the http.Response and other states.

type SystemAPIClient 

type SystemAPIClient interface {
	SystemPing(ctx context.Context) (string, error)
	SystemVersion(ctx context.Context) (*types.SystemVersion, error)
	SystemInfo(ctx context.Context) (*types.SystemInfo, error)
	RegistryLogin(ctx context.Context, auth *types.AuthConfig) (*types.AuthResponse, error)
}

SystemAPIClient defines methods of System client.

type TLSConfig 

type TLSConfig struct {
	CA               string `json:"tlscacert,omitempty"`
	Cert             string `json:"tlscert,omitempty"`
	Key              string `json:"tlskey,omitempty"`
	VerifyRemote     bool   `json:"tlsverify"`
	ManagerWhiteList string `json:"manager-whitelist"`
}

TLSConfig contains information of tls which users can specify

type VolumeAPIClient 

type VolumeAPIClient interface {
	VolumeCreate(ctx context.Context, config *types.VolumeCreateConfig) (*types.VolumeInfo, error)
	VolumeRemove(ctx context.Context, name string) error
	VolumeInspect(ctx context.Context, name string) (*types.VolumeInfo, error)
	VolumeList(ctx context.Context) (*types.VolumeListResp, error)
}

VolumeAPIClient defines methods of Volume client.

Source Files

View all Source files

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.