DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Info | ||
---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
Table of Contents | ||
---|---|---|
|
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Enter the name of the release you are targeting to deliverAmsterdam Release |
Project Lifecycle State | Either Incubation, Core, Mature.( Refer to ONAP Charter, section 3.3 Project Lifecycle for further information) |
Participating Company List | the company participating in this release. At least 3-4 organizations, including an operator are recommendedAT&T, Amdocs, Reliance Jio, ZTE. |
Scope
What is this release trying to address?
Describe the problem being solved by this releaseCLAMP 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 run time, as well as suspending and restarting it
Use Cases
Describe the The use case cases that this release is targeted for (better if reference to customer use case).for are the management of the control loops for : vDNS, vFW, vVoLTE, vCPE
Minimum Viable Product
Describe the MVP for this releaseThe minimum viable product that we aim to reach within R1 is to have the CLAMP application at least manage one type of control loop: vDNS and/or vFW (use case).
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In 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 server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox clamp and issuetype in (epic) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Stories
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox clamp and issuetype in (story) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
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 design, 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.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
---|---|
To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
...
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 |
Sub-Components
There is no currently no sub-components in CLAMP, the R1 application embeds both the designer and runtime parts.
ONAP Dependencies
The other ONAP projects CLAMP depends on are:
- SDC : Rest based interface exposed by the SDC, Distribution of service to DCAE
- 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
Architecture
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.
Architecture
- Below we show how the CLAMP application fits into ONAP. The red figure below shows the CLAMP application components. There is a design portion and an operations component, which are both deployed within ONAP portal.
•CLAMP is separated in 2 areas, which are currently (in seed code) both supported by a single application:
- Design Time(Cockpit/UI to define the templates)
- Templates are pushed to SDC. The template format is TOSCA blueprint, those blueprints will be pushed/provisioned, 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)
CLAMP will thus control the typical following control loop flow within ONAP :
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.
...
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|---|---|---|---|
To fill out | High level description of the APIAPI exposed by SDC to get list of Alarms and service information's | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description |
API exposed by SDC to publish Closed Loop template going to DCAE | ||||
API exposed by Policy to create/update policies | ||||
API exposed by DCAE to start/stop a Closed Loop | ||||
API exposed by DCAE to trigger the deployment/undeployment of a Control Loop template | ||||
API exposed by DCAE to get status of a Closed Loop |
API Outgoing Dependencies
API this release is of CLAMP is delivering to other ONAP Component(s) releases.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | ||||
---|---|---|---|---|---|---|---|---|
To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API descriptionN/A |
Third Party Products Dependencies
Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).
Name | Description | Version | To fill out | To fill out | To fill out|
---|---|---|---|---|---|
AJSC | java container | 6 | |||
AJSC-Camunda | Camunda integration into AJSC | 6 | |||
Docker | Container engine | 1.12 | |||
MariaDB | database container | 10.1.11 | |||
Spring boot | Spring boot Framework dependencies | 1.4.1 |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.
Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
Gaps
This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.
Gaps identified | Impact | ||
---|---|---|---|
Testing/Integration | limited testing of final product | To fill out | To fill out |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
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 |
---|---|---|
To fill out | To fill out | To fill out |
Resources
Fill out and provide a link Link toward the Resources Committed to the Release centralized page.
Release Milestone
The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.
Team Internal Milestone
This section may be used to document internal milestones that the team agreed on.
...
Date | Project | Deliverable |
---|---|---|
To fill out | To fill out | To fill out |
Documentation, Training
- Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
- Highlight the team contributions to the overall Release Documentation and training asset
- High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
- Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
Note | ||
---|---|---|
| ||
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset. |
Other Information
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.
Free and Open Source Software
FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.
Each project must edit its table within the [[Free_and_Open_Source_Software#Project_Licenses| Master Project License Table]].
Board policy (including IPR)
Indicate if the release meets the Board policy.
...
Charter Compliance
The project team comply with the ONAP Charter.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.