orion

Documentation

Index

• Constants
• Variables
• func NewPlatformFactory() *platformFactory
• func Options(o *node.Options) *opts.Options
• func WithRole(role string) node.Option
• type DB
• type Identity
• type Platform
  • func Network(ctx *context.Context, id string) *Platform
  • func NewPlatform(ctx api2.Context, t api2.Topology, builder api2.Builder) *Platform
  • func (p *Platform) Cleanup()
  • func (p *Platform) CreateDBInstance() bcdb.BCDB
  • func (p *Platform) CreateUserSession(bcdb bcdb.BCDB, user string) bcdb.DBSession
  • func (p *Platform) DeleteVault(id string)
  • func (p *Platform) FSCNodeVaultDir(peer *node.Node) string
  • func (p *Platform) GenerateArtifacts()
  • func (p *Platform) GenerateConfigTree()
  • func (p *Platform) InitOrionServer()
  • func (p *Platform) Load()
  • func (p *Platform) Members() []grouper.Member
  • func (p *Platform) Name() string
  • func (p *Platform) PostRun(load bool)
  • func (p *Platform) StartOrionServer()
  • func (p *Platform) Type() string
• type Topology
  • func NewTopology() *Topology
  • func SetRemoteDB(node *node.Node) *Topology
  • func (t *Topology) AddDB(name string, roles ...string)
  • func (t *Topology) Name() string
  • func (t *Topology) SetDefaultSDK(fscTopology *fsc.Topology)
  • func (t *Topology) SetDefaultSDKOnNodes(nodes ...*node.Node)
  • func (t *Topology) SetName(name string)
  • func (t *Topology) SetSDK(fscTopology *fsc.Topology, sdk api.SDK)
  • func (t *Topology) SetSDKOnNodes(sdk api.SDK, nodes ...*node.Node)
  • func (t *Topology) Type() string

Constants

const ExtensionTemplate = `` /* 358-byte string literal not displayed */

const ServerImage = "orionbcdb/orion-server:latest"

const (
	TopologyName = "orion"
)

Variables

var RequiredImages = []string{ServerImage}

Functions

func NewPlatformFactory

func NewPlatformFactory() *platformFactory

func Options

func Options(o *node.Options) *opts.Options

func WithRole

func WithRole(role string) node.Option

Types

type DB

type DB struct {
	Name  string
	Roles []string
}

type Identity

type Identity struct {
	Name string
	Cert string
	Key  string
}

type Platform

type Platform struct {
	Context           api2.Context
	Topology          *Topology
	Builder           api2.Builder
	EventuallyTimeout time.Duration

	NetworkID string
	// contains filtered or unexported fields
}

func Network

func Network(ctx *context.Context, id string) *Platform

Network returns the orion network from the passed context bound to the passed id. It returns nil, if nothing is found

func NewPlatform

func NewPlatform(ctx api2.Context, t api2.Topology, builder api2.Builder) *Platform

func (*Platform) Cleanup

func (p *Platform) Cleanup()

func (*Platform) CreateDBInstance

func (p *Platform) CreateDBInstance() bcdb.BCDB

func (*Platform) CreateUserSession

func (p *Platform) CreateUserSession(bcdb bcdb.BCDB, user string) bcdb.DBSession

func (*Platform) DeleteVault

func (p *Platform) DeleteVault(id string)

func (*Platform) FSCNodeVaultDir

func (p *Platform) FSCNodeVaultDir(peer *node.Node) string

func (*Platform) GenerateArtifacts

func (p *Platform) GenerateArtifacts()

func (*Platform) GenerateConfigTree

func (p *Platform) GenerateConfigTree()

func (*Platform) InitOrionServer

func (p *Platform) InitOrionServer()

func (*Platform) Load

func (p *Platform) Load()

func (*Platform) Members

func (p *Platform) Members() []grouper.Member

func (*Platform) Name

func (p *Platform) Name() string

func (*Platform) PostRun

func (p *Platform) PostRun(load bool)

func (*Platform) StartOrionServer

func (p *Platform) StartOrionServer()

func (*Platform) Type

func (p *Platform) Type() string

type Topology

type Topology struct {
	TopologyName string `yaml:"name,omitempty"`
	TopologyType string `yaml:"type,omitempty"`
	DBs          []DB
}

func NewTopology

func NewTopology() *Topology

func SetRemoteDB

func SetRemoteDB(node *node.Node) *Topology

SetRemoteDB configure a new orion topology and attaches the passed node to it as persistence mechanisms

func (*Topology) AddDB

func (t *Topology) AddDB(name string, roles ...string)

func (*Topology) Name

func (t *Topology) Name() string

func (*Topology) SetDefaultSDK

func (t *Topology) SetDefaultSDK(fscTopology *fsc.Topology)

func (*Topology) SetDefaultSDKOnNodes

func (t *Topology) SetDefaultSDKOnNodes(nodes ...*node.Node)

func (*Topology) SetName

func (t *Topology) SetName(name string)

func (*Topology) SetSDK

func (t *Topology) SetSDK(fscTopology *fsc.Topology, sdk api.SDK)

func (*Topology) SetSDKOnNodes

func (t *Topology) SetSDKOnNodes(sdk api.SDK, nodes ...*node.Node)

func (*Topology) Type

func (t *Topology) Type() string