...
What is this release trying to address?
CLAMP .....
Use Cases
The existing use cases are still going to be supported and additional use cases will be supported for the CasablancaRelease (as defined by the Control loop sub committee)
Minimum Viable Product
The minimum viable product that we aim to reach within R3 is to have the CLAMP application Beijing(R2) features at least running in the new UI separation model.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
Epics
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery key in (CLAMP-76,CLAMP-179) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
want to consolidate Beijing achievement by
- achieve the Casablanca S3P requirement for Casablanca in the limits the available resources permit.
- making the support of new micro-service generic(no code development needed to support new mS)
- using service template as Tosca as artifact received from DCAE-D to describe the Control Loop flow
CLAMP will also support the auto scale out of VF-module use case.
Use Cases
The existing use cases are still going to be supported and additional use cases will be supported for the Casablanca Release (as defined by the Control loop sub committee: auto-scale out use case)
Minimum Viable Product
The minimum viable product that we aim to reach within R3 is to have the CLAMP application Beijing(R2) features at least running with the new service template as artifact exchanged between CLAMP and DCAE-D.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
Epics
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 2520 jqlQuery project=clamp and issuetype in (story) and fixVersion="Casablanca Release" key in (CLAMP-76,CLAMP-179,CLAMP-189) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term Roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
The long term goal is to reach a common platform for managing control loops within ONAP :
CLAMP is a platform for designing and managing control loops. It is used to design a closed loop, configure it with specific parameters for a particular network service, then deploying and undeploying it. Once deployed, the user can also update the loop with new parameters during runtime, as well as suspending and restarting it.
It interacts with other systems to deploy and execute the closed loop. For example, it pushes the control loop design to the SDC catalog, associating it with the VF resource. It requests from DCAE the instantiation of microservices to manage the closed loop flow. Further, it creates and updates multiple policies in the Policy Engine that define the closed loop flow.
The ONAP CLAMP platform abstracts the details of these systems under the concept of a control loop model. The design of a control loop and its management is represented by a workflow in which all relevant system interactions take place. This is essential for a self-service model of creating and managing control loops, where no low-level user interaction with other components is required.
At a higher level, CLAMP is about supporting and managing the broad operational life cycle of VNFs/VMs and ultimately ONAP components itself. It will offer the ability to configure, test, deploy and update control loop automation - both closed and open. Automating these functions would represent a significant saving on operational costs compared to traditional methods.
Another Key long term goal is to provide a better user experience by separating clearly the UI in 2 entities : one for the design time and one for the runtime.
A Dashboard is also going to be introduced to allow the user to get a quick overview of the status of running control loops.
Release Deliverables
...
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 25 jqlQuery project=clamp and issuetype in (story) and fixVersion="Casablanca Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term Roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
The long term goal is to reach a common platform for managing control loops within ONAP :
CLAMP is a platform for designing and managing control loops. It is used to design a closed loop, configure it with specific parameters for a particular network service, then deploying and undeploying it. Once deployed, the user can also update the loop with new parameters during runtime, as well as suspending and restarting it.
It interacts with other systems to deploy and execute the closed loop. For example, it pushes the control loop design to the SDC catalog, associating it with the VF resource. It requests from DCAE the instantiation of microservices to manage the closed loop flow. Further, it creates and updates multiple policies in the Policy Engine that define the closed loop flow.
The ONAP CLAMP platform abstracts the details of these systems under the concept of a control loop model. The design of a control loop and its management is represented by a workflow in which all relevant system interactions take place. This is essential for a self-service model of creating and managing control loops, where no low-level user interaction with other components is required.
At a higher level, CLAMP is about supporting and managing the broad operational life cycle of VNFs/VMs and ultimately ONAP components itself. It will offer the ability to configure, test, deploy and update control loop automation - both closed and open. Automating these functions would represent a significant saving on operational costs compared to traditional methods.
Another Key long term goal is to provide a better user experience by having more flexibility to add mico-service without code development.
A Dashboard has been introduced to allow the user to get a quick overview of the status of running control loops.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description | Deliverable location |
|---|---|---|
| CLAMP Docker container | Docker images available on nexus3 | Nexus3 docker registry |
| Source Code | Code of the Designer and run time of CLAMP | CLAMP git repository |
| Deployment scripts | Scripts that can be used to help with the container instantiation and configuration | CLAMP git repository |
| Property Files | Properties files that can be used to tune the configuration of CLAMP depending on the environment | CLAMP git repository |
| Documentation | Release specific documentation (Release Note, user guide, deployment guide) provided through readthedocs | CLAMP git repository |
...
The other ONAP projects CLAMP depends on are:
- SDC/DCAE-D : Rest based interface exposed by the SDC, Distribution of service to DCAE + SDC UX UI SDKDistribution of Templates to CLAMP via SDC distribution client jar
- DCAE: Rest based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
- Policy: Rest based interface (the Policy team provide a "jar" to handle the communication), both XACML and Drools PDP, APIs to App-C/VF-C/SDN-C
- DMaaP: Message bus within DCAE and cross-ONAP
- VNF use cases : defines what type(s) of control loop(s) can be implemented and configured by CLAMP
...
•CLAMP is separated in 2 areas, which are currently (in seed code) both supported by a single application:
- Design Time(Cockpit/UI to define to Configure the templates)
- the Templates are pushed to (service template) are defined in DCAE-D and distributed to CLAMP by SDC. The template templates format is TOSCA blueprint, those blueprints will be pushed/provisioned. Aside of the service template the corresponding blueprint is also generated by DCAE-D and pushed, by SDC, to DCAE orchestration engine.
- policies (configuration and operational policies) are pushed/provisioned towards the Policy Component of ONAP. (those policies will be triggered by DCAE during Closed Loop operations).
- The DCAE team needs to provide models to Policy team in order for the Configuration policy to be built.
- Run time(DCAE-Policy, grabbing events and triggering policies based actions)
- In the first release of CLAMP, the triggering to deploy(and then effectively start the closed loop) a blueprint will be manual (via CLAMP cockpit) an automatic deployment based on an event will come in future release.
- The CLAMP cockpit will support the following action at runtime:
- start (start the provisioned Closed Loop on DCAE)
- stop (stop a provisioned Closed loop on DCAE)
...
Platform Maturity
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
| Area | Actual level | Targeted level for current release | How, Evidences | Comments | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Performance | 0 | 0 (given CLAMP is design time there is no point to adhere to L2 requirement) | Run performance basic test, depends on performance criteria availability for level 1 - not able to commit to more than what was done on AmsterdamBeijing |
| Stability | 0 | 1 (assumption is that 72 hour soak test will be done by Integration team testing); not separate testing will be done at component level | |||||||||||||||
| Stability | 1 | 1 | Participate to Stability runs Level 1
|
| ||||||||||||||||||
| Resiliency | 1 | 1 |
|
| ||||||||||||||||||
| Security | 01 | 1 |
|
| ||||||||||||||||||
| Scalability | 1 | 1 | Level 1 single site horizontal scaling
|
| ||||||||||||||||||
| Manageability | 1 | 1 Already using EELF common framework for logging(2, if CLAMP can get more resource from the community) |
| |||||||||||||||||||
| Usability | 1 | 1 | Documentation only for this release - Stretch to have automated API docs (Swagger)
| (2, if CLAMP can get more resource from the community) | CLAMP is not anticipating new API at this point, so we are technically compliant with API CVS at this point |
|
API Incoming Dependencies
List the API this release is expecting from other ONAP component(s) releases.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.
Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| Same as Beijing | API exposed by SDC to get list of Alarms and service information's | Date for which the API is reviewed and agreed | Already available | Link toward the detailed API description |
| Same as Beijing | SDC Client(jar library provided by SDC team) used to get service template (describing control loop flow) and blueprint id( to know which blueprint has been distributed to DCAE for this Control Loop template)template) | Already available | ||
| API exposed by Policy to create/update guard policies (used for scale out use case operational policies) | ongoing | TBD | ||
| Same as Beijing | API exposed by Policy to create/update policies | Already available | ||
| Same as Beijing | API exposed by DCAE to start/stop a Closed Loop | Already available | ||
| Same as Beijing | API exposed by DCAE to trigger the deployment/undeployment of a Control Loop template | Already available | ||
| Same as Beijing | API exposed by DCAE to get status of a Closed Loop | Already available |
...
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
...
|
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| new policy api(and contents) for guard policies creation not defined yet | ||
| "vf_module_id" usage for scale out use case not yet completely confirmed | implement textbox to manually enter target parameter(for policy api call) | use the textbox to enter the value of whatever vf_module id's we need to make the CL works |
Resources
Link toward the Resources Committed to the Release centralized page.
Release Milestone
...
The project team comply with the ONAP Charter.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.