micro/runtime/runtime.go

128 lines
2.8 KiB
Go
Raw Normal View History

2019-09-14 07:33:14 +03:00
// Package runtime is a service runtime manager
package runtime
2020-01-18 05:13:24 +03:00
import (
"errors"
"time"
"github.com/unistack-org/micro/v3/metadata"
2020-01-18 05:13:24 +03:00
)
var (
// ErrAlreadyExists error
2020-01-18 05:13:24 +03:00
ErrAlreadyExists = errors.New("already exists")
)
2019-09-14 07:33:14 +03:00
// Runtime is a service runtime manager
type Runtime interface {
// Init initializes runtime
Init(...Option) error
// Create registers a service
2019-09-24 20:32:35 +03:00
Create(*Service, ...CreateOption) error
// Read returns the service
2019-11-29 14:35:00 +03:00
Read(...ReadOption) ([]*Service, error)
2019-10-29 15:29:21 +03:00
// Update the service in place
Update(*Service, ...UpdateOption) error
// Remove a service
Delete(*Service, ...DeleteOption) error
2020-04-13 01:41:21 +03:00
// Logs returns the logs for a service
2020-08-12 00:57:30 +03:00
Logs(*Service, ...LogsOption) (Logs, error)
// Start starts the runtime
Start() error
// Stop shuts down the runtime
2019-09-14 07:33:14 +03:00
Stop() error
2020-04-13 01:41:21 +03:00
// String describes runtime
String() string
}
2020-08-12 00:57:30 +03:00
// Logs returns a log stream
type Logs interface {
// Error returns error
Error() error
// Chan return chan log
2020-08-12 00:57:30 +03:00
Chan() chan Log
// Stop stops the log stream
Stop() error
}
2020-08-12 00:57:30 +03:00
// Log is a log message
type Log struct {
// Metadata holds metadata
Metadata metadata.Metadata
// Message holds the message
Message string
2019-09-14 07:33:14 +03:00
}
2020-01-16 16:34:04 +03:00
// Scheduler is a runtime service scheduler
type Scheduler interface {
// Notify publishes schedule events
Notify() (<-chan Event, error)
2020-01-16 16:34:04 +03:00
// Close stops the scheduler
Close() error
2019-09-14 07:33:14 +03:00
}
2020-01-16 16:34:04 +03:00
// EventType defines schedule event
type EventType int
const (
// Create is emitted when a new build has been craeted
Create EventType = iota
// Update is emitted when a new update become available
Update
// Delete is emitted when a build has been deleted
Delete
)
2019-10-29 15:29:21 +03:00
// String returns human readable event type
func (t EventType) String() string {
switch t {
case Create:
return "create"
case Delete:
return "delete"
case Update:
return "update"
default:
return "unknown"
}
2019-10-29 15:29:21 +03:00
}
// Event is notification event
type Event struct {
// Timestamp of event
Timestamp time.Time
2020-05-19 12:14:07 +03:00
// Service the event relates to
Service *Service
// Options to use when processing the event
Options *CreateOptions
// ID of the event
ID string
// Type is event type
Type EventType
2019-09-14 07:33:14 +03:00
}
// Service is runtime service
type Service struct {
// Metadata stores metadata
Metadata metadata.Metadata
// Name of the service
Name string
2019-11-24 01:50:13 +03:00
// Version of the service
Version string
// Name of the service
Source string
2019-09-14 07:33:14 +03:00
}
// Resources which are allocated to a serivce
type Resources struct {
// CPU is the maximum amount of CPU the service will be allocated (unit millicpu)
// e.g. 0.25CPU would be passed as 250
CPU int
// Mem is the maximum amount of memory the service will be allocated (unit mebibyte)
// e.g. 128 MiB of memory would be passed as 128
Mem int
// Disk is the maximum amount of disk space the service will be allocated (unit mebibyte)
// e.g. 128 MiB of memory would be passed as 128
Disk int
}