Documentation
¶
Overview ¶
Package runtime provides the ability for Vela to integrate with different supported Runtime environments.
Usage:
import "github.com/go-vela/worker/runtime"
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Engine ¶
type Engine interface {
// InfoContainer defines a function that gets
// information on the pipeline container.
InfoContainer(context.Context, *pipeline.Container) error
// RemoveContainer defines a function that deletes
// (kill, remove) the pipeline container.
RemoveContainer(context.Context, *pipeline.Container) error
// RunContainer defines a function that creates
// and start the pipeline container.
RunContainer(context.Context, *pipeline.Build, *pipeline.Container) error
// SetupContainer defines a function that pulls
// the image for the pipeline container.
SetupContainer(context.Context, *pipeline.Container) error
// TailContainer defines a function that captures
// the logs on the pipeline container.
TailContainer(context.Context, *pipeline.Container) (io.ReadCloser, error)
// WaitContainer defines a function that blocks
// until the pipeline container completes.
WaitContainer(context.Context, *pipeline.Container) error
// CreateNetwork defines a function that
// creates the pipeline network.
CreateNetwork(context.Context, *pipeline.Build) error
// RemoveNetwork defines a function that
// deletes the pipeline network.
RemoveNetwork(context.Context, *pipeline.Build) error
// CreateVolume defines a function that
// creates the pipeline volume.
CreateVolume(context.Context, *pipeline.Build) error
// RemoveVolume defines a function that
// deletes the pipeline volume.
RemoveVolume(context.Context, *pipeline.Build) error
}
Engine represents the interface for Vela integrating with the different supported Runtime environments.
func FromContext ¶
FromContext returns the runtime Engine associated with this context.
Click to show internal directories.
Click to hide internal directories.