Skip to content

Latest commit

 

History

History
109 lines (95 loc) · 2.88 KB

README.md

File metadata and controls

109 lines (95 loc) · 2.88 KB
Raw

JSON Rules Engine and Template Proof-of-Concept

We customize the open-source upstream json-rules-engine project to perform TMF-API Validations.

Features

  • Rules specified in JSON templates
  • Full support for ALL and ANY boolean operators
  • Specify priority levels and cache settings for fine tuning performance
  • REST API interface
  • Container Image on Docker Hub
  • Can be deployed on OpenShift as Pod
  • Can be part of EIP design pattern (as a Camel REST endpoint route)
  • Can be exposed using OpenShift Route

Installation

oc apply -f yaml/rulesapi-v1.yaml -n {your namespace}

Rules Template

  • Input: Fact (Payload)
  • Output: Event

A Rules Template contains a set of mandatory Conditions with optional priority settings. Evaluate input Fact using the defined Conditions triggering output Event.

[Priority, default 1] Dictates when rule should be run, relative to other rules. Higher priority rules are run before lower priority rules. Rules with the same priority are run in parallel. Priority must be a positive, non-zero integer. For example, priority=2 will run BEFORE priority=1, etc.


{
  "conditions": {
    "all": [
      {
        "operator": "in",
        "value": [
          24735,
          0,
          111,
          222,
          333
        ],
        "fact": "oc"
      },
      {
        "operator": "equal",
        "value": 610,
        "fact": "fta"
      }
    ]
  },
  "event": {
    "type": "Intercepted",
    "params": {
      "message": "Operation Should be Intercepted!"
    }
  },
  "priority": 1
}

Rules Workflow Sequence Diagram

sequenceDiagram
Requestor ->> RulesAPI: Should this Payload be Intercepted?
RulesAPI-->>RulesEngine: Validate Fact
RulesAPI--x Requestor: Confirm or Deny
RulesEngine-x RulesAPI: Return Event
Note right of RulesEngine: Rules Repo or Database.
Loading

Rules Engine Component Relationships:

graph LR
A[Trigger] -- Fact Evaluation --> B((Conditions))
A -- Update Rules  --> C(Rules Template)
B --> D{Events}
C --> D
Loading