hooks

Documentation

Index

• type ConfigDiscoveryHook
• type ConfigHook
• type Hook
• type Hooks
  • func New(hs ...Hook) Hooks
  • func (hs Hooks) Each(fn func(Hook))
  • func (hs Hooks) Validate() error

Types

type ConfigDiscoveryHook

type ConfigDiscoveryHook interface {
	OnConfigDiscovery(context.Context, *config.Config) (*config.Config, error)
}

ConfigHook allows inspecting or rewriting the discovered configuration when the discovery plugin is processing it.

type ConfigHook

type ConfigHook interface {
	OnConfig(context.Context, *config.Config) (*config.Config, error)
}

ConfigHook allows inspecting or rewriting the configuration when the plugin manager is processing it. Note that this hook is not run when the plugin manager is reconfigured. This usually only happens when there's a new config from a discovery bundle, and for processing _that_, there's `ConfigDiscoveryHook`.

type Hook

type Hook any

Hook is a hook to be called in some select places in OPA's operation.

The base Hook interface is any, and wherever a hook can occur, the calling code will check if your hook implements an appropriate interface. If so, your hook is called.

This allows you to only hook in to behavior you care about, and it allows the OPA to add more hooks in the future.

All hook interfaces in this package have Hook in the name. Hooks must be safe for concurrent use. It is expected that hooks are fast; if a hook needs to take time, then copy what you need and ensure the hook is async.

When multiple instances of a hook are provided, they are all going to be executed in an unspecified order (it's a map-range call underneath). If you need hooks to be run in order, you can wrap them into another hook, and configure that one.

type Hooks

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

Hooks is the type used for every struct in OPA that can work with hooks.

func New

func New(hs ...Hook) Hooks

New creates a new instance of Hooks.

func (Hooks) Each

func (hs Hooks) Each(fn func(Hook))

func (Hooks) Validate

func (hs Hooks) Validate() error