nodes

Documentation

Index

• Variables
• type DB
• type Node
• type NodeInfo
• type NodeInfoSatellite
• type Service
  • func NewService(log *zap.Logger, dialer rpc.Dialer, nodes DB) *Service
  • func (service *Service) Add(ctx context.Context, id storj.NodeID, apiSecret []byte, publicAddress string) (err error)
  • func (service *Service) Get(ctx context.Context, id storj.NodeID) (_ Node, err error)
  • func (service *Service) List(ctx context.Context) (_ []Node, err error)
  • func (service *Service) ListInfos(ctx context.Context) (_ []NodeInfo, err error)
  • func (service *Service) ListInfosSatellite(ctx context.Context, satelliteID storj.NodeID) (_ []NodeInfoSatellite, err error)
  • func (service *Service) Remove(ctx context.Context, id storj.NodeID) (err error)
  • func (service *Service) UpdateName(ctx context.Context, id storj.NodeID, name string) (err error)

Variables

var ErrNoNode = errs.Class("no such node")

ErrNoNode is a special error type that indicates about absence of node in NodesDB.

var (

	// Error is an error class for nodes service error.
	Error = errs.Class("nodes service error")
)

Types

type DB

type DB interface {
	// Get return node from NodesDB by its id.
	Get(ctx context.Context, id storj.NodeID) (Node, error)
	// List returns all connected nodes.
	List(ctx context.Context) ([]Node, error)
	// Add creates new node in NodesDB.
	Add(ctx context.Context, id storj.NodeID, apiSecret []byte, publicAddress string) error
	// Remove removed node from NodesDB.
	Remove(ctx context.Context, id storj.NodeID) error
	// UpdateName will update name of the specified node in database.
	UpdateName(ctx context.Context, id storj.NodeID, name string) error
}

DB exposes needed by MND NodesDB functionality.

architecture: Database

type Node

type Node struct {
	ID storj.NodeID
	// APISecret is a secret issued by storagenode, that will be main auth mechanism in MND <-> SNO api.
	APISecret     []byte
	PublicAddress string
	Name          string
}

Node is a representation of storagenode, that SNO could add to the Multinode Dashboard.

type NodeInfo

type NodeInfo struct {
	ID            storj.NodeID
	Name          string
	Version       string
	LastContact   time.Time
	DiskSpaceUsed int64
	DiskSpaceLeft int64
	BandwidthUsed int64
}

NodeInfo contains basic node internal state.

type NodeInfoSatellite

type NodeInfoSatellite struct {
	ID              storj.NodeID
	Name            string
	Version         string
	LastContact     time.Time
	OnlineScore     float64
	AuditScore      float64
	SuspensionScore float64
}

NodeInfoSatellite contains satellite specific node internal state.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service exposes all nodes related logic.

architecture: Service

func NewService

func NewService(log *zap.Logger, dialer rpc.Dialer, nodes DB) *Service

NewService creates new instance of Service.

func (*Service) Add

func (service *Service) Add(ctx context.Context, id storj.NodeID, apiSecret []byte, publicAddress string) (err error)

Add adds new node to the system.

func (*Service) Get

func (service *Service) Get(ctx context.Context, id storj.NodeID) (_ Node, err error)

Get retrieves node by id.

func (*Service) List

func (service *Service) List(ctx context.Context) (_ []Node, err error)

List retrieves list of all added nodes.

func (*Service) ListInfos

func (service *Service) ListInfos(ctx context.Context) (_ []NodeInfo, err error)

ListInfos queries node basic info from all nodes via rpc.

func (*Service) ListInfosSatellite

func (service *Service) ListInfosSatellite(ctx context.Context, satelliteID storj.NodeID) (_ []NodeInfoSatellite, err error)

ListInfosSatellite queries node satellite specific info from all nodes via rpc.

func (*Service) Remove

func (service *Service) Remove(ctx context.Context, id storj.NodeID) (err error)

Remove removes node from the system.

func (*Service) UpdateName

func (service *Service) UpdateName(ctx context.Context, id storj.NodeID, name string) (err error)

UpdateName will update name of the specified node.