Requirement Jira: POLICY-2952 - Getting issue details... STATUS
The PoC shall focus on:
Demonstrate Control loops defined and deployed using TOSCA
Use a design time catalog for Control Loops for a complete storage of all the artifacts from different DT systems
Show design time systems can populate the Design Time control loop catalog
-DCAE-MOD interacting with the design time catalog
-SDC interacting with the design time catalog
Show TOSCA defined control loops being onboarded and deployed
Capabilities to be delivered:
Storage of Control Loop Element types in a design time catalogue
Storage of Control Loop types in a design time catalogue
Onboarding of Control Loop Element types from a zip file/CSAR/Yaml file containing a TOSCA service template that defines Control Loop Element types, see these examples of such TOSCA service templates here
GUI support for composition of Control Loop Types, resulting in a Yaml file containing a TOSCA service template that defines a Control Loop type, see an example of such a TOSCA service template here.
Composition of a Control Loop Type into a package/service that can be distributed by SDC over DMaaP, and parameterization of the common properties for the Control Loop type
Reception of the distribution of a Control Loop Type package/service sent by SDC from DMaaP and commissioning of the Control Loop Type in the Control Loop Runtime
Constraints:
The software should be integratable into SDC
The software should be possible to run standalone
The software will be developed as a new module in policy-gui
Follow the ONAP style guide and new methodology for client development
Use the policy-distribution component for commissioning from SDC
1 Terminology
This section describes the terminology used in the system.
1.1 SDC Terminology
TOSCA Service template: These templates are used to specify the topology and orchestration of services.
SDC: Service Design and Creation is the ONAP visual modeling and design tool. It provides a graphical interface for onboarding/designing resources (such as VNFs, PNFs, CNFs) and designing services composed of such resources that can be distributed to other ONAP components
SDC catalog: SDC maintains a design catalog of onboarded resources, designed services along with their artifacts (if any) from which other ONAP components (like SO, DCAE, CLAMP etc) can access them
SDC workflow: CSAR package for the designed service which is needed to instantiate the service. After the service is designed in UI, the CSAR is stored in SDC catalog. Distribution will send a notification over DMaap, and ONAP components that are registered and interested can callback to SDC catalog for the CSAR for a particular service
1.2 Control loop Terminology
Control Loop Type: A definition of a Control Loop in the TOSCA language. This definition describes a certain type of a control loop. The life cycle of instances of a Control Loop Type are managed by CLAMP.
Control Loop Instance: An instance of a Control Loop Type. The life cycle of a Control Loop Instance is managed by CLAMP. A Control Loop Instance is a set of executing elements on which Life Cycle Management (LCM) is executed collectively. For example, a set of microservices may be spawned and executed together to deliver a service. This collection of services is a control loop.
Control Loop Element Type: A definition of a Control Loop Element in the TOSCA language. This definition describes a certain type of Control Loop Element for a control loop in a Control Loop Type.
Control Loop Element Instance: A single entity executing on a participant, with its Life Cycle being managed as part of the overall control loop. For example, a single microservice that is executing as one microservice in a service.
CLAMP Control Loop Runtime: The CLAMP server that holds Control Loop Type definitions and manages the life cycle of Control Loop Instances and their Control Loop Elements in cooperation with participants.
1.4 SDC Architecture
2 Controlloop Design
The instructions below will enable to design a Control Loop.
2.1 Import and Onboard
Different Network functions are imported and created in to SDC dashboard. This can stand as an example for creating ControlLoopElements
SDC provides a graphical interface for onboarding/designing resources (such as VNFs, PNFs, CNFs) and designing services composed of such resources
2.2 Add service
Add a service with a service name and any suitable category. This can stand as an example to create ControlLoop
Onboard the resources and service, This will ensure service and resources are stored in the catalog.
2.3 Composition of ControlloopType
Composition of ControlLoopType in to service that can be distributed over Dmaap.
Existing SDC logic for adding dependencies, links, connection points between resources in a service can be re-used with no effort for composition
2.4 Change properties and values
Properties assignment of resources and service can be used without any change.
Each property can maintain a default value or marked as "declared at input" for setting values at a later stage
2.5 Download designed CSAR or template if desired
Once designed, a Tosca template or CSAR (Tosca template + any artifacts) can be downloaded
2.6 Distribute a service with Controlloop
From the SDC HOME page, click CATALOG and search for the service (it will be in Waiting For Distribution state)
Select the service that is Ready for Distribution, click Distribute (top right corner)
To Monitor Distribution, click on Distribution on the left pane
3 Changes proposed in SDC
Note: Some of the changes proposed below might already be supported in SDC and may not be needed. Verification of such can be part of POC and actual changes can be considered.
3.1 Model changes and new models for Controlloop types
Include model changes (if any) for defining properties of a Participant, ControlLoopElement and ControlLoop
Example: Multiple elements in ControlLoopElementDefinition properties
topology_template:
...
node_templates:
...
org.onap.domain.pmsh.PMSHControlLoopDefinition:
...
properties:
...
elements:
- name: org.onap.domain.pmsh.PMSH_DCAEMicroservice
version: 1.2.3
- name: org.onap.domain.pmsh.PMSH_MonitoringPolicyControlLoopElement
version: 1.2.3
- name: org.onap.domain.pmsh.PMSH_OperationalPolicyControlLoopElement
version: 1.2.3
3.2 New category as control loop element
New category as controlLoopElement may be introduced using which a resource can be created with category name as controlloopElement
3.3 New category as control loop
New category as controlloop may be introduced using which a resource can be created with category name as controlLoop
