nopa

README

nopa

NATS + OPA

Nopa is a simple way to store OPA bundles in NATS object storage and have the bundle updated in real time.

Usage

Using the example application:

• Create a NATS object bucket: nats obj add bundles
• Add the bundle to the object store: nats obj put bundles bundle.tar.gz
• Start the server go run main.go
• Send a request to the service nats req test '{"package": "data.foo", "input": {"foo": "bar"}}'

[!TIP] It is up to your application to handle how the package name and input are generated. You could for example use the subject as the package name.

Documentation

Index

• Variables
• type Agent
  • func NewAgent(opts AgentOpts) *Agent
  • func (a *Agent) Activate(ctx context.Context, b bundle.Bundle) error
  • func (a *Agent) Eval(ctx context.Context, input []byte, pkg string) ([]byte, error)
  • func (a *Agent) MustWatchBundleUpdates()
  • func (a *Agent) SetBundle(name string) error
  • func (a *Agent) SetRuntime()
  • func (a *Agent) WatchBundleUpdates(errChan chan<- error)
• type AgentOpts
• type BundleModifyFunc

Variables

var (
	ErrNotFound error = fmt.Errorf("package not found")
)

Types

type Agent

type Agent struct {
	BundleName  string
	ObjectStore nats.ObjectStore
	OPAStore    storage.Store

	Logger *slog.Logger
	Env    map[string]string

	Compiler  *ast.Compiler
	Modifiers []BundleModifyFunc
	Cache     cache.InterQueryCache
	// contains filtered or unexported fields
}

func NewAgent

func NewAgent(opts AgentOpts) *Agent

func (*Agent) Activate

func (a *Agent) Activate(ctx context.Context, b bundle.Bundle) error

func (*Agent) Eval

func (a *Agent) Eval(ctx context.Context, input []byte, pkg string) ([]byte, error)

Eval evaluates the input against the policy package

func (*Agent) MustWatchBundleUpdates

func (a *Agent) MustWatchBundleUpdates()

func (*Agent) SetBundle

func (a *Agent) SetBundle(name string) error

SetBundle updates the in-memory store with the bundle retrieved from the NATS object store

func (*Agent) SetRuntime

func (a *Agent) SetRuntime()

func (*Agent) WatchBundleUpdates

func (a *Agent) WatchBundleUpdates(errChan chan<- error)

type AgentOpts

type AgentOpts struct {
	BundleName  string
	ObjectStore nats.ObjectStore
	Logger      *slog.Logger
	Env         map[string]string
	Modifiers   []BundleModifyFunc
}

type BundleModifyFunc

type BundleModifyFunc func(b bundle.Bundle) (bundle.Bundle, error)

BundleModifyFunc will take a bundle and allow for modifications like adding custom modules