runners

Documentation

Index

• func ForwardLogs(r io.ReadCloser, ws ...io.Writer)
• func Track(ctx context.Context, trackers []*runtimev1.Tracker) (chan Event, error)
• func WrapStart(cmd *exec.Cmd, writers ...io.Writer) error
• func WrapStartDebug(ctx context.Context, cmd *exec.Cmd, _ io.Writer) error
• type Action
• type ActionType
• type CPU
• type ContainerInstance
• type CreateDockerInput
• type DockerImage
• type DockerOption
  • func WithCmd(cmd ...string) DockerOption
  • func WithEnvironmentVariable(key, value string) DockerOption
  • func WithVolume(source, target string) DockerOption
• type DockerRunner
  • func NewDockerRunner(ctx context.Context, forwarder io.Writer) (*DockerRunner, error)
  • func (r *DockerRunner) ContainerReady(ctx context.Context, name string) (bool, error)
  • func (r *DockerRunner) CreateContainer(ctx context.Context, input CreateDockerInput, opts ...DockerOption) error
  • func (r *DockerRunner) EnsureImage(ctx context.Context, imageName string) error
  • func (r *DockerRunner) IP(*network.ApplicationEndpointInstance) (string, error)
  • func (r *DockerRunner) Start(ctx context.Context) error
  • func (r *DockerRunner) StartContainer(ctx context.Context, c *ContainerInstance) error
  • func (r *DockerRunner) Stop(ctx context.Context) error
• type Event
• type Memory
• type Option
• type ProcessState
  • func (ps ProcessState) String() string
• type Runner
  • func (g *Runner) Kill(ctx context.Context) error
  • func (g *Runner) Load(ctx context.Context) error
  • func (g *Runner) Run(_ context.Context) (*TrackedProcess, error)
• type Tracked
  • func NewTracked(tracker *runtimev1.Tracker) (Tracked, error)
• type TrackedProcess
  • func (p *TrackedProcess) GetCPU(ctx context.Context) (*CPU, error)
  • func (p *TrackedProcess) GetMemory(ctx context.Context) (*Memory, error)
  • func (p *TrackedProcess) GetState(ctx context.Context) (ProcessState, error)
  • func (p *TrackedProcess) Proto() *runtimev1.Tracker
• type VolumeMount

Functions

func ForwardLogs

func ForwardLogs(r io.ReadCloser, ws ...io.Writer)

func Track

func Track(ctx context.Context, trackers []*runtimev1.Tracker) (chan Event, error)

func WrapStart

func WrapStart(cmd *exec.Cmd, writers ...io.Writer) error

func WrapStartDebug

func WrapStartDebug(ctx context.Context, cmd *exec.Cmd, _ io.Writer) error

Types

type Action

type Action struct {
	Type ActionType
}

Action represents an action to be taken on a service by the runner

type ActionType

type ActionType int

const (
	Noop ActionType = iota
	Init
	Start   // Start the service
	Stop    // Stop the service
	Restart // Restart the service
)

type CPU

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

type ContainerInstance

type ContainerInstance struct {
	ID    string
	Name  string
	Image string
	Host  string
	Port  int
}

type CreateDockerInput

type CreateDockerInput struct {
	DockerImage
	ApplicationEndpointInstance *network.ApplicationEndpointInstance
}

type DockerImage

type DockerImage struct {
	Image string
}

type DockerOption

type DockerOption func(option *Option)

func WithCmd

func WithCmd(cmd ...string) DockerOption

func WithEnvironmentVariable

func WithEnvironmentVariable(key, value string) DockerOption

func WithVolume

func WithVolume(source, target string) DockerOption

type DockerRunner

type DockerRunner struct {
	Containers []*ContainerInstance
	// contains filtered or unexported fields
}

func NewDockerRunner

func NewDockerRunner(ctx context.Context, forwarder io.Writer) (*DockerRunner, error)

NewDockerRunner creates a new docker runner

func (*DockerRunner) ContainerReady

func (r *DockerRunner) ContainerReady(ctx context.Context, name string) (bool, error)

func (*DockerRunner) CreateContainer

func (r *DockerRunner) CreateContainer(ctx context.Context, input CreateDockerInput, opts ...DockerOption) error

func (*DockerRunner) EnsureImage

func (r *DockerRunner) EnsureImage(ctx context.Context, imageName string) error

func (*DockerRunner) IP

func (r *DockerRunner) IP(*network.ApplicationEndpointInstance) (string, error)

func (*DockerRunner) Start

func (r *DockerRunner) Start(ctx context.Context) error

func (*DockerRunner) StartContainer

func (r *DockerRunner) StartContainer(ctx context.Context, c *ContainerInstance) error

func (*DockerRunner) Stop

func (r *DockerRunner) Stop(ctx context.Context) error

type Event

type Event struct {
	// Err is the state of error of the service
	Err error

	// Status is the state of the service
	ProcessState

	// CPU
	*observabilityv1.CPU

	// Memory
	*observabilityv1.Memory
}

Event represents data of a **running** service Generic so most fields will be nil

type Memory

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

type Option

type Option struct {
	Cmd     []string
	Volumes []VolumeMount
	Envs    []string
}

type ProcessState

type ProcessState int

const (
	Unknown  ProcessState = iota
	NotFound ProcessState = iota
	Running
	InterruptibleSleep
	UninterruptibleSleep
	Stopped
	Zombie
	Dead
	TracingStop
	Idle
	Parked
	Waking
)

func (ProcessState) String

func (ps ProcessState) String() string

type Runner

type Runner struct {
	Name  string
	Bin   string
	Dir   string
	Args  []string
	Envs  []string
	Debug bool

	Wait bool

	Cmd *exec.Cmd
	// contains filtered or unexported fields
}

func (*Runner) Kill

func (g *Runner) Kill(ctx context.Context) error

func (*Runner) Load

func (g *Runner) Load(ctx context.Context) error

func (*Runner) Run

func (g *Runner) Run(_ context.Context) (*TrackedProcess, error)

type Tracked

type Tracked interface {
	GetState(ctx context.Context) (ProcessState, error)
	GetCPU(ctx context.Context) (*CPU, error)
	GetMemory(ctx context.Context) (*Memory, error)
}

func NewTracked

func NewTracked(tracker *runtimev1.Tracker) (Tracked, error)

type TrackedProcess

type TrackedProcess struct {
	PID    int
	Killed bool
}

func (*TrackedProcess) GetCPU

func (p *TrackedProcess) GetCPU(ctx context.Context) (*CPU, error)

func (*TrackedProcess) GetMemory

func (p *TrackedProcess) GetMemory(ctx context.Context) (*Memory, error)

func (*TrackedProcess) GetState

func (p *TrackedProcess) GetState(ctx context.Context) (ProcessState, error)

func (*TrackedProcess) Proto

func (p *TrackedProcess) Proto() *runtimev1.Tracker

type VolumeMount

type VolumeMount struct {
	Source string
	Target string
}