bidstrategy

Documentation

Index

• type BidStrategy
  • func NewWaitingStrategy(underlying BidStrategy, waitOnBid, waitOnNoBid bool) BidStrategy
• type BidStrategyRequest
• type BidStrategyResponse
  • func NewShouldBidResponse() BidStrategyResponse
• type CallbackBidStrategy
  • func NewFixedBidStrategy(response, wait bool) *CallbackBidStrategy
  • func (s *CallbackBidStrategy) ShouldBid(ctx context.Context, request BidStrategyRequest) (BidStrategyResponse, error)
  • func (s *CallbackBidStrategy) ShouldBidBasedOnUsage(ctx context.Context, request BidStrategyRequest, ...) (BidStrategyResponse, error)
• type ChainedBidStrategy
  • func NewChainedBidStrategy(opts ...StrategyOpt) *ChainedBidStrategy
  • func (c *ChainedBidStrategy) AddStrategy(opts ...StrategyOpt)
  • func (c *ChainedBidStrategy) ShouldBid(ctx context.Context, request BidStrategyRequest) (BidStrategyResponse, error)
  • func (c *ChainedBidStrategy) ShouldBidBasedOnUsage(ctx context.Context, request BidStrategyRequest, usage model.ResourceUsageData) (BidStrategyResponse, error)
• type JobSelectionPolicyProbeData
  • func GetJobSelectionPolicyProbeData(request BidStrategyRequest) JobSelectionPolicyProbeData
• type ModerateJobRequest
  • func (mjr ModerateJobRequest) GetClientID() string
• type ResourceBidStrategy
• type SemanticBidStrategy
• type StrategyOpt
  • func WithResources(strategy ...ResourceBidStrategy) StrategyOpt
  • func WithSemantics(strategy ...SemanticBidStrategy) StrategyOpt

Types

type BidStrategy

type BidStrategy interface {
	SemanticBidStrategy
	ResourceBidStrategy
}

func NewWaitingStrategy

func NewWaitingStrategy(underlying BidStrategy, waitOnBid, waitOnNoBid bool) BidStrategy

type BidStrategyRequest

type BidStrategyRequest struct {
	NodeID   string
	Job      model.Job
	Callback *url.URL
}

type BidStrategyResponse

type BidStrategyResponse struct {
	ShouldBid  bool   `json:"shouldBid"`
	ShouldWait bool   `json:"shouldWait"`
	Reason     string `json:"reason"`
}

func NewShouldBidResponse

func NewShouldBidResponse() BidStrategyResponse

type CallbackBidStrategy

type CallbackBidStrategy struct {
	OnShouldBid             func(context.Context, BidStrategyRequest) (BidStrategyResponse, error)
	OnShouldBidBasedOnUsage func(context.Context, BidStrategyRequest, model.ResourceUsageData) (BidStrategyResponse, error)
}

func NewFixedBidStrategy

func NewFixedBidStrategy(response, wait bool) *CallbackBidStrategy

FixedBidStrategy is a bid strategy that always returns the same response, which is useful for testing

func (*CallbackBidStrategy) ShouldBid

func (s *CallbackBidStrategy) ShouldBid(ctx context.Context, request BidStrategyRequest) (BidStrategyResponse, error)

ShouldBid implements BidStrategy

func (*CallbackBidStrategy) ShouldBidBasedOnUsage

func (s *CallbackBidStrategy) ShouldBidBasedOnUsage(
	ctx context.Context,
	request BidStrategyRequest,
	resourceUsage model.ResourceUsageData,
) (BidStrategyResponse, error)

ShouldBidBasedOnUsage implements BidStrategy

type ChainedBidStrategy

type ChainedBidStrategy struct {
	Semantics []SemanticBidStrategy
	Resources []ResourceBidStrategy
}

func NewChainedBidStrategy

func NewChainedBidStrategy(opts ...StrategyOpt) *ChainedBidStrategy

func (*ChainedBidStrategy) AddStrategy

func (c *ChainedBidStrategy) AddStrategy(opts ...StrategyOpt)

AddStrategy Add new strategy to the end of the chain NOTE: this is not thread safe.

func (*ChainedBidStrategy) ShouldBid

func (c *ChainedBidStrategy) ShouldBid(ctx context.Context, request BidStrategyRequest) (BidStrategyResponse, error)

ShouldBid Iterate over all strategies, and return shouldBid if no error is thrown and none of the strategies return should not bid.

func (*ChainedBidStrategy) ShouldBidBasedOnUsage

func (c *ChainedBidStrategy) ShouldBidBasedOnUsage(
	ctx context.Context, request BidStrategyRequest, usage model.ResourceUsageData) (BidStrategyResponse, error)

ShouldBidBasedOnUsage Iterate over all strategies, and return shouldBid if no error is thrown and none of the strategies return should not bid.

type JobSelectionPolicyProbeData

type JobSelectionPolicyProbeData struct {
	NodeID   string     `json:"node_id"`
	JobID    string     `json:"job_id"`
	Spec     model.Spec `json:"spec"`
	Callback *url.URL   `json:"callback"`
}

the JSON data we send to http or exec probes TODO: can we just use the BidStrategyRequest struct?

func GetJobSelectionPolicyProbeData

func GetJobSelectionPolicyProbeData(request BidStrategyRequest) JobSelectionPolicyProbeData

Return JobSelectionPolicyProbeData for the given request

type ModerateJobRequest

type ModerateJobRequest struct {
	ClientID string
	JobID    string
	Response BidStrategyResponse
}

func (ModerateJobRequest) GetClientID

func (mjr ModerateJobRequest) GetClientID() string

type ResourceBidStrategy

type ResourceBidStrategy interface {
	ShouldBidBasedOnUsage(ctx context.Context, request BidStrategyRequest, usage model.ResourceUsageData) (BidStrategyResponse, error)
}

type SemanticBidStrategy

type SemanticBidStrategy interface {
	ShouldBid(ctx context.Context, request BidStrategyRequest) (BidStrategyResponse, error)
}

type StrategyOpt

type StrategyOpt func(strategy *ChainedBidStrategy)

func WithResources

func WithResources(strategy ...ResourceBidStrategy) StrategyOpt

func WithSemantics

func WithSemantics(strategy ...SemanticBidStrategy) StrategyOpt