control

package
v0.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 31, 2022 License: GPL-3.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SignMessage 

func SignMessage(key *ecdsa.PrivateKey, msg SignedMessage) error

SignMessage signs Control service message with private key.

Types

type HealthChecker 

type HealthChecker interface {
	// Must calculate and return current status of the node in NeoFS network map.
	//
	// If status can not be calculated for any reason,
	// control.netmapStatus_STATUS_UNDEFINED should be returned.
	NetmapStatus() control.NetmapStatus

	// Must calculate and return current health status of the node application.
	//
	// If status can not be calculated for any reason,
	// control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned.
	HealthStatus() control.HealthStatus
}

HealthChecker is component interface for calculating the current health status of a node.

type NodeState 

type NodeState interface {
	// SetNetmapStatus switches the storage node to the given network status.
	//
	// If status is control.NetmapStatus_MAINTENANCE and maintenance is allowed
	// in the network settings, the node additionally starts local maintenance.
	SetNetmapStatus(st control.NetmapStatus) error

	// ForceMaintenance works like SetNetmapStatus(control.NetmapStatus_MAINTENANCE)
	// but starts local maintenance regardless of the network settings.
	ForceMaintenance() error
}

NodeState is an interface of storage node network state.

type Option 

type Option func(*cfg)

Option of the Server's constructor.

func WithAuthorizedKeys 

func WithAuthorizedKeys(keys [][]byte) Option

WithAuthorizedKeys returns option to add list of public keys that have rights to use Control service.

func WithContainerSource added in v0.33.0 

func WithContainerSource(cnrSrc container.Source) Option

WithContainerSource returns option to set container storage.

func WithHealthChecker 

func WithHealthChecker(hc HealthChecker) Option

WithHealthChecker returns option to set component to calculate node health status.

func WithKey 

func WithKey(key *ecdsa.PrivateKey) Option

WithKey returns option to set private key used for signing responses.

func WithLocalStorage added in v0.27.2 

func WithLocalStorage(engine *engine.StorageEngine) Option

WithLocalStorage returns option to set local storage engine that contains information about shards.

func WithNetMapSource 

func WithNetMapSource(netMapSrc netmap.Source) Option

WithNetMapSource returns option to set network map storage.

func WithNodeState 

func WithNodeState(state NodeState) Option

WithNodeState returns option to set node network state component.

func WithReplicator added in v0.33.0 

func WithReplicator(r *replicator.Replicator) Option

WithReplicator returns option to set network map storage.

func WithTreeService added in v0.30.0 

func WithTreeService(s TreeService) Option

WithTreeService returns an option to set tree service.

type Server 

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

Server is an entity that serves Control service on storage node.

func New 

func New(opts ...Option) *Server

New creates, initializes and returns new Server instance.

func (*Server) DropObjects added in v0.16.0 

func (s *Server) DropObjects(_ context.Context, req *control.DropObjectsRequest) (*control.DropObjectsResponse, error)

DropObjects marks objects to be removed from the local node.

Objects are marked via garbage collector's callback.

If some address is not a valid object address in a binary format, an error returns. If request is unsigned or signed by disallowed key, permission error returns.

func (*Server) DumpShard added in v0.27.5 

func (s *Server) DumpShard(_ context.Context, req *control.DumpShardRequest) (*control.DumpShardResponse, error)

func (*Server) EvacuateShard added in v0.33.0 

func (s *Server) EvacuateShard(_ context.Context, req *control.EvacuateShardRequest) (*control.EvacuateShardResponse, error)

func (*Server) FlushCache added in v0.33.0 

func (s *Server) FlushCache(_ context.Context, req *control.FlushCacheRequest) (*control.FlushCacheResponse, error)

func (*Server) HealthCheck 

func (s *Server) HealthCheck(_ context.Context, req *control.HealthCheckRequest) (*control.HealthCheckResponse, error)

HealthCheck returns health status of the local node.

If request is unsigned or signed by disallowed key, permission error returns.

func (*Server) ListShards added in v0.27.2 

func (s *Server) ListShards(_ context.Context, req *control.ListShardsRequest) (*control.ListShardsResponse, error)

func (*Server) RestoreShard added in v0.27.5 

func (s *Server) RestoreShard(_ context.Context, req *control.RestoreShardRequest) (*control.RestoreShardResponse, error)

func (*Server) SetNetmapStatus 

func (s *Server) SetNetmapStatus(ctx context.Context, req *control.SetNetmapStatusRequest) (*control.SetNetmapStatusResponse, error)

SetNetmapStatus sets node status in NeoFS network.

If request is unsigned or signed by disallowed key, permission error returns.

func (*Server) SetShardMode added in v0.27.3 

func (s *Server) SetShardMode(_ context.Context, req *control.SetShardModeRequest) (*control.SetShardModeResponse, error)

func (*Server) SynchronizeTree added in v0.30.0 

func (s *Server) SynchronizeTree(ctx context.Context, req *control.SynchronizeTreeRequest) (*control.SynchronizeTreeResponse, error)

type SignedMessage 

type SignedMessage interface {
	ReadSignedData([]byte) ([]byte, error)
	GetSignature() *control.Signature
	SetSignature(*control.Signature)
}

SignedMessage is an interface of Control service message.

type TreeService added in v0.30.0 

type TreeService interface {
	Synchronize(ctx context.Context, cnr cid.ID, treeID string) error
}

TreeService represents a tree service instance.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.