runtime

README

Runtime

A runtime for self governing services.

Overview

In recent years we've started to develop complex architectures for the pipeline between writing code and running it. This philosophy of build, run, manage or however many variations, has created a number of layers of abstraction that make it all the more difficult to run code.

Runtime manages the lifecycle of a service from source to running process. If the source is the source of truth then everything in between running is wasted breath. Applications should be self governing and self sustaining. To enable that we need libraries which make it possible.

Runtime will fetch source code, build a binary and execute it. Any Go program that uses this library should be able to run dependencies or itself with ease, with the ability to update itself as the source is updated.

Features

• Source - Fetches source whether it be git, go, docker, etc
• Package - Compiles the source into a binary which can be executed
• Process - Executes a binary and creates a running process

Usage

TODO

Documentation

Overview

Package runtime is a service runtime manager

Index

• type CreateOption
  • func WithCommand(c string, args ...string) CreateOption
  • func WithEnv(env []string) CreateOption
  • func WithOutput(out io.Writer) CreateOption
• type CreateOptions
• type Event
• type EventType
  • func (t EventType) String() string
• type Notifier
• type Option
  • func WithNotifier(n Notifier) Option
• type Options
• type Runtime
  • func NewRuntime(opts ...Option) Runtime
• type Service

Types

type CreateOption

type CreateOption func(o *CreateOptions)

func WithCommand

func WithCommand(c string, args ...string) CreateOption

WithCommand specifies the command to execute

func WithEnv

func WithEnv(env []string) CreateOption

WithEnv sets the created service environment

func WithOutput

func WithOutput(out io.Writer) CreateOption

WithOutput sets the arg output

type CreateOptions

type CreateOptions struct {
	// command to execute including args
	Command []string
	// Environment to configure
	Env []string
	// Log output
	Output io.Writer
}

CreateOptions configure runtime services

type Event

type Event struct {
	// Type is event type
	Type EventType
	// Timestamp is event timestamp
	Timestamp time.Time
	// Service is the name of the service
	Service string
	// Version of the build
	Version string
}

Event is notification event

type EventType

type EventType int

EventType defines notification event

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
)

func (EventType) String

func (t EventType) String() string

String returns human readable event type

type Notifier

type Notifier interface {
	// Notify publishes notification events
	Notify() (<-chan Event, error)
	// Close stops the notifier
	Close() error
}

Notifier is an update notifier

type Option

type Option func(o *Options)

func WithNotifier

func WithNotifier(n Notifier) Option

AutoUpdate enables micro auto-updates

type Options

type Options struct {
	// Notifier for updates
	Notifier Notifier
}

Options configure runtime

type Runtime

type Runtime interface {
	// Init initializes runtime
	Init(...Option) error
	// Registers a service
	Create(*Service, ...CreateOption) error
	// Remove a service
	Delete(*Service) error
	// Update the service in place
	Update(*Service) error
	// List the managed services
	List() ([]*Service, error)
	// starts the runtime
	Start() error
	// Shutdown the runtime
	Stop() error
}

Runtime is a service runtime manager

var (
	// DefaultRuntime is default micro runtime
	DefaultRuntime Runtime = NewRuntime()
)

func NewRuntime

func NewRuntime(opts ...Option) Runtime

NewRuntime creates new local runtime and returns it

type Service

type Service struct {
	// Name of the service
	Name string
	// url location of source
	Source string
	// Path to store source
	Path string
	// Exec command
	Exec string
	// Version of the service
	Version string
}

Service is runtime service