auctioneer

README

Auctioneer

The Auctioneer runs Diego auctions.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/auctioneer.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Diego area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(auctioneerURL string, requestTimeout time.Duration) Client
  • func NewSecureClient(auctioneerURL, caFile, certFile, keyFile string, requireTLS bool, ...) (Client, error)
• type LRPStartRequest
  • func NewLRPStartRequest(processGuid, domain string, indices []int, res rep.Resource, ...) LRPStartRequest
  • func NewLRPStartRequestFromModel(d *models.DesiredLRP, indices ...int) LRPStartRequest
  • func NewLRPStartRequestFromSchedulingInfo(s *models.DesiredLRPSchedulingInfo, indices ...int) LRPStartRequest
  • func (lrpstart *LRPStartRequest) Validate() error
• type TaskStartRequest
  • func NewTaskStartRequest(task rep.Task) TaskStartRequest
  • func NewTaskStartRequestFromModel(taskGuid, domain string, taskDef *models.TaskDefinition) TaskStartRequest
  • func (t *TaskStartRequest) Validate() error

Constants

const (
	CreateTaskAuctionsRoute = "CreateTaskAuctions"
	CreateLRPAuctionsRoute  = "CreateLRPAuctions"
)

Variables

var Routes = rata.Routes{
	{Path: "/v1/tasks", Method: "POST", Name: CreateTaskAuctionsRoute},
	{Path: "/v1/lrps", Method: "POST", Name: CreateLRPAuctionsRoute},
}

Types

type Client

type Client interface {
	RequestLRPAuctions(logger lager.Logger, traceID string, lrpStart []*LRPStartRequest) error
	RequestTaskAuctions(logger lager.Logger, traceID string, tasks []*TaskStartRequest) error
}

func NewClient

func NewClient(auctioneerURL string, requestTimeout time.Duration) Client

func NewSecureClient

func NewSecureClient(auctioneerURL, caFile, certFile, keyFile string, requireTLS bool, requestTimeout time.Duration) (Client, error)

type LRPStartRequest

type LRPStartRequest struct {
	ProcessGuid string `json:"process_guid"`
	Domain      string `json:"domain"`
	Indices     []int  `json:"indices"`
	rep.PlacementConstraint
	rep.Resource
}

func NewLRPStartRequest

func NewLRPStartRequest(processGuid, domain string, indices []int, res rep.Resource, pl rep.PlacementConstraint) LRPStartRequest

func NewLRPStartRequestFromModel

func NewLRPStartRequestFromModel(d *models.DesiredLRP, indices ...int) LRPStartRequest

func NewLRPStartRequestFromSchedulingInfo

func NewLRPStartRequestFromSchedulingInfo(s *models.DesiredLRPSchedulingInfo, indices ...int) LRPStartRequest

func (*LRPStartRequest) Validate

func (lrpstart *LRPStartRequest) Validate() error

type TaskStartRequest

type TaskStartRequest struct {
	rep.Task
}

func NewTaskStartRequest

func NewTaskStartRequest(task rep.Task) TaskStartRequest

func NewTaskStartRequestFromModel

func NewTaskStartRequestFromModel(taskGuid, domain string, taskDef *models.TaskDefinition) TaskStartRequest

func (*TaskStartRequest) Validate

func (t *TaskStartRequest) Validate() error