cluster

Documentation

Index

• Variables
• func NewNode(id string, available atypes.ResourceUnits) ctypes.Node
• func NewServiceLog(name string, stream io.ReadCloser) *ctypes.ServiceLog
• type Client
  • func NullClient() Client
• type Cluster
• type Config
  • func NewDefaultConfig() Config
• type ReadClient
• type Service
  • func NewService(ctx context.Context, session session.Session, bus pubsub.Bus, client Client, ...) (Service, error)
• type StatusClient

Variables

var (

	// ErrInsufficientCapacity is the new error when capacity is insufficient
	ErrInsufficientCapacity = errors.New("insufficient capacity")
)

var ErrNoDeployments = errors.New("no deployments")

ErrNoDeployments indicates no deployments exist

var ErrNotRunning = errors.New("not running")

ErrNotRunning is the error when service is not running

Functions

func NewNode

func NewNode(id string, available atypes.ResourceUnits) ctypes.Node

NewNode returns new Node instance with provided details

func NewServiceLog

func NewServiceLog(name string, stream io.ReadCloser) *ctypes.ServiceLog

NewServiceLog creates and returns a service log with provided details

Types

type Client

type Client interface {
	ReadClient
	Deploy(context.Context, mtypes.LeaseID, *manifest.Group) error
	TeardownLease(context.Context, mtypes.LeaseID) error
	Deployments(context.Context) ([]ctypes.Deployment, error)
	Inventory(context.Context) ([]ctypes.Node, error)
}

Client interface lease and deployment methods

func NullClient

func NullClient() Client

NullClient returns nullClient instance

type Cluster

type Cluster interface {
	Reserve(mtypes.OrderID, atypes.ResourceGroup) (ctypes.Reservation, error)
	Unreserve(mtypes.OrderID) error
}

Cluster is the interface that wraps Reserve and Unreserve methods

type Config

type Config struct {
	InventoryResourcePollPeriod     time.Duration
	InventoryResourceDebugFrequency uint
	InventoryExternalPortQuantity   uint
}

func NewDefaultConfig

func NewDefaultConfig() Config

type ReadClient

type ReadClient interface {
	LeaseStatus(context.Context, mtypes.LeaseID) (*ctypes.LeaseStatus, error)
	ServiceStatus(context.Context, mtypes.LeaseID, string) (*ctypes.ServiceStatus, error)
	ServiceLogs(context.Context, mtypes.LeaseID, string, bool, *int64) ([]*ctypes.ServiceLog, error)
}

type Service

type Service interface {
	StatusClient
	Cluster
	Close() error
	Ready() <-chan struct{}
	Done() <-chan struct{}
}

Service manage compute cluster for the provider. Will eventually integrate with kubernetes, etc...

func NewService

func NewService(ctx context.Context, session session.Session, bus pubsub.Bus, client Client, cfg Config) (Service, error)

NewService returns new Service instance

type StatusClient

type StatusClient interface {
	Status(context.Context) (*ctypes.Status, error)
}

StatusClient is the interface which includes status of service