README
¶
Open Policy Agent
The Open Policy Agent (OPA) is an open source, general-purpose policy engine that enables unified, context-aware policy enforcement across the entire stack.
Want to learn about OPA?
- See openpolicyagent.org to get started.
- See blog.openpolicyagent.org for blog posts about OPA and policy.
- Join the conversation on Slack.
Want to get OPA?
See GitHub releases for binary releases.
Want to build OPA?
See DEVELOPMENT.md for development environment setup and build instructions.
Helpful Links
- License: Apache Version 2.0
- Bugs: Github Issues
- Features: Github Issues
- Discussions:
- Documentation: Introduction, Tutorials,
- Continuous Integration:
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ast declares Rego syntax tree types and also includes a parser and compiler for preparing policies for execution in the policy engine.
|
Package ast declares Rego syntax tree types and also includes a parser and compiler for preparing policies for execution in the policy engine. |
|
Package cmd contains the entry points for OPA commands.
|
Package cmd contains the entry points for OPA commands. |
|
Package dependencies provides functions for determining the set of ast.Refs that AST elements depend on.
|
Package dependencies provides functions for determining the set of ast.Refs that AST elements depend on. |
|
Package format implements formatting of Rego source files.
|
Package format implements formatting of Rego source files. |
|
Package loader contains utilities for loading files into OPA.
|
Package loader contains utilities for loading files into OPA. |
|
Package metrics contains helpers for performance metric management inside the policy engine.
|
Package metrics contains helpers for performance metric management inside the policy engine. |
|
Package rego exposes high level APIs for evaluating Rego policies.
|
Package rego exposes high level APIs for evaluating Rego policies. |
|
Package repl implements a Read-Eval-Print-Loop (REPL) for interacting with the policy engine.
|
Package repl implements a Read-Eval-Print-Loop (REPL) for interacting with the policy engine. |
|
Package runtime contains the entry point to the policy engine.
|
Package runtime contains the entry point to the policy engine. |
|
Package server contains the policy engine's server handlers.
|
Package server contains the policy engine's server handlers. |
|
authorizer
Package authorizer provides authorization handlers to the server.
|
Package authorizer provides authorization handlers to the server. |
|
identifier
Package identifier provides handlers for associating an identity with incoming requests.
|
Package identifier provides handlers for associating an identity with incoming requests. |
|
types
Package types contains request/response types and codes for the server.
|
Package types contains request/response types and codes for the server. |
|
writer
Package writer contains utilities for writing responses in the server.
|
Package writer contains utilities for writing responses in the server. |
|
Package storage exposes the policy engine's storage layer.
|
Package storage exposes the policy engine's storage layer. |
|
inmem
Package inmem implements an in-memory version of the policy engine's storage layer.
|
Package inmem implements an in-memory version of the policy engine's storage layer. |
|
Package tester contains utilities for executing Rego tests.
|
Package tester contains utilities for executing Rego tests. |
|
Package topdown provides query evaluation support.
|
Package topdown provides query evaluation support. |
|
builtins
Package builtins contains utilities for implementing built-in functions.
|
Package builtins contains utilities for implementing built-in functions. |
|
explain
Package explain contains utilities for post-processing traces emitted by the evaluation engine.
|
Package explain contains utilities for post-processing traces emitted by the evaluation engine. |
|
Package types declares data types for Rego values and helper functions to operate on these types.
|
Package types declares data types for Rego values and helper functions to operate on these types. |
|
Package util provides generic utilities used throughout the policy engine.
|
Package util provides generic utilities used throughout the policy engine. |
|
test
Package test contains utilities used in the policy engine's test suite.
|
Package test contains utilities used in the policy engine's test suite. |
|
Package version contains version information that is set at build time.
|
Package version contains version information that is set at build time. |
|
Package watch provides the ability to set a watch on a Rego query.
|
Package watch provides the ability to set a watch on a Rego query. |
Click to show internal directories.
Click to hide internal directories.