Documentation
¶
Index ¶
- Constants
- func CreateTarStream(path string) (io.ReadCloser, error)
- func FuckDockerStream(stream dockertypes.HijackedResponse) io.ReadCloser
- func GetIP(ctx context.Context, daemonHost string) string
- func MakeClient(ctx context.Context, config coretypes.Config, ...) (engine.API, error)
- type Engine
- func (e *Engine) BuildContent(ctx context.Context, scm coresource.Source, ...) (string, io.Reader, error)
- func (e *Engine) BuildRefs(_ context.Context, opts *enginetypes.BuildRefOptions) []string
- func (e *Engine) CloseConn() error
- func (e *Engine) ExecExitCode(ctx context.Context, _, execID string) (int, error)
- func (e *Engine) ExecResize(ctx context.Context, execID string, height, width uint) error
- func (e *Engine) Execute(ctx context.Context, ID string, config *enginetypes.ExecConfig) (execID string, stdout, stderr io.ReadCloser, stdin io.WriteCloser, err error)
- func (e *Engine) GetParams() *enginetypes.Params
- func (e *Engine) ImageBuild(ctx context.Context, input io.Reader, refs []string, platform string) (io.ReadCloser, error)
- func (e *Engine) ImageBuildCachePrune(ctx context.Context, all bool) (uint64, error)
- func (e *Engine) ImageBuildFromExist(ctx context.Context, ID string, refs []string, _ string) (imageID string, err error)
- func (e *Engine) ImageList(ctx context.Context, image string) ([]*enginetypes.Image, error)
- func (e *Engine) ImageLocalDigests(ctx context.Context, image string) ([]string, error)
- func (e *Engine) ImagePull(ctx context.Context, ref string, all bool) (io.ReadCloser, error)
- func (e *Engine) ImagePush(ctx context.Context, ref string) (io.ReadCloser, error)
- func (e *Engine) ImageRemoteDigest(ctx context.Context, image string) (string, error)
- func (e *Engine) ImageRemove(ctx context.Context, image string, force, prune bool) ([]string, error)
- func (e *Engine) ImagesPrune(ctx context.Context) error
- func (e *Engine) Info(ctx context.Context) (*enginetypes.Info, error)
- func (e *Engine) NetworkConnect(ctx context.Context, network, target, ipv4, _ string) ([]string, error)
- func (e *Engine) NetworkDisconnect(ctx context.Context, network, target string, force bool) error
- func (e *Engine) NetworkList(ctx context.Context, drivers []string) ([]*enginetypes.Network, error)
- func (e *Engine) Ping(ctx context.Context) error
- func (e *Engine) RawEngine(context.Context, *enginetypes.RawEngineOptions) (res *enginetypes.RawEngineResult, err error)
- func (e *Engine) VirtualizationAttach(ctx context.Context, ID string, stream, stdin bool) (stdout, stderr io.ReadCloser, _ io.WriteCloser, err error)
- func (e *Engine) VirtualizationCopyChunkTo(ctx context.Context, ID, target string, size int64, content io.Reader, ...) error
- func (e *Engine) VirtualizationCopyFrom(ctx context.Context, ID, path string) (content []byte, uid, gid int, mode int64, err error)
- func (e *Engine) VirtualizationCopyTo(ctx context.Context, ID, target string, content []byte, uid, gid int, ...) error
- func (e *Engine) VirtualizationCreate(ctx context.Context, opts *enginetypes.VirtualizationCreateOptions) (*enginetypes.VirtualizationCreated, error)
- func (e *Engine) VirtualizationInspect(ctx context.Context, ID string) (*enginetypes.VirtualizationInfo, error)
- func (e *Engine) VirtualizationLogs(ctx context.Context, opts *enginetypes.VirtualizationLogStreamOptions) (stdout, stderr io.ReadCloser, err error)
- func (e *Engine) VirtualizationRemove(ctx context.Context, ID string, removeVolumes, force bool) error
- func (e *Engine) VirtualizationResize(ctx context.Context, workloadID string, height, width uint) (err error)
- func (e *Engine) VirtualizationResume(context.Context, string) error
- func (e *Engine) VirtualizationStart(ctx context.Context, ID string) error
- func (e *Engine) VirtualizationStop(ctx context.Context, ID string, gracefulTimeout time.Duration) error
- func (e *Engine) VirtualizationSuspend(context.Context, string) error
- func (e *Engine) VirtualizationUpdateResource(ctx context.Context, ID string, engineParams resourcetypes.Resources) error
- func (e *Engine) VirtualizationWait(ctx context.Context, ID, _ string) (*enginetypes.VirtualizationWaitResult, error)
- type RawArgs
Constants ¶
const ( // TCPPrefixKey indicate tcp prefix TCPPrefixKey = "tcp://" // SockPrefixKey indicate sock prefix SockPrefixKey = "unix://" // Type indicate docker Type = "docker" )
Variables ¶
This section is empty.
Functions ¶
func CreateTarStream ¶
func CreateTarStream(path string) (io.ReadCloser, error)
CreateTarStream create a tar stream
func FuckDockerStream ¶
func FuckDockerStream(stream dockertypes.HijackedResponse) io.ReadCloser
FuckDockerStream will copy docker stream to stdout and err
Types ¶
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
Engine is engine for docker
func (*Engine) BuildContent ¶
func (e *Engine) BuildContent(ctx context.Context, scm coresource.Source, opts *enginetypes.BuildContentOptions) (string, io.Reader, error)
BuildContent generate build content since we wanna set UID for the user inside workload, we have to know the uid parameter
build directory is like:
buildDir ├─ :appname ├─ code ├─ Dockerfile
func (*Engine) BuildRefs ¶
func (e *Engine) BuildRefs(_ context.Context, opts *enginetypes.BuildRefOptions) []string
BuildRefs output refs
func (*Engine) ExecExitCode ¶
ExecExitCode get exec return code
func (*Engine) ExecResize ¶
ExecResize resize exec tty
func (*Engine) Execute ¶
func (e *Engine) Execute(ctx context.Context, ID string, config *enginetypes.ExecConfig) (execID string, stdout, stderr io.ReadCloser, stdin io.WriteCloser, err error)
Execute executes a workload
func (*Engine) GetParams ¶
func (e *Engine) GetParams() *enginetypes.Params
func (*Engine) ImageBuild ¶
func (e *Engine) ImageBuild(ctx context.Context, input io.Reader, refs []string, platform string) (io.ReadCloser, error)
ImageBuild build image
func (*Engine) ImageBuildCachePrune ¶
ImageBuildCachePrune prune build cache
func (*Engine) ImageBuildFromExist ¶
func (e *Engine) ImageBuildFromExist(ctx context.Context, ID string, refs []string, _ string) (imageID string, err error)
ImageBuildFromExist commits image from running workload
func (*Engine) ImageLocalDigests ¶
ImageLocalDigests return image digests
func (*Engine) ImageRemoteDigest ¶
ImageRemoteDigest return image digest at remote
func (*Engine) ImageRemove ¶
func (e *Engine) ImageRemove(ctx context.Context, image string, force, prune bool) ([]string, error)
ImageRemove remove a image
func (*Engine) ImagesPrune ¶
ImagesPrune prune images
func (*Engine) Info ¶
Info show node info 2 seconds timeout used to be 5, but client won't wait that long
func (*Engine) NetworkConnect ¶
func (e *Engine) NetworkConnect(ctx context.Context, network, target, ipv4, _ string) ([]string, error)
NetworkConnect connect to a network
func (*Engine) NetworkDisconnect ¶
NetworkDisconnect disconnect from a network
func (*Engine) NetworkList ¶
NetworkList show all networks
func (*Engine) RawEngine ¶
func (e *Engine) RawEngine(context.Context, *enginetypes.RawEngineOptions) (res *enginetypes.RawEngineResult, err error)
func (*Engine) VirtualizationAttach ¶
func (e *Engine) VirtualizationAttach(ctx context.Context, ID string, stream, stdin bool) (stdout, stderr io.ReadCloser, _ io.WriteCloser, err error)
VirtualizationAttach attach to a virtualization
func (*Engine) VirtualizationCopyChunkTo ¶
func (e *Engine) VirtualizationCopyChunkTo(ctx context.Context, ID, target string, size int64, content io.Reader, uid, gid int, mode int64) error
VirtualizationCopyChunkTo copy chunk to virtualization
func (*Engine) VirtualizationCopyFrom ¶
func (e *Engine) VirtualizationCopyFrom(ctx context.Context, ID, path string) (content []byte, uid, gid int, mode int64, err error)
VirtualizationCopyFrom copy thing from a virtualization
func (*Engine) VirtualizationCopyTo ¶
func (e *Engine) VirtualizationCopyTo(ctx context.Context, ID, target string, content []byte, uid, gid int, mode int64) error
VirtualizationCopyTo copy things to virtualization
func (*Engine) VirtualizationCreate ¶
func (e *Engine) VirtualizationCreate(ctx context.Context, opts *enginetypes.VirtualizationCreateOptions) (*enginetypes.VirtualizationCreated, error)
VirtualizationCreate create a workload
func (*Engine) VirtualizationInspect ¶
func (e *Engine) VirtualizationInspect(ctx context.Context, ID string) (*enginetypes.VirtualizationInfo, error)
VirtualizationInspect get virtualization info
func (*Engine) VirtualizationLogs ¶
func (e *Engine) VirtualizationLogs(ctx context.Context, opts *enginetypes.VirtualizationLogStreamOptions) (stdout, stderr io.ReadCloser, err error)
VirtualizationLogs show virtualization logs
func (*Engine) VirtualizationRemove ¶
func (e *Engine) VirtualizationRemove(ctx context.Context, ID string, removeVolumes, force bool) error
VirtualizationRemove remove virtualization
func (*Engine) VirtualizationResize ¶
func (e *Engine) VirtualizationResize(ctx context.Context, workloadID string, height, width uint) (err error)
VirtualizationResize resizes remote terminal
func (*Engine) VirtualizationResume ¶
VirtualizationResume resumes virtualization
func (*Engine) VirtualizationStart ¶
VirtualizationStart start virtualization
func (*Engine) VirtualizationStop ¶
func (e *Engine) VirtualizationStop(ctx context.Context, ID string, gracefulTimeout time.Duration) error
VirtualizationStop stop virtualization
func (*Engine) VirtualizationSuspend ¶
VirtualizationSuspend suspends virtualization
func (*Engine) VirtualizationUpdateResource ¶
func (e *Engine) VirtualizationUpdateResource(ctx context.Context, ID string, engineParams resourcetypes.Resources) error
VirtualizationUpdateResource update virtualization resource
func (*Engine) VirtualizationWait ¶
func (e *Engine) VirtualizationWait(ctx context.Context, ID, _ string) (*enginetypes.VirtualizationWaitResult, error)
VirtualizationWait wait virtualization exit
type RawArgs ¶
type RawArgs struct { PidMode dockercontainer.PidMode `json:"pid_mod"` StorageOpt map[string]string `json:"storage_opt"` CapAdd []string `json:"cap_add"` CapDrop []string `json:"cap_drop"` Ulimits []*units.Ulimit `json:"ulimits"` Runtime string `json:"runtime"` }
RawArgs means some underlay args