meshdb

package
v0.2.5 Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package meshdb contains the schemas, generated code, and interfaces for interacting with the mesh database.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsReservedPrefix added in v0.2.0

func IsReservedPrefix(key string) bool

IsReservedPrefix returns true if the given key is reserved.

Types

type Store

type Store interface {
	// ID returns the ID of the node.
	ID() string
	// Domain returns the domain of the mesh network.
	Domain() string
	// Leader returns the current Raft leader.
	Leader() (string, error)
	// Storage returns a storage interface for use by the application.
	Storage() storage.Storage
	// Raft returns the underlying Raft database.
	Raft() raft.Raft
	// Plugins returns the plugins for the current node.
	Plugins() plugins.Manager
	// Network returns the Network manager.
	Network() net.Manager
	// Dial opens a new gRPC connection to the given node.
	Dial(ctx context.Context, nodeID string) (*grpc.ClientConn, error)
	// DialLeader opens a new gRPC connection to the current Raft leader.
	DialLeader(ctx context.Context) (*grpc.ClientConn, error)
}

Store is the interface for interacting with the mesh database and network. It is a reduced version of the mesh.Mesh interface. This interface should eventually go away.

Directories

Path Synopsis
Package networking contains interfaces to the database models for Network ACLs and Routes.
Package networking contains interfaces to the database models for Network ACLs and Routes.
Package peers contains an interface for managing nodes in the mesh.
Package peers contains an interface for managing nodes in the mesh.
Package raftlogs provides facilities for applying raft logs to a database.
Package raftlogs provides facilities for applying raft logs to a database.
Package rbac contains interfaces to the database models for RBAC.
Package rbac contains interfaces to the database models for RBAC.
Package snapshots provides an interface for managing raft snapshots.
Package snapshots provides an interface for managing raft snapshots.
Package state provides an interface for querying mesh state.
Package state provides an interface for querying mesh state.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL