instance

Documentation

Index

• Variables
• func CreateTempArchive(dir string) (string, error)
• func CreateWorkingVolume(ctx context.Context, backend containerbackend.ContainerBackend, ...) (agentVolume *Volume, vol *Volume, err error)
• func CreateWorkingVolumeFromConfig(ctx context.Context, config *runconfig.RunConfig, platform platform.Platform) (*Volume, *Volume, error)
• func NewFromProto(anyInstance *any.Any, commands []*api.Command, customWorkingDir string, ...) (abstract.Instance, error)
• func RunContainerizedAgent(ctx context.Context, config *runconfig.RunConfig, params *Params) error
• type ContainerInstance
  • func (inst *ContainerInstance) Run(ctx context.Context, config *runconfig.RunConfig) (err error)
  • func (inst *ContainerInstance) WorkingDirectory(projectDir string, dirtyMode bool) string
• type Params
• type PipeInstance
  • func (pi *PipeInstance) Run(ctx context.Context, config *runconfig.RunConfig) (err error)
  • func (pi *PipeInstance) WorkingDirectory(projectDir string, dirtyMode bool) string
• type PipeStage
  • func PipeStagesFromCommands(commands []*api.Command) ([]PipeStage, error)
• type PrebuiltInstance
  • func (prebuilt *PrebuiltInstance) Run(ctx context.Context, config *runconfig.RunConfig) error
  • func (prebuilt *PrebuiltInstance) WorkingDirectory(projectDir string, dirtyMode bool) string
• type RendererStub
  • func (*RendererStub) RenderMessage(entry *echelon.LogEntryMessage)
  • func (*RendererStub) RenderScopeFinished(entry *echelon.LogScopeFinished)
  • func (*RendererStub) RenderScopeStarted(entry *echelon.LogScopeStarted)
• type Volume
  • func (volume *Volume) Close(backend containerbackend.ContainerBackend) error
  • func (volume *Volume) Name() string

Variables

var (
	ErrFailedToCreateInstance    = errors.New("failed to create instance")
	ErrUnsupportedInstance       = errors.New("unsupported instance type")
	ErrAdditionalContainerFailed = errors.New("additional container failed")
)

var (
	ErrVolumeCreationFailed = errors.New("working volume creation failed")
	ErrVolumeCleanupFailed  = errors.New("failed to clean up working volume")
)

var ErrPipeCreationFailed = errors.New("failed to create pipe instance")

Functions

func CreateTempArchive

func CreateTempArchive(dir string) (string, error)

func CreateWorkingVolume

func CreateWorkingVolume(
	ctx context.Context,
	backend containerbackend.ContainerBackend,
	containerOptions options.ContainerOptions,
	agentVolumeName string,
	workingVolumeName string,
	projectDir string,
	dontPopulate bool,
	agentVersion string,
	platform platform.Platform,
) (agentVolume *Volume, vol *Volume, err error)

CreateWorkingVolume returns name of the working volume created according to the specification in arguments.

func CreateWorkingVolumeFromConfig

func CreateWorkingVolumeFromConfig(
	ctx context.Context,
	config *runconfig.RunConfig,
	platform platform.Platform,
) (*Volume, *Volume, error)

CreateWorkingVolumeFromConfig returns name of the working volume created according to the specification in config.

func NewFromProto

func NewFromProto(
	anyInstance *any.Any,
	commands []*api.Command,
	customWorkingDir string,
	logger logger.Lightweight,
) (abstract.Instance, error)

func RunContainerizedAgent

func RunContainerizedAgent(ctx context.Context, config *runconfig.RunConfig, params *Params) error

Types

type ContainerInstance

type ContainerInstance struct {
	Image                string
	CPU                  float32
	Memory               uint32
	AdditionalContainers []*api.AdditionalContainer
	Platform             platform.Platform
	CustomWorkingDir     string
}

func (*ContainerInstance) Run

func (inst *ContainerInstance) Run(ctx context.Context, config *runconfig.RunConfig) (err error)

func (*ContainerInstance) WorkingDirectory

func (inst *ContainerInstance) WorkingDirectory(projectDir string, dirtyMode bool) string

type Params

type Params struct {
	Image                  string
	CPU                    float32
	Memory                 uint32
	AdditionalContainers   []*api.AdditionalContainer
	CommandFrom, CommandTo string
	Platform               platform.Platform
	AgentVolumeName        string
	WorkingVolumeName      string
	WorkingDirectory       string
}

type PipeInstance

type PipeInstance struct {
	Stages           []PipeStage
	CPU              float32
	Memory           uint32
	CustomWorkingDir string
}

func (*PipeInstance) Run

func (pi *PipeInstance) Run(ctx context.Context, config *runconfig.RunConfig) (err error)

func (*PipeInstance) WorkingDirectory

func (pi *PipeInstance) WorkingDirectory(projectDir string, dirtyMode bool) string

type PipeStage

type PipeStage struct {
	Image                  string
	CommandFrom, CommandTo string
}

func PipeStagesFromCommands

func PipeStagesFromCommands(commands []*api.Command) ([]PipeStage, error)

PipeStagesFromCommands uses image hints in commands to build the stages.

type PrebuiltInstance

type PrebuiltInstance struct {
	Image      string
	Dockerfile string
	Arguments  map[string]string
}

func (*PrebuiltInstance) Run

func (prebuilt *PrebuiltInstance) Run(ctx context.Context, config *runconfig.RunConfig) error

func (*PrebuiltInstance) WorkingDirectory

func (prebuilt *PrebuiltInstance) WorkingDirectory(projectDir string, dirtyMode bool) string

type RendererStub

type RendererStub struct{}

func (*RendererStub) RenderMessage

func (*RendererStub) RenderMessage(entry *echelon.LogEntryMessage)

func (*RendererStub) RenderScopeFinished

func (*RendererStub) RenderScopeFinished(entry *echelon.LogScopeFinished)

func (*RendererStub) RenderScopeStarted

func (*RendererStub) RenderScopeStarted(entry *echelon.LogScopeStarted)

type Volume

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

func (*Volume) Close

func (volume *Volume) Close(backend containerbackend.ContainerBackend) error

func (*Volume) Name

func (volume *Volume) Name() string