package bundle

import "github.com/open-policy-agent/opa/bundle"

Package bundle implements bundle loading.

Index ¶

• Constants
• func Write(w io.Writer, bundle Bundle) error
• type Bundle
• func Read(r io.Reader) (Bundle, error)
• func (b Bundle) Equal(other Bundle) bool
• type Manifest
• type ModuleFile

Constants ¶

const (
	RegoExt     = ".rego"
	JSONExt     = ".json"
	ManifestExt = ".manifest"
	DataFileExt = "/data.json"
)

Common file extensions and file names.

Functions ¶

func Write ¶

func Write(w io.Writer, bundle Bundle) error

Write serializes the Bundle and writes it to w.

Types ¶

type Bundle ¶

type Bundle struct {
	Manifest Manifest
	Data     map[string]interface{}
	Modules  []ModuleFile
}

Bundle represents a loaded bundle. The bundle can contain data and policies.

func Read ¶

func Read(r io.Reader) (Bundle, error)

Read returns a new Bundle loaded from the reader.

func (Bundle) Equal ¶

func (b Bundle) Equal(other Bundle) bool

Equal returns true if this bundle's contents equal the other bundle's contents.

type Manifest ¶

type Manifest struct {
	Revision string `json:"revision"`
}

Manifest represents the manifest from a bundle. The manifest may contain metadata such as the bundle revision.

type ModuleFile ¶

type ModuleFile struct {
	Path   string
	Raw    []byte
	Parsed *ast.Module
}

ModuleFile represents a single module contained a bundle.

Source Files ¶

bundle.go