Documentation
¶
Index ¶
- func PolicyRoot() string
- type DockerClient
- func (dc *DockerClient) GetRunningTopazContainers() ([]container.Summary, error)
- func (dc *DockerClient) ImageExists(img string) bool
- func (dc *DockerClient) IsRunning(name string) (bool, error)
- func (dc *DockerClient) PullImage(img, platform string) error
- func (dc *DockerClient) RemoveImage(img string) error
- func (dc *DockerClient) Run(opts ...RunOption) error
- func (dc *DockerClient) Start(opts ...RunOption) error
- func (dc *DockerClient) Stop(name string) error
- type RunOption
- func WithAutoRemove() RunOption
- func WithCmd(cmds []string) RunOption
- func WithContainerHostname(hostname string) RunOption
- func WithContainerImage(img string) RunOption
- func WithContainerName(name string) RunOption
- func WithContainerPlatform(platform string) RunOption
- func WithEntrypoint(args []string) RunOption
- func WithEnv(env string) RunOption
- func WithEnvs(envs []string) RunOption
- func WithError(e io.Writer) RunOption
- func WithOutput(o io.Writer) RunOption
- func WithPort(port string) RunOption
- func WithPorts(ports []string) RunOption
- func WithVolume(volume string) RunOption
- func WithVolumes(volumes []string) RunOption
- func WithWorkingDir(wd string) RunOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PolicyRoot ¶
func PolicyRoot() string
Types ¶
type DockerClient ¶
type DockerClient struct {
// contains filtered or unexported fields
}
func New ¶
func New() (*DockerClient, error)
func (*DockerClient) GetRunningTopazContainers ¶
func (dc *DockerClient) GetRunningTopazContainers() ([]container.Summary, error)
func (*DockerClient) ImageExists ¶
func (dc *DockerClient) ImageExists(img string) bool
ImageExists checks if image exists in local container store.
func (*DockerClient) IsRunning ¶
func (dc *DockerClient) IsRunning(name string) (bool, error)
IsRunning returns if container with `name` is running.
func (*DockerClient) PullImage ¶
func (dc *DockerClient) PullImage(img, platform string) error
PullImage container image.
func (*DockerClient) RemoveImage ¶
func (dc *DockerClient) RemoveImage(img string) error
RemoveImage removes container image (image-name:tag) from the container store.
func (*DockerClient) Run ¶
func (dc *DockerClient) Run(opts ...RunOption) error
Run starts a container like `docker run` using the provided settings.
func (*DockerClient) Start ¶
func (dc *DockerClient) Start(opts ...RunOption) error
Start starts a container instance like `docker start` using the provided settings.
func (*DockerClient) Stop ¶
func (dc *DockerClient) Stop(name string) error
Stop container instance with `name`.
type RunOption ¶
type RunOption func(*runner)
func WithAutoRemove ¶
func WithAutoRemove() RunOption
WithAutoRemove, automatically remove container when it exits.
func WithContainerHostname ¶
func WithContainerImage ¶
func WithContainerName ¶
func WithContainerPlatform ¶
func WithEntrypoint ¶
func WithOutput ¶
func WithVolume ¶
func WithVolumes ¶
func WithWorkingDir ¶
Source Files
Click to show internal directories.
Click to hide internal directories.