instance

Documentation

Index

• Variables
• func CreateTempArchive(dir string) (string, error)
• func RetrieveAgentBinary(ctx context.Context, agentVersion string, agentOS string, ...) (string, error)
• func RunContainerizedAgent(ctx context.Context, config *RunConfig, params *Params) error
• type ContainerInstance
  • func (inst *ContainerInstance) Run(ctx context.Context, config *RunConfig) (err error)
  • func (inst *ContainerInstance) WorkingDirectory(projectDir string, dirtyMode bool) string
• type Instance
  • func NewFromProto(anyInstance *any.Any, commands []*api.Command) (Instance, error)
• type Params
• type PersistentWorkerInstance
  • func NewPersistentWorkerInstance() (*PersistentWorkerInstance, error)
  • func (pwi *PersistentWorkerInstance) Run(ctx context.Context, config *RunConfig) (err error)
  • func (pwi *PersistentWorkerInstance) WorkingDirectory(projectDir string, dirtyMode bool) string
• type PipeInstance
  • func (pi *PipeInstance) Run(ctx context.Context, config *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) error
  • func (prebuilt *PrebuiltInstance) WorkingDirectory(projectDir string, dirtyMode bool) string
• type RunConfig
  • func (rc *RunConfig) GetAgentVersion() string
  • func (rc *RunConfig) SetAgentVersion(agentVersion string)
• type Volume
  • func CreateWorkingVolume(ctx context.Context, backend containerbackend.ContainerBackend, ...) (vol *Volume, err error)
  • func CreateWorkingVolumeFromConfig(ctx context.Context, config *RunConfig, platform platform.Platform) (*Volume, error)
  • 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 (
	ErrPopulateFailed      = errors.New("failed to populate working directory")
	ErrAgentDownloadFailed = errors.New("failed to download agent")
)

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 RetrieveAgentBinary

func RetrieveAgentBinary(
	ctx context.Context,
	agentVersion string,
	agentOS string,
	agentArchitecture string,
) (string, error)

func RunContainerizedAgent

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

Types

type ContainerInstance

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

func (*ContainerInstance) Run

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

func (*ContainerInstance) WorkingDirectory

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

type Instance

type Instance interface {
	Run(context.Context, *RunConfig) error
	WorkingDirectory(projectDir string, dirtyMode bool) string
}

func NewFromProto

func NewFromProto(anyInstance *any.Any, commands []*api.Command) (Instance, error)

type Params

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

type PersistentWorkerInstance

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

func NewPersistentWorkerInstance

func NewPersistentWorkerInstance() (*PersistentWorkerInstance, error)

func (*PersistentWorkerInstance) Run

func (pwi *PersistentWorkerInstance) Run(ctx context.Context, config *RunConfig) (err error)

func (*PersistentWorkerInstance) WorkingDirectory

func (pwi *PersistentWorkerInstance) WorkingDirectory(projectDir string, dirtyMode bool) string

type PipeInstance

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

func (*PipeInstance) Run

func (pi *PipeInstance) Run(ctx context.Context, config *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) error

func (*PrebuiltInstance) WorkingDirectory

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

type RunConfig

type RunConfig struct {
	ContainerBackend           containerbackend.ContainerBackend
	ProjectDir                 string
	ContainerEndpoint          string
	DirectEndpoint             string
	ServerSecret, ClientSecret string
	TaskID                     int64
	Logger                     *echelon.Logger
	DirtyMode                  bool
	ContainerOptions           options.ContainerOptions
	// contains filtered or unexported fields
}

func (*RunConfig) GetAgentVersion

func (rc *RunConfig) GetAgentVersion() string

func (*RunConfig) SetAgentVersion

func (rc *RunConfig) SetAgentVersion(agentVersion string)

type Volume

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

func CreateWorkingVolume

func CreateWorkingVolume(
	ctx context.Context,
	backend containerbackend.ContainerBackend,
	containerOptions options.ContainerOptions,
	name string,
	projectDir string,
	dontPopulate bool,
	agentVersion string,
	platform platform.Platform,
) (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,
	platform platform.Platform,
) (*Volume, error)

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

func (*Volume) Close

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

func (*Volume) Name

func (volume *Volume) Name() string