Page Status: Updated by PTL
Component Status: Updated by PTL ; Pending PTL Updates and ArchCom Review
1. High Level Component Definition and Architectural Relationships
In the Honolulu release the CLAMP component was successfully integrated into the Policy component as a PoC (see - REQ-473Getting issue details... STATUS ) . 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 - REQ-684Getting issue details... STATUS , the code is already there and working.
2. API Definitions
2a. Exposed APIs
|Interface Name||Definition||Capabilities||Version||Status||Payload Model(s)||API Spec (Swagger)|
|POE-1||Policy Type Design||Allows applications to create, update, delete, and query PolicyType entities so that they become available for use in ONAP by applications such as CLAMP.||1.0.0||production|
|POE-2||Policy Design||Allows applications (such as CLAMP and Integration) to create, update, delete, and query Policy entities.||1.0.0||production|
|POE-3||Policy Administration||Support CRUD of PDP groups and subgroups and to support the deployment and life cycles of PolicyImpl entities (TOSCA Policy and PolicyTypeImpl entities) on PDP sub groups and PDPs.||1.0.0||production||Embedded||https://docs.onap.org/projects/onap-policy-parent/en/latest/pap/pap.html#pap-rest-api-swagger|
|POE-4||Data Ingress||Listen on a DMaaP topic.||production|
Messages of interest are described in the policy logic
|POE-5||Decision Query||Policy decisions are required by ONAP components to support the policy-driven ONAP architecture. Policy Decisions are implemented using the XACML and Apex PDPs. The calling application (which may be another policy – e.g. invocation of a guard policy from PDP-D) must provide attributes in order for the PDP to return a correct decision.||NA||production||Defined by policy||https://docs.onap.org/projects/onap-policy-parent/en/latest/xacml/decision-api.html|
Control Loop Lifecycle Management and
Polciy Lifecycle Management
|A user interface (GUI) for:||NA||Defined by policy|
2b. Consumed APIs
|Interface Name||Consumed by||Description||API Spec (Swagger)|
|AAF||Policy Framework||Authentication and authorization|
Policy framework uses DMaaP for SDC subscriptions and internal communication.
Policies use DMaaP as a transport for contextual information from various sources
|CLDCAE-2||Policy/CLAMP||Deploy/remove DCAE µS.||https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/apis/deployment-handler.html|
|CLCDS-1||Policy/CLAMP||Get list of operations/actions and corresponding payload for Operational Policy where selected actor is "CDS".|
|AAI||Policies||Enrich ingress data with topology information|
|SO||Policies||Trigger orchestration actions (policy driven)|
|Policies||Trigger control actions (policy driven)|
|Other||Policies||Trigger any interface defined in a policy, for example, trouble ticketing|
3. Component Description
The ONAP Policy Framework is a comprehensive policy design, deployment, and execution environment. The Policy Framework is the decision making 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
TOSCA defines a PolicyType, the definition of a type of policy that can be applied to a service. It also defines a Policy, the definition of an instance of a PolicyType. 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 PolicyType must have a corresponding PolicyTypeImpl in the Policy Framework. The TOSCA PolicyType definition can be used to create a TOSCA Policydefinition, either directly by the Policy Framework, by CLAMP, or by some other system. Once the Policy artifact exists, it can be used together with the PolicyTypeImpl artifact to create a PolicyImpl artifact. A PolicyImpl artifact is an executable policy implementation that can run on a PDP.
The TOSCA PolicyType artifact defines the external characteristics of the policy; defining its properties, the types of entities it acts on, and its triggers. A PolicyTypeImpl artifact is an XACML, Drools, or APEX implementation of that policy definition. PolicyType and PolicyTypeImpl artifacts may be preloaded, may be loaded manually, or may be created using the Lifecycle API. Alternatively, PolicyType definitions may be loaded over the Lifecycle API for preloaded PolicyTypeImpl artifacts. A TOSCA PolicyType artifact can be used by clients (such as CLAMP or CLI tools) to create, parse, serialize, and/or deserialize an actual Policy.
The TOSCA Policy 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 Policy artifact and the PolicyTypeImpl artifact to create an executable PolicyImpl artifact.
Internally, Policy has three main functional areas: Policy Development; Policy Administration; Policy Decision Execution.
Policy Development abstracts persistence and supports the creation of policies/policy types.
Policy Administration also abstracts persistence (from a different user roles). It's main purposes are to ensure that policies are allocated correctly and to manage the life-cycle of policies.
Policy Decision Execution is where policy decisions are made, i.e. where the policy logic executes. Three languages are used to describe policies in ONAP: XACML; Drools; APEX. Policy designers may select the language that is most appropriate to their use case. The policies are interpreted and executed by a language specific PDP. Where necessary additional PDP may be added, thus allowing for new policy languages.
Policy Enforcement is in general not handled by the Policy Framework. Enforcement is handled by either the originator of a decision query (PDP-D does enforce guard policy decisions made in the XACML PDP), or by a reaction to a policy output (trigger).
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:
4. Known System Limitations
5. System Deployment Architecture
6. New Release Capabilities
The main new capability introduced in this release is the integration of the CLAMP component under the policy umbrella (see - REQ-684Getting issue details... STATUS ). 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).
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 ( - REQ-429Getting issue details... STATUS ). Existing use cases will be supported (no change).
Conformance with ONAP-wide requirements ( - REQ-441Getting issue details... STATUS , - REQ-437Getting issue details... STATUS , - REQ-398Getting issue details... STATUS , - REQ-396Getting issue details... STATUS , and - REQ-439Getting issue details... STATUS (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.
- Istanbul architecture description https://docs.onap.org/projects/onap-policy-parent/en/latest/architecture/architecture.html
Policy Framework API's - https://docs.onap.org/projects/onap-policy-parent/en/latest/offeredapis.html
- CLAMP Overview : https://docs.onap.org/projects/onap-policy-clamp/en/latest/index.html#master-index
- CLAMP internal interfaces: https://docs.onap.org/projects/onap-policy-clamp/en/latest/_downloads/d25f20712a4cf2524a1cf13242349743/swagger.pdf
- CLAMP User Guide: https://docs.onap.org/projects/onap-policy-clamp/en/latest/user-guide.html#