instance

Documentation

Index

• Constants
• Variables
• func CreateTempArchive(dir string) (string, error)
• func RunDockerizedAgent(ctx context.Context, config *RunConfig, params *Params) error
• type ContainerInstance
  • func (inst *ContainerInstance) Run(ctx context.Context, config *RunConfig) error
• type Instance
  • func NewFromProto(anyInstance *any.Any, commands []*api.Command) (Instance, error)
• type Params
• type PipeInstance
  • func (pi *PipeInstance) Run(ctx context.Context, config *RunConfig) error
• type PipeStage
  • func PipeStagesFromCommands(commands []*api.Command) ([]PipeStage, error)
• type PrebuiltInstance
  • func (prebuilt *PrebuiltInstance) Run(ctx context.Context, config *RunConfig) error
• type RunConfig
• type Volume
  • func CreateWorkingVolume(ctx context.Context, projectDir string, dontPopulate bool) (*Volume, error)
  • func CreateWorkingVolumeFromConfig(ctx context.Context, config *RunConfig) (*Volume, error)
  • func (volume *Volume) Close() error
  • func (volume *Volume) Name() string

Constants

const (
	// AgentImage is the image we'll use to create a working volume.
	AgentImage = "gcr.io/cirrus-ci-community/cirrus-ci-agent:v1.8.0"

	// Where working volume is mounted to.
	WorkingVolumeMountpoint = "/tmp/cirrus-ci"

	// Agent binary relative to the WorkingVolumeMountpoint.
	WorkingVolumeAgent = "cirrus-ci-agent"

	// Working directory relative to the WorkingVolumeMountpoint.
	WorkingVolumeWorkingDir = "working-dir"
)

Variables

var (
	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 RunDockerizedAgent

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

Types

type ContainerInstance

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

func (*ContainerInstance) Run

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

type Instance

type Instance interface {
	Run(context.Context, *RunConfig) error
}

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
	WorkingVolumeName      string
}

type PipeInstance

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

func (*PipeInstance) Run

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

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

type RunConfig

type RunConfig struct {
	ProjectDir                 string
	Endpoint                   string
	ServerSecret, ClientSecret string
	TaskID                     int64
	Logger                     *echelon.Logger
	DirtyMode                  bool
	DockerOptions              options.DockerOptions
}

type Volume

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

func CreateWorkingVolume

func CreateWorkingVolume(ctx context.Context, projectDir string, dontPopulate bool) (*Volume, error)

CreateWorkingVolume returns a Docker volume name with the agent and copied projectDir.

func CreateWorkingVolumeFromConfig

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

CreateWorkingVolume returns a Docker volume name with the agent and copied projectDir.

func (*Volume) Close

func (volume *Volume) Close() error

func (*Volume) Name

func (volume *Volume) Name() string