storagenode

Documentation

Index

• Variables
• func DBModule(ball *mud.Ball)
• func Module(ball *mud.Ball)
• type Config
  • func (config *Config) DatabaseConfig() storagenodedb.Config
  • func (config *Config) Verify(log *zap.Logger) error
• type DB
  • func NewDB(ctx context.Context, log *zap.Logger, config storagenodedb.Config) (DB, error)
• type EndpointRegistration
• type HttpFallbackHandler
• type Peer
  • func New(log *zap.Logger, full *identity.FullIdentity, db DB, ...) (*Peer, error)
  • func (peer *Peer) Addr() string
  • func (peer *Peer) Close() error
  • func (peer *Peer) ID() storj.NodeID
  • func (peer *Peer) PrivateAddr() string
  • func (peer *Peer) Run(ctx context.Context) (err error)
  • func (peer *Peer) URL() storj.NodeURL
• type RawBlobs

Variables

var Assets fs.FS = emptyfs.FS{}

Assets contains either the built admin/back-office/ui or it is nil.

Functions

func DBModule

func DBModule(ball *mud.Ball)

DBModule is a mud Module, defining how to get DB components.

func Module

func Module(ball *mud.Ball)

Module is a mud Module (definition of the creation of the components).

Types

type Config

type Config struct {
	Identity identity.Config

	Server server.Config
	Debug  debug.Config

	Preflight preflight.Config
	Contact   contact.Config
	Operator  operator.Config

	// TODO: flatten storage config and only keep the new one
	Storage   piecestore.OldConfig
	Storage2  piecestore.Config
	Collector collector.Config

	Filestore filestore.Config

	Pieces pieces.Config

	Retain retain.Config

	Nodestats nodestats.Config

	Reputation reputation.Config

	Console consoleserver.Config

	Healthcheck healthcheck.Config

	Version snVersion.Config

	Bandwidth bandwidth.Config

	GracefulExit gracefulexit.Config

	ForgetSatellite forgetsatellite.Config
}

Config is all the configuration parameters for a Storage Node.

func (*Config) DatabaseConfig

func (config *Config) DatabaseConfig() storagenodedb.Config

DatabaseConfig returns the storagenodedb.Config that should be used with this Config.

func (*Config) Verify

func (config *Config) Verify(log *zap.Logger) error

Verify verifies whether configuration is consistent and acceptable.

type DB

type DB interface {
	// Config returns the configuration used to initialize the database.
	Config() storagenodedb.Config

	// MigrateToLatest initializes the database
	MigrateToLatest(ctx context.Context) error

	// Close closes the database
	Close() error

	Pieces() blobstore.Blobs

	Orders() orders.DB
	V0PieceInfo() pieces.V0PieceInfoDB
	PieceExpirationDB() pieces.PieceExpirationDB
	PieceSpaceUsedDB() pieces.PieceSpaceUsedDB
	Bandwidth() bandwidth.DB
	Reputation() reputation.DB
	StorageUsage() storageusage.DB
	Satellites() satellites.DB
	Notifications() notifications.DB
	Payout() payouts.DB
	Pricing() pricing.DB
	APIKeys() apikeys.DB
	GCFilewalkerProgress() pieces.GCFilewalkerProgressDB
	UsedSpacePerPrefix() pieces.UsedSpacePerPrefixDB

	Preflight(ctx context.Context) error
}

DB is the master database for Storage Node.

architecture: Master Database

func NewDB

func NewDB(ctx context.Context, log *zap.Logger, config storagenodedb.Config) (DB, error)

NewDB will create (+ test + migrate) new DB instance for storagenodes.

type EndpointRegistration

type EndpointRegistration struct{}

EndpointRegistration is a pseudo component to wire server and DRPC endpoints together.

type HttpFallbackHandler

type HttpFallbackHandler struct {
	Handler http.HandlerFunc
}

HttpFallbackHandler is an extension to the public DRPC server.

type Peer

