store

package

v1.21.0-pre.4 Latest Latest Go to latest Published: Nov 2, 2026 License: Apache-2.0 Imports: 13 Imported by: 30

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cilium/cilium

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ClusterIDValidator(clusterID *uint32) nodeValidator
func ClusterNameValidator(clusterName string) nodeValidator
func NameValidator() nodeValidator
func ValidatingKeyCreator(validators ...nodeValidator) store.KeyCreator
type NodeObserver
- func NewNodeObserver(db *statedb.DB, manager NodeWriter, source source.Source) *NodeObserver
- func (o *NodeObserver) OnDelete(k store.NamedKey)
- func (o *NodeObserver) OnUpdate(k store.Key)
type NodeRegistrar
- func (nr *NodeRegistrar) RegisterNode(ctx context.Context, logger *slog.Logger, client kvstore.Client, ...) error
- func (nr *NodeRegistrar) UpdateLocalKeySync(ctx context.Context, n *nodeTypes.Node) error
type NodeWriter
type ValidatingNode
- func (vn *ValidatingNode) Unmarshal(key string, data []byte) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// NodeStorePrefix is the kvstore prefix of the shared store
	//
	// WARNING - STABLE API: Changing the structure or values of this will
	// break backwards compatibility
	NodeStorePrefix = kvstore.JoinKey(kvstore.BaseKeyPrefix, "state", "nodes", "v1")

	// KeyCreator creates a node for a shared store
	KeyCreator = func() store.Key {
		n := nodeTypes.Node{}
		return &n
	}
)

Functions ¶

func ClusterIDValidator ¶ added in v1.16.0

func ClusterIDValidator(clusterID *uint32) nodeValidator

ClusterIDValidator returns a validator enforcing that the cluster ID of the unmarshaled node matches the provided one. The access to the provided clusterID value is not synchronized, and it shall not be mutated concurrently.

func ClusterNameValidator ¶ added in v1.16.0

func ClusterNameValidator(clusterName string) nodeValidator

ClusterNameValidator returns a validator enforcing that the cluster field of the unmarshaled node matches the provided one.

func NameValidator ¶ added in v1.16.0

func NameValidator() nodeValidator

NameValidator returns a validator enforcing that the name of the the unmarshaled node matches the kvstore key.

func ValidatingKeyCreator ¶ added in v1.16.0

func ValidatingKeyCreator(validators ...nodeValidator) store.KeyCreator

ValidatingKeyCreator returns a store.KeyCreator for Nodes, configuring the specified extra validators.

Types ¶

type NodeObserver ¶

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

NodeObserver implements the store.Observer interface and delegates update and deletion events to the node object itself.

func NewNodeObserver ¶

func NewNodeObserver(db *statedb.DB, manager NodeWriter, source source.Source) *NodeObserver

func (*NodeObserver) OnDelete ¶

func (o *NodeObserver) OnDelete(k store.NamedKey)

func (*NodeObserver) OnUpdate ¶

func (o *NodeObserver) OnUpdate(k store.Key)

type NodeRegistrar ¶

type NodeRegistrar struct {
	*store.SharedStore
}

NodeRegistrar is a wrapper around store.SharedStore.

func (*NodeRegistrar) RegisterNode ¶

func (nr *NodeRegistrar) RegisterNode(ctx context.Context, logger *slog.Logger, client kvstore.Client, n *nodeTypes.Node, db *statedb.DB, writer NodeWriter) error

RegisterNode registers the local node in the cluster.

func (*NodeRegistrar) UpdateLocalKeySync ¶

func (nr *NodeRegistrar) UpdateLocalKeySync(ctx context.Context, n *nodeTypes.Node) error

UpdateLocalKeySync synchronizes the local key for the node using the SharedStore.

type NodeWriter ¶

type NodeWriter interface {
	Table() statedb.Table[*node.Node]
	RegisterInitializer(txn statedb.WriteTxn, name string) func(statedb.WriteTxn)
	Upsert(txn statedb.WriteTxn, n *nodeTypes.Node) bool
	Delete(txn statedb.WriteTxn, src source.Source, identity nodeTypes.Identity) bool
}

type ValidatingNode ¶ added in v1.16.0

type ValidatingNode struct {
	nodeTypes.Node
	// contains filtered or unexported fields
}

ValidatingNode wraps a Node to perform additional validation at unmarshal time.

func (*ValidatingNode) Unmarshal ¶ added in v1.16.0

func (vn *ValidatingNode) Unmarshal(key string, data []byte) error

Source Files ¶

View all Source files

store.go

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