Documentation
¶
Index ¶
Constants ¶
View Source
const ( ScriptsURL = "STI_SCRIPTS_URL" Location = "STI_LOCATION" )
Variables ¶
This section is empty.
Functions ¶
func GetImageRegistryAuth ¶
func GetImageRegistryAuth(dockerCfg io.Reader, imageName string) client.AuthConfiguration
Types ¶
type BuildImageOptions ¶
BuildImageOptions are options passed in to the BuildImage method
type Client ¶
type Client interface {
RemoveImage(name string) error
InspectImage(name string) (*docker.Image, error)
PullImage(opts docker.PullImageOptions, auth docker.AuthConfiguration) error
CreateContainer(opts docker.CreateContainerOptions) (*docker.Container, error)
AttachToContainer(opts docker.AttachToContainerOptions) error
StartContainer(id string, hostConfig *docker.HostConfig) error
WaitContainer(id string) (int, error)
RemoveContainer(opts docker.RemoveContainerOptions) error
CommitContainer(opts docker.CommitContainerOptions) (*docker.Image, error)
CopyFromContainer(opts docker.CopyFromContainerOptions) error
BuildImage(opts docker.BuildImageOptions) error
}
Client contains all methods called on the go Docker client.
type CommitContainerOptions ¶
type CommitContainerOptions struct {
ContainerID string
Repository string
Command []string
Env []string
}
CommitContainerOptions are options passed in to the CommitContainer method
type Docker ¶
type Docker interface {
IsImageInLocalRegistry(name string) (bool, error)
IsImageOnBuild(string) bool
RemoveContainer(id string) error
GetScriptsURL(name string) (string, error)
RunContainer(opts RunContainerOptions) error
GetImageID(name string) (string, error)
CommitContainer(opts CommitContainerOptions) (string, error)
RemoveImage(name string) error
PullImage(name string) (*docker.Image, error)
CheckAndPull(name string) (*docker.Image, error)
BuildImage(opts BuildImageOptions) error
GetImageUser(name string) (string, error)
}
Docker is the interface between STI and the Docker client It contains higher level operations called from the STI build or usage commands
func New ¶
func New(config *api.DockerConfig, auth docker.AuthConfiguration) (Docker, error)
New creates a new implementation of the STI Docker interface
type DockerImageReference ¶
type DockerImageReference struct {
Registry string
Namespace string
Name string
Tag string
ID string
}
DockerImageReference points to a Docker image.
func ParseDockerImageReference ¶
func ParseDockerImageReference(spec string) (DockerImageReference, error)
ParseDockerImageReference parses a Docker pull spec string into a DockerImageReference. FIXME: This code was copied from OpenShift repository
type PostExecutor ¶
type PullResult ¶
type RunContainerOptions ¶
type RunContainerOptions struct {
Image string
PullImage bool
PullAuth docker.AuthConfiguration
ExternalScripts bool
ScriptsURL string
Location string
Command string
Env []string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
OnStart func() error
PostExec PostExecutor
}
RunContainerOptions are options passed in to the RunContainer method
Click to show internal directories.
Click to hide internal directories.