worker

Documentation

Index

• Variables
• type AutoscalingPool
  • func NewPool(ctx context.Context, clientset kubernetes.Interface, conf config.Buildkit, ...) *AutoscalingPool
  • func (p *AutoscalingPool) Close()
  • func (p *AutoscalingPool) Get(ctx context.Context, owner string) (string, error)
  • func (p *AutoscalingPool) Release(ctx context.Context, addr string) error
• type BuilderState
  • func (bs BuilderState) String() string
• type Options
• type PodObservation
  • func (m *PodObservation) MarkLeased()
  • func (m *PodObservation) String() string
• type PodRequest
• type PodRequestResult
• type Pool
• type PoolOption
  • func EndpointWatchTimeoutSeconds(s int64) PoolOption
  • func Logger(log logr.Logger) PoolOption
  • func MaxIdleTime(d time.Duration) PoolOption
  • func SyncWaitTime(d time.Duration) PoolOption
• type Queue
  • func NewRequestQueue() *Queue
  • func (q *Queue) Dequeue() *PodRequest
  • func (q *Queue) Enqueue(req *PodRequest)
  • func (q *Queue) Len() int
  • func (q *Queue) Remove(req *PodRequest) bool
• type RequestQueue
• type ScaleArbiter
  • func NewScaleArbiter(log logr.Logger, podClient corev1typed.PodInterface, podExpiry time.Duration) *ScaleArbiter
  • func (a *ScaleArbiter) DetermineReplicas(requests int) int
  • func (a *ScaleArbiter) EvaluatePod(ctx context.Context, uuid string, pod corev1.Pod)
  • func (a *ScaleArbiter) LeasablePods() (observations []*PodObservation)

Variables

var (
	ErrNoUnleasedPods = errors.New("no unleased pods found")
)

Types

type AutoscalingPool

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

func NewPool

func NewPool(
	ctx context.Context,
	clientset kubernetes.Interface,
	conf config.Buildkit,
	opts ...PoolOption,
) *AutoscalingPool

NewPool creates a new worker pool that can be used to lease buildkit workers for image builds.

func (*AutoscalingPool) Close

func (p *AutoscalingPool) Close()

Close shuts down the pool by terminating all background routines used to manage requests and garbage collection.

func (*AutoscalingPool) Get

func (p *AutoscalingPool) Get(ctx context.Context, owner string) (string, error)

Get a lease for a worker in the pool and return a routable address.

Adds "lease"/"manager-identity" metadata and removes "expiry-time". The worker will remain leased until the caller provides the address to Release().

func (*AutoscalingPool) Release

func (p *AutoscalingPool) Release(ctx context.Context, addr string) error

Release an address back into the worker pool.

Adds "expiry-time" and removes "lease"/"manager-identity" metadata. The underlying worker will be terminated after its expiry time has passed.

type BuilderState

type BuilderState int

BuilderState is an observed buildkit pod state.

const (
	// BuilderStateUnmanaged indicates a pod's manager ID is not current.
	BuilderStateUnmanaged BuilderState = iota
	// BuilderStateLeased indicates a pod has been leased for building.
	BuilderStateLeased
	// BuilderStatePending indicates a pod is not fully-operational.
	BuilderStatePending
	// BuilderStatePendingExpired indicates a pod has been in a pending state longer than its expiry.
	BuilderStatePendingExpired
	// BuilderStateStarting indicates a pod is running but not ready for work.
	BuilderStateStarting
	// BuilderStateStartingExpired indicates a pod has been in a starting state longer than its expiry.
	BuilderStateStartingExpired
	// BuilderStateOperational indicates a pod is ready to build.
	BuilderStateOperational
	// BuilderStateOperationalExpired indicates an operational pod's TTL has expired.
	BuilderStateOperationalExpired
	// BuilderStateOperationalInvalidExpiry indicates an operational pod has bad expiry data in its annotations.
	BuilderStateOperationalInvalidExpiry
	// BuilderStateUnusable indicates a pod has an unknown phase or set of conditions.
	BuilderStateUnusable
)

func (BuilderState) String

func (bs BuilderState) String() string

String representation of the builder state.

type Options

type Options struct {
	Log                         logr.Logger
	MaxIdleTime                 time.Duration
	SyncWaitTime                time.Duration
	EndpointWatchTimeoutSeconds int64
}

type PodObservation

type PodObservation struct {
	Pod   corev1.Pod
	State BuilderState
}

PodObservation records the builder state for a single pod.

func (*PodObservation) MarkLeased

func (m *PodObservation) MarkLeased()

MarkLeased should be invoked whenever the caller leases a pod that has been previously evaluated.

func (*PodObservation) String

func (m *PodObservation) String() string

String renders the name and state of the observed pod.

type PodRequest

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

type PodRequestResult

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

type Pool

type Pool interface {
	Get(ctx context.Context, owner string) (workerAddr string, err error)
	Release(ctx context.Context, workerAddr string) error
	Close()
}

type PoolOption

type PoolOption func(o Options) Options

func EndpointWatchTimeoutSeconds

func EndpointWatchTimeoutSeconds(s int64) PoolOption

func Logger

func Logger(log logr.Logger) PoolOption

func MaxIdleTime

func MaxIdleTime(d time.Duration) PoolOption

func SyncWaitTime

func SyncWaitTime(d time.Duration) PoolOption

type Queue

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

func NewRequestQueue

func NewRequestQueue() *Queue

func (*Queue) Dequeue

func (q *Queue) Dequeue() *PodRequest

func (*Queue) Enqueue

func (q *Queue) Enqueue(req *PodRequest)

func (*Queue) Len

func (q *Queue) Len() int

func (*Queue) Remove

func (q *Queue) Remove(req *PodRequest) bool

type RequestQueue

type RequestQueue interface {
	Enqueue(*PodRequest)
	Dequeue() *PodRequest
	Len() int
	Remove(*PodRequest) bool
}

type ScaleArbiter

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

ScaleArbiter can be used to determine the proper number of replicas for a buildkit statefulset based on the number of build requests and existing pods.

func NewScaleArbiter

func NewScaleArbiter(log logr.Logger, podClient corev1typed.PodInterface, podExpiry time.Duration) *ScaleArbiter

NewScaleArbiter initializes

func (*ScaleArbiter) DetermineReplicas

func (a *ScaleArbiter) DetermineReplicas(requests int) int

DetermineReplicas calculates the number of buildkit replicas required to service the incoming requests.

func (*ScaleArbiter) EvaluatePod

func (a *ScaleArbiter) EvaluatePod(ctx context.Context, uuid string, pod corev1.Pod)

EvaluatePod builder state and store the observation for use when determining the scale replicas.

func (*ScaleArbiter) LeasablePods

func (a *ScaleArbiter) LeasablePods() (observations []*PodObservation)

LeasablePods returns a list of pods that are ready to build images.