cluster

Documentation

Index

• Variables
• type Client
  • func NullClient() Client
• type Cluster
• type Deployment
• type InventoryStatus
• type LeaseStatus
• type Node
  • func NewNode(id string, available atypes.Unit) Node
• type Reservation
• type Service
  • func NewService(ctx context.Context, session session.Session, bus pubsub.Bus, client Client) (Service, error)
• type ServiceLog
  • func NewServiceLog(name string, stream io.ReadCloser) *ServiceLog
• type ServiceStatus
• type Status
• 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

Types

type Client

type Client interface {
	Deploy(context.Context, mtypes.LeaseID, *manifest.Group) error
	TeardownLease(context.Context, mtypes.LeaseID) error
	Deployments(context.Context) ([]Deployment, error)
	LeaseStatus(context.Context, mtypes.LeaseID) (*LeaseStatus, error)
	ServiceStatus(context.Context, mtypes.LeaseID, string) (*ServiceStatus, error)
	ServiceLogs(context.Context, mtypes.LeaseID, int64, bool) ([]*ServiceLog, error)
	Inventory(context.Context) ([]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) (Reservation, error)
	Unreserve(mtypes.OrderID, atypes.ResourceGroup) error
}

Cluster is the interface that wraps Reserve and Unreserve methods

type Deployment

type Deployment interface {
	LeaseID() mtypes.LeaseID
	ManifestGroup() manifest.Group
}

Deployment interface defined with LeaseID and ManifestGroup methods

type InventoryStatus

type InventoryStatus struct {
	Active    []atypes.Unit
	Pending   []atypes.Unit
	Available []atypes.Unit
}

InventoryStatus stores active, pending and available units

type LeaseStatus

type LeaseStatus struct {
	Services []*ServiceStatus
}

LeaseStatus includes list of services with their status

type Node

type Node interface {
	ID() string
	Available() atypes.Unit
}

Node interface predefined with ID and Available methods

func NewNode

func NewNode(id string, available atypes.Unit) Node

NewNode returns new Node instance with provided details

type Reservation

type Reservation interface {
	OrderID() mtypes.OrderID
	Resources() atypes.ResourceGroup
}

Reservation interface implements orders and resources

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) (Service, error)

NewService returns new Service instance

type ServiceLog

type ServiceLog struct {
	Name    string
	Stream  io.ReadCloser
	Scanner *bufio.Scanner
}

ServiceLog stores name, stream and scanner

func NewServiceLog

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

NewServiceLog creates and returns a service log with provided details

type ServiceStatus

type ServiceStatus struct {
	Name      string
	Available int32
	Total     int32
	URIs      []string

	ObservedGeneration int64
	Replicas           int32
	UpdatedReplicas    int32
	ReadyReplicas      int32
	AvailableReplicas  int32
}

ServiceStatus stores the current status of service

type Status

type Status struct {
	Leases    uint32
	Inventory InventoryStatus
}

Status stores current leases and inventory statuses

type StatusClient

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

StatusClient is the interface which includes status of service