storage

Documentation

Index

• Constants
• Variables
• func BatchLoadPolicy(ctx context.Context, maxPoliciesInBatch int, ...) error
• func RegisterDriver(name string, cons Constructor)
• func Reload(ctx context.Context, rs Reloadable) error
• func TestSubscription(s Subscribable) func(*testing.T, time.Duration, ...Event)
• type BinaryStore
• type Conf
  • func GetConf() (*Conf, error)
  • func (c *Conf) Key() string
  • func (c *Conf) UnmarshalYAML(unmarshal func(any) error) error
• type Constructor
  • func GetDriverConstructor(name string) (Constructor, error)
• type Event
  • func NewPolicyEvent(kind EventKind, policyID namer.ModuleID) Event
  • func NewReloadEvent() Event
  • func NewSchemaEvent(kind EventKind, schemaFile string) Event
  • func (evt Event) String() string
• type EventKind
• type Instrumented
• type InvalidPolicyError
  • func NewInvalidPolicyError(err error, msg string, args ...any) InvalidPolicyError
  • func (ipe InvalidPolicyError) Error() string
  • func (ipe InvalidPolicyError) Unwrap() error
• type InvalidSchemaError
  • func NewInvalidSchemaError(err error, msg string, args ...any) InvalidSchemaError
  • func (ise InvalidSchemaError) Error() string
  • func (ise InvalidSchemaError) Unwrap() error
• type ListPolicyIDsParams
• type MutableStore
• type Reloadable
• type RepoStats
• type SourceStore
• type Store
  • func New(ctx context.Context) (Store, error)
  • func NewFromConf(ctx context.Context, confWrapper *config.Wrapper) (Store, error)
• type Subscribable
• type Subscriber
• type SubscriptionManager
  • func NewSubscriptionManager(ctx context.Context) *SubscriptionManager
  • func (sm *SubscriptionManager) NotifySubscribers(events ...Event)
  • func (sm *SubscriptionManager) Subscribe(s Subscriber)
  • func (sm *SubscriptionManager) Unsubscribe(s Subscriber)
• type Verifiable

Constants

const ConfKey = "storage"

const MaxPoliciesInBatch = 25

Variables

var ErrPolicyIDCollision = errors.New("policy ID collision")

Functions

func BatchLoadPolicy

func BatchLoadPolicy(
	ctx context.Context,
	maxPoliciesInBatch int,
	loadPolicyFn func(context.Context, ...string) ([]*policy.Wrapper, error),
	processPolicyFn func(*policy.Wrapper) error,
	ids ...string,
) error

func RegisterDriver

func RegisterDriver(name string, cons Constructor)

RegisterDriver registers a storage driver.

func Reload

func Reload(ctx context.Context, rs Reloadable) error

func TestSubscription

func TestSubscription(s Subscribable) func(*testing.T, time.Duration, ...Event)

TestSubscription is a helper to test subscriptions.

Types

type BinaryStore

type BinaryStore interface {
	Store
	// GetFirstMatch searches for the given module IDs in order and returns the first one found.
	GetFirstMatch(context.Context, []namer.ModuleID) (*runtimev1.RunnablePolicySet, error)
}

BinaryStore is implemented by stores that have pre-compiled policies in binary format.

type Conf

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

Conf is required configuration for storage. +desc=This section is required. The field driver must be set to indicate which driver to use.

func GetConf

func GetConf() (*Conf, error)

func (*Conf) Key

func (c *Conf) Key() string

func (*Conf) UnmarshalYAML

func (c *Conf) UnmarshalYAML(unmarshal func(any) error) error

type Constructor

type Constructor func(context.Context, *config.Wrapper) (Store, error)

Constructor is a constructor function for a storage driver.

func GetDriverConstructor

func GetDriverConstructor(name string) (Constructor, error)

GetDriverConstructor registers a storage driver.

type Event

type Event struct {
	OldPolicyID *namer.ModuleID
	SchemaFile  string
	Kind        EventKind
	PolicyID    namer.ModuleID
}

Event is an event detected by the storage layer.

func NewPolicyEvent

func NewPolicyEvent(kind EventKind, policyID namer.ModuleID) Event

NewPolicyEvent creates a new storage event for a policy.

func NewReloadEvent

func NewReloadEvent() Event

NewReloadEvent creates a new reload event.

func NewSchemaEvent

func NewSchemaEvent(kind EventKind, schemaFile string) Event

NewSchemaEvent creates a new storage event for a schema.

func (Event) String

func (evt Event) String() string

type EventKind

type EventKind int

EventKind identifies the kind of storage event such as addition or deletion.

const (
	EventAddOrUpdatePolicy EventKind = iota
	EventDeleteOrDisablePolicy
	EventAddOrUpdateSchema
	EventDeleteSchema
	EventReload
	EventNop
)

type Instrumented

type Instrumented interface {
	RepoStats(context.Context) RepoStats
}

Instrumented stores expose repository stats.

