runtime

package
Version: v1.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 8, 2019 License: Apache-2.0 Imports: 8 Imported by: 22

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateOption

type CreateOption func(o *CreateOptions)

func WithCommand

func WithCommand(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
	// Type of service to create
	Type string
}

CreateOptions configure runtime services

type Event added in v1.15.0

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 added in v1.15.0

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 added in v1.15.0

func (t EventType) String() string

String returns human readable event type

type Notifier added in v1.15.0

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

Notifier is an update notifier

type Option added in v1.15.0

type Option func(o *Options)

func WithNotifier added in v1.15.0

func WithNotifier(n Notifier) Option

WithNotifier specifies a notifier for updates

func WithType added in v1.18.0

func WithType(t string) Option

WithType sets the service type to manage

type Options added in v1.15.0

type Options struct {
	// Notifier for updates
	Notifier Notifier
	// Service type to manage
	Type string
}

Options configure runtime

type ReadOption added in v1.17.0

type ReadOption func(o *ReadOptions)

func ReadService added in v1.18.0

func ReadService(service string) ReadOption

ReadService returns services with the given name

func ReadType added in v1.18.0

func ReadType(t string) ReadOption

ReadType returns services of the given type

func ReadVersion added in v1.18.0

func ReadVersion(version string) ReadOption

WithVersion confifgures service version

type ReadOptions added in v1.17.0

type ReadOptions struct {
	// Service name
	Service string
	// Version queries services with given version
	Version string
	// Type of service
	Type string
}

ReadOptions queries runtime services

type Runtime

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

Runtime is a service runtime manager

var (
	// DefaultRuntime is default micro runtime
	DefaultRuntime Runtime = NewRuntime()
	// DefaultName is default runtime service name
	DefaultName = "go.micro.runtime"
)

func NewRuntime added in v1.15.0

func NewRuntime(opts ...Option) Runtime

NewRuntime creates new local runtime and returns it

type Service

type Service struct {
	// Name of the service
	Name string
	// Version of the service
	Version string
	// url location of source
	Source string
	// Metadata stores metadata
	Metadata map[string]string
}

Service is runtime service

Directories

Path Synopsis
Package build builds a micro runtime package
Package build builds a micro runtime package
docker
Package docker builds docker images
Package docker builds docker images
go
Package golang is a go package manager
Package golang is a go package manager
Package kubernetes implements kubernetes micro runtime
Package kubernetes implements kubernetes micro runtime
client
Package client provides an implementation of a restricted subset of kubernetes API client
Package client provides an implementation of a restricted subset of kubernetes API client
Package process executes a binary
Package process executes a binary
os
Package os runs processes locally Package os runs processes locally
Package os runs processes locally Package os runs processes locally
Package source retrieves source code
Package source retrieves source code
git
Package git provides a git source
Package git provides a git source
go
Package golang is a source for Go
Package golang is a source for Go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL