Nexus: Index | Files

package orchestrator

import ""

Package orchestrator manages network node operations and database interactions


Package Files

database.go doc.go orchestrator.go util.go

type NetworkDetails Uses

type NetworkDetails struct {
    NetworkID string
    PeerID    string
    SwarmPort string
    SwarmKey  string

NetworkDetails provides information about an instantiated network

type NetworkDiagnostics Uses

type NetworkDiagnostics struct {

NetworkDiagnostics describe detailed statistics and information about a node

type NetworkStatus Uses

type NetworkStatus struct {
    Uptime    time.Duration
    DiskUsage int64

NetworkStatus denotes high-level details about requested network, intended for consumer use

type Orchestrator Uses

type Orchestrator struct {
    Registry *registry.NodeRegistry
    // contains filtered or unexported fields

Orchestrator contains most primary application logic and manages node availability

func New Uses

func New(logger *zap.SugaredLogger, address string, ports config.Ports, dev bool,
    c ipfs.NodeClient, networks temporal.PrivateNetworks) (*Orchestrator, error)

New instantiates and bootstraps a new Orchestrator

func (*Orchestrator) NetworkDiagnostics Uses

func (o *Orchestrator) NetworkDiagnostics(ctx context.Context, network string) (NetworkDiagnostics, error)

NetworkDiagnostics retrieves detailed statistics and information about a node

func (*Orchestrator) NetworkDown Uses

func (o *Orchestrator) NetworkDown(ctx context.Context, network string) error

NetworkDown brings a network offline

func (*Orchestrator) NetworkRemove Uses

func (o *Orchestrator) NetworkRemove(ctx context.Context, network string) error

NetworkRemove removes network assets

func (*Orchestrator) NetworkStatus Uses

func (o *Orchestrator) NetworkStatus(ctx context.Context, network string) (NetworkStatus, error)

NetworkStatus retrieves the status of the node for the given status

func (*Orchestrator) NetworkUp Uses

func (o *Orchestrator) NetworkUp(ctx context.Context, network string) (NetworkDetails, error)

NetworkUp intializes a node for given network

func (*Orchestrator) NetworkUpdate Uses

func (o *Orchestrator) NetworkUpdate(ctx context.Context, network string) error

NetworkUpdate updates given network's configuration from database

func (*Orchestrator) Run Uses

func (o *Orchestrator) Run(ctx context.Context) error

Run initializes the orchestrator's background tasks. Cancelling the context will end the tasks and release the orchestrator's resources.

Package orchestrator imports 14 packages (graph) and is imported by 3 packages. Updated 2019-04-26. Refresh now. Tools for package owners.