-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
5 deletions.
There are no files selected for viewing
18 changes: 13 additions & 5 deletions
18
apps/policy-engine/src/resource/open-policy-agent/rego/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,38 @@ | ||
|
||
# Packages | ||
|
||
## Main | ||
|
||
The implementation of engine general logic. This package is the one were transpiled policy are written | ||
Transpiled policies then use Armory/criteria functions to evaluate input | ||
|
||
## Armory | ||
|
||
### Constants | ||
|
||
These package contains all constants that are used by production code | ||
|
||
### Criteria | ||
|
||
Criteria contains the function that build the logic for every transpiled policy. | ||
**This package should have exactly the same number of files as we have supported criteria** | ||
|
||
### Feeds | ||
|
||
Criteria that needs to access our feeds should be depending from this package | ||
|
||
### Entities | ||
|
||
Functions used to query loaded data. It serves as a source of truth to know if something is in data.entities. | ||
- Enforce invariants like lowercasing hex addresses | ||
- Aggregate data from multiple places in entity in order to build useful relationships | ||
- build runtime types that depends on entity data result | ||
|
||
- Enforce invariants like lowercasing hex addresses | ||
- Aggregate data from multiple places in entity in order to build useful relationships | ||
- build runtime types that depends on entity data result | ||
|
||
### Lib | ||
|
||
Utils that are not domain specific, like case insensitive comparison or time. | ||
|
||
### Test_Data | ||
|
||
Values that are specifically used by tests. | ||
**this shouldn't be imported in production code** | ||
**this shouldn't be imported in production code** |