type Peer struct {
	// core dependencies
	Log         *zap.Logger
	Identity    *identity.FullIdentity
	DB          DB
	UsedSerials *usedserials.Table
	OrdersStore *orders.FileStore

	Servers  *lifecycle.Group
	Services *lifecycle.Group

	Dialer rpc.Dialer

	Server *server.Server

	Version struct {
		Chore   *snVersion.Chore
		Service *checker.Service
	}

	Healthcheck struct {
		Service  *healthcheck.Service
		Endpoint *healthcheck.Endpoint
	}

	Debug struct {
		Listener net.Listener
		Server   *debug.Server
		Endpoint *debug.Endpoint
	}

	Preflight struct {
		LocalTime *preflight.LocalTime
	}

	Contact struct {
		Service   *contact.Service
		Chore     *contact.Chore
		Endpoint  *contact.Endpoint
		PingStats *contact.PingStats
		QUICStats *contact.QUICStats
	}

	Estimation struct {
		Service *estimatedpayouts.Service
	}

	Storage2 struct {
		// TODO: lift things outside of it to organize better
		Trust              *trust.Pool
		SpaceReport        monitor.SpaceReport
		OldPieceBackend    *piecestore.OldPieceBackend
		HashStoreBackend   *piecestore.HashStoreBackend
		MigrationState     *satstore.SatelliteStore
		MigratingBackend   *piecestore.MigratingBackend
		PieceBackend       *piecestore.TestingBackend
		Endpoint           *piecestore.Endpoint
		Inspector          *inspector.Endpoint
		Monitor            *monitor.Service
		Orders             *orders.Service
		RestoreTimeManager *retain.RestoreTimeManager
		BloomFilterManager *retain.BloomFilterManager
	}

	StorageOld struct {
		Store          *pieces.Store
		TrashChore     *pieces.TrashChore
		BlobsCache     *pieces.BlobsUsageCache
		CacheService   *pieces.CacheService
		RetainService  *retain.Service
		FileWalker     *pieces.FileWalker
		LazyFileWalker *lazyfilewalker.Supervisor
		Collector      *collector.Service
	}

	NodeStats struct {
		Service *nodestats.Service
		Cache   *nodestats.Cache
	}

	// Web server with web UI
	Console struct {
		Listener net.Listener
		Service  *console.Service
		Endpoint *consoleserver.Server
	}

	GracefulExit struct {
		Service      *gracefulexit.Service
		Endpoint     *gracefulexit.Endpoint
		Chore        *gracefulexit.Chore
		BlobsCleaner *gracefulexit.BlobsCleaner
	}

	ForgetSatellite struct {
		Endpoint *forgetsatellite.Endpoint
		Chore    *forgetsatellite.Chore
		Cleaner  *forgetsatellite.Cleaner
	}

	Notifications struct {
		Service *notifications.Service
	}

	Payout struct {
		Service  *payouts.Service
		Endpoint *payouts.Endpoint
	}

	Bandwidth struct {
		Service *bandwidth.Service
		Cache   *bandwidth.Cache
	}

	Reputation struct {
		Service *reputation.Service
		Chore   *reputation.Chore
	}

	Multinode struct {
		Storage   *multinode.StorageEndpoint
		Bandwidth *multinode.BandwidthEndpoint
		Node      *multinode.NodeEndpoint
		Payout    *multinode.PayoutEndpoint
	}
}

Peer is the representation of a Storage Node.

architecture: Peer

func New

func New(log *zap.Logger, full *identity.FullIdentity, db DB, revocationDB extensions.RevocationDB, config Config, versionInfo version.Info, atomicLogLevel *zap.AtomicLevel) (*Peer, error)

New creates a new Storage Node.

func (*Peer) Addr

func (peer *Peer) Addr() string

Addr returns the public address.

func (*Peer) Close

func (peer *Peer) Close() error

Close closes all the resources.

func (*Peer) ID

func (peer *Peer) ID() storj.NodeID

ID returns the peer ID.

func (*Peer) PrivateAddr

func (peer *Peer) PrivateAddr() string

PrivateAddr returns the private address.

func (*Peer) Run

func (peer *Peer) Run(ctx context.Context) (err error)

Run runs storage node until it's either closed or it errors.

func (*Peer) URL

func (peer *Peer) URL() storj.NodeURL

URL returns the storj.NodeURL.

type RawBlobs

type RawBlobs interface {
	blobstore.Blobs
}

RawBlobs is an interface to save the original blob implementation to mud. Can be used as an implementation or wrapped by cached.