Categorygithub.com/aserto-dev/runtime
modulepackage
0.68.0
Repository: https://github.com/aserto-dev/runtime.git
Documentation: pkg.go.dev

# README

runtime - an abstraction library on top of the Open Policy Agent (OPA)

Go Reference Go Report Card

Introduction

The "runtime" project is a library that sits on top of OPA.

The goal of the project is to allow you to quickly write code that builds, runs or tests OPA policies.

It uses the options pattern to facilitate construction of Runtime instances specific to your needs. You can start super simple, using it just to build some rego into a bundle, or you can get more complex, using it to start a runtime with plugins, built-ins and other features.

Install

go get -u github.com/aserto-dev/runtime

Usage

// Create a runtime
r, cleanup, err := runtime.NewRuntime(ctx, &logger, &runtime.Config{})
if err != nil {
  return errors.Wrap(err, "failed to create runtime")
}
defer cleanup()

// Use the runtime to build a bundle from the current directory
return r.Build(runtime.BuildParams{
  OutputFile: "my-bundle.tar.gz",
}, ".")

You can find a more complete example in the example directory.

Credits

Based on the awesome Open Policy Agent.

# Packages

No description provided by the author
No description provided by the author

# Functions

newAsertoStore creates a new AsertoStore.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author

# Variables

No description provided by the author

# Structs

AsertoStore implements the OPA storage interface for the Aserto Runtime.
BuildParams contains all parameters used for doing a build.
No description provided by the author
No description provided by the author
Result contains the results of a Compile execution.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Result contains the results of a Query execution.
Runtime manages the OPA runtime (plugins, store and info data).
No description provided by the author

# Type aliases

BuildTargetType represents the type of build target.
No description provided by the author
No description provided by the author