type InvalidPolicyError

type InvalidPolicyError struct {
	Err     error
	Message string
}

InvalidPolicyError is a custom error to signal that a policy is invalid.

func NewInvalidPolicyError

func NewInvalidPolicyError(err error, msg string, args ...any) InvalidPolicyError

func (InvalidPolicyError) Error

func (ipe InvalidPolicyError) Error() string

func (InvalidPolicyError) Unwrap

func (ipe InvalidPolicyError) Unwrap() error

type InvalidSchemaError

type InvalidSchemaError struct {
	Err     error
	Message string
}

InvalidSchemaError is a custom error to signal that a schema is invalid.

func NewInvalidSchemaError

func NewInvalidSchemaError(err error, msg string, args ...any) InvalidSchemaError

func (InvalidSchemaError) Error

func (ise InvalidSchemaError) Error() string

func (InvalidSchemaError) Unwrap

func (ise InvalidSchemaError) Unwrap() error

type ListPolicyIDsParams

type ListPolicyIDsParams struct {
	NameRegexp      string
	ScopeRegexp     string
	VersionRegexp   string
	IncludeDisabled bool
}

type MutableStore

type MutableStore interface {
	Store
	AddOrUpdate(context.Context, ...policy.Wrapper) error
	AddOrUpdateSchema(context.Context, ...*schemav1.Schema) error
	Disable(context.Context, ...string) (uint32, error)
	Enable(context.Context, ...string) (uint32, error)
	DeleteSchema(context.Context, ...string) (uint32, error)
	Delete(context.Context, ...namer.ModuleID) error
}

MutableStore is a store that allows mutations.

type Reloadable

type Reloadable interface {
	Reload(context.Context) error
}

Reloadable stores allow reloading their contents.

type RepoStats

type RepoStats struct {
	PolicyCount       map[policy.Kind]int
	AvgRuleCount      map[policy.Kind]float64
	AvgConditionCount map[policy.Kind]float64
	SchemaCount       int
}

type SourceStore

type SourceStore interface {
	Store
	Subscribable
	// GetFirstMatch searches for the given module IDs in order and returns the first one found.
	GetFirstMatch(context.Context, []namer.ModuleID) (*policy.CompilationUnit, error)
	// GetCompilationUnits gets the compilation units for the given module IDs.
	GetCompilationUnits(context.Context, ...namer.ModuleID) (map[namer.ModuleID]*policy.CompilationUnit, error)
	// GetDependents returns the dependents of the given modules.
	GetDependents(context.Context, ...namer.ModuleID) (map[namer.ModuleID][]namer.ModuleID, error)
	// LoadPolicy loads the given policy from the store
	LoadPolicy(context.Context, ...string) ([]*policy.Wrapper, error)
}

SourceStore is implemented by stores that have policies in their source format (uncompiled).

type Store

type Store interface {
	// Driver is the name of the storage backend implementation.
	Driver() string
	// InspectPolicies returns inspection results for the policies in the store
	InspectPolicies(context.Context, ListPolicyIDsParams) (map[string]*responsev1.InspectPoliciesResponse_Result, error)
	// ListPolicyIDs returns the policy IDs in the store
	ListPolicyIDs(context.Context, ListPolicyIDsParams) ([]string, error)
	// ListSchemaIDs returns the schema ids in the store
	ListSchemaIDs(context.Context) ([]string, error)
	// LoadSchema loads the given schema from the store.
	LoadSchema(context.Context, string) (io.ReadCloser, error)
}

Store is the common interface implemented by storage backends.

func New

func New(ctx context.Context) (Store, error)

New returns a storage driver implementation based on the configured driver.

func NewFromConf

func NewFromConf(ctx context.Context, confWrapper *config.Wrapper) (Store, error)

NewFromConf returns a storage driver implementation based on the provided configuration.

type Subscribable

type Subscribable interface {
	// Subscribe adds a subscriber to listen for storage notifications.
	Subscribe(Subscriber)
	// Unsubscribe removes a subscriber.
	Unsubscribe(Subscriber)
}

Subscribable is an interface for managing subscriptions to storage events.

type Subscriber

type Subscriber interface {
	SubscriberID() string
	OnStorageEvent(...Event)
}

Subscriber is the interface implemented by storage subscribers.

type SubscriptionManager

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

func NewSubscriptionManager

func NewSubscriptionManager(ctx context.Context) *SubscriptionManager

func (*SubscriptionManager) NotifySubscribers

func (sm *SubscriptionManager) NotifySubscribers(events ...Event)

Notify sends the events to all subscribers.

func (*SubscriptionManager) Subscribe

func (sm *SubscriptionManager) Subscribe(s Subscriber)

func (*SubscriptionManager) Unsubscribe

func (sm *SubscriptionManager) Unsubscribe(s Subscriber)

type Verifiable

type Verifiable interface {
	CheckSchema(ctx context.Context) error
}

Verifiable stores allow querying whether the requirements for the store are met.