v1beta1

Documentation

Index

• Constants
• type ActiveHostname
• type ConnectHostnameToDeploymentDirective
• type Deployment
• type EventsWatcher
  • func NewEventsFeed(ctx context.Context) EventsWatcher
• type ExecResult
• type ForwardedPortStatus
• type HostnameResourceEvent
• type HostnameServiceClient
• type InventoryStatus
• type LeaseEvent
• type LeaseEventObject
• type LeaseIDHostnameConnection
• type LeaseStatus
• type Node
• type ProviderResourceEvent
• type Reservation
• type ServiceLog
• type ServiceStatus
• type Status

Constants

const (
	ProviderResourceAdd    = ProviderResourceEvent("add")
	ProviderResourceUpdate = ProviderResourceEvent("update")
	ProviderResourceDelete = ProviderResourceEvent("delete")
)

Types

type ActiveHostname

type ActiveHostname struct {
	ID       mtypes.LeaseID
	Hostname string
}

type ConnectHostnameToDeploymentDirective

type ConnectHostnameToDeploymentDirective struct {
	Hostname    string
	LeaseID     mtypes.LeaseID
	ServiceName string
	ServicePort int32
	ReadTimeout uint32
	SendTimeout uint32
	NextTimeout uint32
	MaxBodySize uint32
	NextTries   uint32
	NextCases   []string
}

type Deployment

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

Deployment interface defined with LeaseID and ManifestGroup methods

type EventsWatcher

type EventsWatcher interface {
	Shutdown()
	Done() <-chan struct{}
	ResultChan() <-chan *eventsv1.Event
	SendEvent(*eventsv1.Event) bool
}

EventsWatcher

func NewEventsFeed

func NewEventsFeed(ctx context.Context) EventsWatcher

type ExecResult

type ExecResult interface {
	ExitCode() int
}

type ForwardedPortStatus

type ForwardedPortStatus struct {
	Host         string                   `json:"host,omitempty"`
	Port         uint16                   `json:"port"`
	ExternalPort uint16                   `json:"externalPort"`
	Proto        manifest.ServiceProtocol `json:"proto"`
	Available    int32                    `json:"available"`
	Name         string                   `json:"name"`
}

type HostnameResourceEvent

type HostnameResourceEvent interface {
	GetLeaseID() mtypes.LeaseID
	GetEventType() ProviderResourceEvent
	GetHostname() string
	GetServiceName() string
	GetExternalPort() uint32
}

type HostnameServiceClient

type HostnameServiceClient interface {
	ReserveHostnames(ctx context.Context, hostnames []string, leaseID mtypes.LeaseID) ([]string, error)
	ReleaseHostnames(leaseID mtypes.LeaseID) error
	CanReserveHostnames(hostnames []string, ownerAddr sdktypes.Address) error
	PrepareHostnamesForTransfer(ctx context.Context, hostnames []string, leaseID mtypes.LeaseID) error
}

type InventoryStatus

type InventoryStatus struct {
	Active    []atypes.ResourceUnits `json:"active"`
	Pending   []atypes.ResourceUnits `json:"pending"`
	Available []atypes.ResourceUnits `json:"available"`
	Error     error                  `json:"error"`
}

InventoryStatus stores active, pending and available units

type LeaseEvent

type LeaseEvent struct {
	Type                string           `json:"type" yaml:"type"`
	ReportingController string           `json:"reportingController,omitempty" yaml:"reportingController"`
	ReportingInstance   string           `json:"reportingInstance,omitempty" yaml:"reportingInstance"`
	Reason              string           `json:"reason" yaml:"reason"`
	Note                string           `json:"note" yaml:"note"`
	Object              LeaseEventObject `json:"object" yaml:"object"`
}

type LeaseEventObject

type LeaseEventObject struct {
	Kind      string `json:"kind" yaml:"kind"`
	Namespace string `json:"namespace" yaml:"namespace"`
	Name      string `json:"name" yaml:"name"`
}

type LeaseIDHostnameConnection

type LeaseIDHostnameConnection interface {
	GetLeaseID() mtypes.LeaseID
	GetHostname() string
	GetExternalPort() int32
	GetServiceName() string
}

type LeaseStatus

type LeaseStatus struct {
	Services       map[string]*ServiceStatus        `json:"services"`
	ForwardedPorts map[string][]ForwardedPortStatus `json:"forwarded_ports"` // Container services that are externally accessible
}

LeaseStatus includes list of services with their status

type Node

type Node interface {
	ID() string
	Available() atypes.ResourceUnits
	Allocateable() atypes.ResourceUnits
	Reserve(atypes.ResourceUnits) error
}

Node interface predefined with ID and Available methods

type ProviderResourceEvent

type ProviderResourceEvent string

type Reservation

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

Reservation interface implements orders and resources

type ServiceLog

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

ServiceLog stores name, stream and scanner

type ServiceStatus

type ServiceStatus struct {
	Name      string   `json:"name"`
	Available int32    `json:"available"`
	Total     int32    `json:"total"`
	URIs      []string `json:"uris"`

	ObservedGeneration int64 `json:"observed_generation"`
	Replicas           int32 `json:"replicas"`
	UpdatedReplicas    int32 `json:"updated_replicas"`
	ReadyReplicas      int32 `json:"ready_replicas"`
	AvailableReplicas  int32 `json:"available_replicas"`
}

ServiceStatus stores the current status of service

type Status

type Status struct {
	Leases    uint32          `json:"leases"`
	Inventory InventoryStatus `json:"inventory"`
}

Status stores current leases and inventory statuses