bundle

Documentation

Overview

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Package bundle implements bundle loading.

Index

• Constants
• type Config
  • func ParseBundlesConfig(config []byte, services []string) (*Config, error)
  • func ParseConfig(config []byte, services []string) (*Config, error)
• type ConfigBuilder
  • func NewConfigBuilder() *ConfigBuilder
• type Error
  • func NewBundleError(bundleName string, cause error) Error
• type Errors
• type Loader
• type Plugin
  • func Lookup(manager *plugins.Manager) *Plugin
  • func New(parsedConfig *Config, manager *plugins.Manager) *Plugin
• type Source
• type Status

Constants

const Name = v1.Name

Name identifies the plugin on manager.

Types

type Config

type Config = v1.Config

Config represents the configuration of the plugin. The Config can define a single bundle source or a map of `Source` objects defining where/how to download bundles. The older single bundle configuration is deprecated and will be removed in the future in favor of the `Bundles` map.

func ParseBundlesConfig

func ParseBundlesConfig(config []byte, services []string) (*Config, error)

ParseBundlesConfig validates the config and injects default values for the defined `bundles`. This expects a map of bundle names to resource configurations.

func ParseConfig

func ParseConfig(config []byte, services []string) (*Config, error)

ParseConfig validates the config and injects default values. This is for the legacy single bundle configuration. This will add the bundle to the `Bundles` map to provide compatibility with newer clients. Deprecated: Use `ParseBundlesConfig` with `bundles` OPA config option instead

type ConfigBuilder

type ConfigBuilder = v1.ConfigBuilder

ConfigBuilder assists in the construction of the plugin configuration.

func NewConfigBuilder

func NewConfigBuilder() *ConfigBuilder

NewConfigBuilder returns a new ConfigBuilder to build and parse the bundle config

type Error

type Error = v1.Error

func NewBundleError

func NewBundleError(bundleName string, cause error) Error

type Errors

type Errors = v1.Errors

Errors represents a list of errors that occurred during a bundle load enriched by the bundle name.

type Loader

type Loader = v1.Loader

Loader defines the interface that the bundle plugin uses to control bundle loading via HTTP, disk, etc.

type Plugin

type Plugin = v1.Plugin

Plugin implements bundle activation.

func Lookup

func Lookup(manager *plugins.Manager) *Plugin

Lookup returns the bundle plugin registered with the manager.

func New

func New(parsedConfig *Config, manager *plugins.Manager) *Plugin

New returns a new Plugin with the given config.

type Source

type Source = v1.Source

Source is a configured bundle source to download bundles from

type Status

type Status = v1.Status

Status represents the status of processing a bundle.