Page Status: Updated for Oslo 31 Jul 2024 

Component Status: 

Last Reviewed:

Certified by: Byung-Woo Jun 

1. High Level Component Definition and Architectural Relationships 

Drawio
border true diagramName policy_r15 simpleViewer false width links auto tbstyle top lbox true diagramWidth 1127 revision 3

In the Honolulu release the CLAMP component was successfully integrated into the Policy component as a PoC (see

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-473

) .     CLAMP's functional role to provision Policy has been enhanced to support provisioning of policies outside of the context of a Control Loop and therefore act as a Policy UI. In Istanbul release the CLAMP integration will be officially released

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-684

, the code is already there and working.

2. API Definitions

2a. Exposed APIs

2b. Consumed APIs

3. Component Description

The ONAP Policy Framework is a comprehensive policy design, deployment, and execution environment. The Policy Framework is the the decision making component in  component in an ONAP system. It allows you to specify, deploy, and execute the governance of the features and functions in your ONAP system, be they closed loop, orchestration, or more traditional open loop use case implementations. The Policy Framework is the component that is the source of truth for all policy decisions

Please see the the TOSCA Policy Primer page  page for an introduction to TOSCA policy concepts. See the Policy Design and API flow page for a description of the component interactions.

TOSCA defines a a PolicyType, the definition of a type of policy that can be applied to a service. It  It also defines a a Policy, the definition of an instance of a a PolicyType. In  In the Policy Framework, we must handle and manage these TOSCA definitions and tie them to real implementations of policies that can run on PDPs.

Each TOSCA TOSCA PolicyType must  must have a corresponding corresponding PolicyTypeImpl in  in the Policy Framework. The TOSCA PolicyType definition  definition can be used to create a TOSCA TOSCA Policydefinition, either directly by the Policy Framework, by CLAMP, or by some other system. Once  Once the Policy artifact  artifact exists, it can be used together with the the PolicyTypeImpl artifact  artifact to create a a PolicyImpl artifact artifact. A A PolicyImpl artifact  artifact is an executable policy implementation that can run on a PDP.

The TOSCA TOSCA PolicyType artifact  artifact defines the external characteristics of the policy; defining its properties, the types of entities it acts on, and its triggers.  A A PolicyTypeImpl artifact  artifact is an XACML, Drools, or APEX implementation of that policy definition. PolicyType and PolicyTypeImpl artifacts  and PolicyTypeImpl artifacts may be preloaded, may be loaded manually, or may be created using the Lifecycle API. Alternatively, PolicyType definitions  definitions may be loaded over the Lifecycle API for preloaded for preloaded PolicyTypeImpl artifacts artifacts. A TOSCA TOSCA PolicyType artifact  artifact can be used by clients (such as CLAMP or CLI tools) to create, parse, serialize, and/or deserialize an actual Policy.

The TOSCA TOSCA Policy artifact  artifact is used internally by the Policy Framework, or is input by CLAMP or other systems. This artifact specifies the values of the properties for the policy and specifies the specific entities the policy acts on. Policy Design uses the TOSCA TOSCA Policy artifact  artifact and the the PolicyTypeImpl artifact  artifact to create an executable executable PolicyImpl artifact artifact. 

        Internally, Policy has three main functional areas: Policy Development; Policy  Policy Administration; Policy Decision Execution.

Policy Development abstracts persistence and supports the creation of policies/policy types.

...

The Policy/CLAMP functional entity provides the capability to manage runtime control loops.  It provides the capability to

• Create control loop from DCAE blueprint, those blueprint are either:

  •  sent by SDC to DCAE (inventory) via SDC distribution. 

• Create configuration policy from the policy-model Tosca, the tosca policy-model are either:

  • sent by SDC via SDC distribution to everyone; or

  • query by CLAMP to Policy. in this case the policy-model is either pre-provisioned in Policy
    or separately provisioned to Policy via the REST API exposed by Policy.

• Configure DCAE applications of the control loop

• Associate µService configuration policies to the DCAE application

• Configure the operations to be taken by the control loop (by creating/updating/deleting operational policies)

• Deploy/un-deploy control loop flow (blueprints) to DCAE

• Control loop visualization. 

A more detailed figure and description of the Policy/CLAMP sub-component can be found here:

...

The main new capability introduced in this release is the integration of the CLAMP component under the policy umbrella (see

Jira Legacy
columns server System Jira key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-684

).   The software has been moved under the policy/clamp repository (https://git.onap.org/policy/clamp).    The OOM helm charts have also been moved as a sub-component of policy  (https://git.onap.org/oom/tree/kubernetes/policy/components).

The PoC experiments with defining Control Loops fully in Tosca will continue, as well.   This is covered by 

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-478

.

As outlined in the architecture review page (Policy Honolulu-R8 Architecture Review) the only new use case that may be supported as a stretch goal is 5G (

Jira Legacy
columns server System Jira key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-429

).   Existing use cases will be supported (no change).

Conformance with ONAP-wide requirements (

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-441

,

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-437

,

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-398

,

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-396

, and

Jira Legacy
server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-439

 (there are some risks, see Honolulu Risks page) are already or will be supported.

Additional enhancements to the Policy components will be introduced in this release that have no external impact.    These include but are not limited to:

• Stateless PAP (Keep no state in PAP runtime container, so state retrieval would be from database).

• Interoperability of Native and non-native policies in the Drools PDP. 

• Healthcheck status improvements as well as statistics reporting.

7. References

1. Istanbul architecture description https://docs.onap.org/projects/onap-policy-parent/en/latest/architecture/architecture.html

2. Policy Framework API's - https://docs.onap.org/projects/onap-policy-parent/en/latest/offeredapis.html

3. Policy/CLAMP:

   1. CLAMP Overview : https://docs.onap.org/projects/onap-policy-clamp/en/latest/index.html#master-index

   2. CLAMP internal interfaces:  https://docs.onap.org/projects/onap-policy-clamp/en/latest/_downloads/d25f20712a4cf2524a1cf13242349743/swagger.pdf 

   3. CLAMP User Guide: https://docs.onap.org/projects/onap-policy-clamp/en/latest/user-guide.html#