core

README

Open Integration - a pipeline execution engine

stop using YAMLs

This is not production ready stuff

Until the project has not reached version > 1.x.x it may have breaking changes in the API, please use the latest version before opening issue.

Concepts

• A compiled, binray pipeline

• State - the engine holds the state of all the tasks

• Service - a standalone binary exposing API over http2 (gRPC) that the engine can trigger, called endpoint.

• Task - a request from a service to run some logic.

• Endpoint of a service defined by 2 files of JSON schema, arguments.json and returns.json, the engine will enforce the arguments given by a task and the output created to match the schema.

Example

• JIRA
• Trello

Documentation

Index

• func ConditionEngineStarted(ev state.Event, s state.State) bool
• func ConditionTaskFinishedWithStatus(task string, status string) func(ev state.Event, s state.State) bool
• type Argument
  • func (a *Argument) GetKey() string
  • func (a *Argument) GetValue() interface{}
• type Engine
  • func NewEngine(opt *EngineOptions) Engine
• type EngineKubernetesOptions
• type EngineOptions
• type EventReaction
• type Pipeline
• type PipelineMetadata
• type PipelineSpec
• type Service
• type Task
• type TaskMetadata
• type TaskSpec

Functions

func ConditionEngineStarted

func ConditionEngineStarted(ev state.Event, s state.State) bool

ConditionEngineStarted returns true once the engine emits started event

func ConditionTaskFinishedWithStatus

func ConditionTaskFinishedWithStatus(task string, status string) func(ev state.Event, s state.State) bool

ConditionTaskFinishedWithStatus returns true once a task is finished with given status

Types

type Argument

type Argument struct {
	Key   string
	Value interface{}
	// Func returns a dynamic Value instead of Argument.Values
	Func func() interface{}
}

Argument is key value struct that should be passed in a service call

func (*Argument) GetKey

func (a *Argument) GetKey() string

func (*Argument) GetValue

func (a *Argument) GetValue() interface{}

type Engine

type Engine interface {
	Run() error
	Modem() modem.Modem
}

Engine exposes the interface of the engine

func NewEngine

func NewEngine(opt *EngineOptions) Engine

NewEngine create new engine

type EngineKubernetesOptions

type EngineKubernetesOptions struct {
	Path      string
	Context   string
	Namespace string
	InCluster bool
}

EngineKubernetesOptions when running service on kubernetes cluster

type EngineOptions

type EngineOptions struct {
	Pipeline Pipeline
	// LogsDirectory path where to store logs
	LogsDirectory string
	Kubeconfig    *EngineKubernetesOptions
	Logger        logger.Logger
}

EngineOptions to create new engine

type EventReaction

type EventReaction struct {
	Condition func(ev state.Event, state state.State) bool
	Reaction  func(ev state.Event, state state.State) []Task
}

EventReaction is a binding of an event to a function that builds tasks

type Pipeline

type Pipeline struct {
	Metadata PipelineMetadata
	Spec     PipelineSpec
}

Pipeline is the pipeline representation

type PipelineMetadata

type PipelineMetadata struct {
	Name         string
	OS           string
	Architecture string
}

PipelineMetadata holds all the metadata of a pipeline

type PipelineSpec

type PipelineSpec struct {
	Reactions []EventReaction
	Services  []Service
}

PipelineSpec is the spec of a pipeline

type Service

type Service struct {
	// Name is official service which is part of the service catalog (https://github.com/open-integration/core-services/releases)
	Name string
	// Version of the service, empty string will use the latest version from catalog
	Version string
	// Path a location of the local fs the service can be found, Path cannot be set with Name together
	Path string
	// As alias name to refer the service as part of the task implementation
	As string
}

Service is a Service a pipeline should execute

type Task

type Task struct {
	Metadata TaskMetadata
	Spec     TaskSpec
}

Task is a task a pipeline should execute

type TaskMetadata

type TaskMetadata struct {
	Name string
}

TaskMetadata holds all the metadata of a pipeline

type TaskSpec

type TaskSpec struct {
	Service   string
	Endpoint  string
	Arguments []Argument
}

TaskSpec is the spec of a task