Skip to content

Commit bb8f0cb

Browse files
committed
chore: add experimental documentation
Signed-off-by: Arjun Raja Yogidas <[email protected]>
1 parent 0da8cef commit bb8f0cb

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

docs/opa-middleware.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
# Applying OPA authz policies
1+
# OPA Authorization Middleware (Experimental)
22

3-
This guide provides instructions for setting up [OPA](https://github.com/open-policy-agent/opa) authz policies with the finch-daemon. Authz policies allow users to allowlist or deny certain resources based on policy rules.
3+
> ⚠️ **Experimental Feature**: The OPA authorization middleware is being introduced as an experimental feature.
4+
5+
This guide provides instructions for setting up [OPA](https://github.com/open-policy-agent/opa) authorization policies with the finch-daemon. These policies allow users to allowlist or deny certain resources based on policy rules.
6+
7+
## Experimental Status
8+
9+
This feature is being released as experimental because:
10+
- Integration patterns and best practices are still being established
11+
- Performance characteristics are being evaluated
12+
13+
As an experimental feature:
14+
- Breaking changes may occur in any release
15+
- Long-term backward compatibility is not guaranteed
16+
- Documentation and examples may evolve substantially
17+
- Production use is not recommended at this stage
418

519
## What Is OPA Authz implementation
620
Open Policy Agent (OPA) is an open-source, general-purpose policy engine that enables unified, context-aware policy enforcement across the entire stack. OPA provides a high-level declarative language, Rego, for specifying policy as code and simple APIs to offload policy decision-making from your software.

docs/sample-rego-policies/example.rego

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# This is an experimental preview policy example.
2+
# As this feature is under active development:
3+
# - Breaking changes may occur without notice
4+
# - Production use is not recommended
5+
16
package finch.authz
27

38
import future.keywords.if

0 commit comments

Comments
 (0)