Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Guilin Release |
| Project Lifecycle State | Incubation.( Refer to ONAP Charter, section 3.3 Project Lifecycle for further information) |
| Participating Company | AT&T, Ericcson, Huawei, .... (TBC) |
Scope
What is this release trying to address?
CLAMP want to enhance the flexibility and ease of introducing new Control loop by:
- Solve bugs coming during this release
- implements as much TSC must feature as possible
| Scope | Priority | Committer Lead | Resources Committed | Epic | Dependencies |
|---|---|---|---|---|---|
| TSC Must have | high | AT&T | CLAMP-880 - Getting issue details... STATUS |
Use Cases
The existing use cases are still going to be supported and additional use cases might be supported for the Guilin Release (as defined by the Control loop sub committee and TSC) depending on available resources.
Minimum Viable Product
The minimum viable product that we aim to reach within R7 is to have the CLAMP application Frankfurt(R6) features at least running with the TSC must being implemented.
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
Stories
Requirements Epics for Guilin, Code mpacting CLAMP
Use Case : None
Functional Requirements : None
18 Non functionals :
10 - TSC MUST HAVE (please indicate where you plan to contribute)
| Requirement Epic | TSC Priority | SDC Epic(s) and/or SDC Story(ies) | Committed Contributors |
|---|---|---|---|
| RANK #1 - Must Have |
|
|
| RANK #1 - Must Have |
|
| |
| RANK #1 - Must Have |
|
| |
| RANK #1 - Must Have |
|
| |
| RANK #1 - Must Have |
|
| |
| RANK #1 - Must Have |
|
| |
| RANK #1 - Must Have |
|
| |
| RANK #1 - Must Have |
|
| |
 REQ-349 - Each ONAP project shall define code coverage improvements and achieve at least 55% code coverage To Do | RANK #1 - Must Have |
|
|
| RANK #1 - Must Have |
|
|
1 - TSC PRIORITY 2 Continuity (please indicate where you plan to contribute)
| RANK #2 – Continuity |
|
|
7- TSC PRIORITY 3 PTL GO/NO GO (please indicate where you plan to contribute)
|
| ||
|
| ||
|
| ||
|
| ||
| REQ-360 - Application config should be fully prepared before starting the application container To Do |
|
| |
| REQ-350 - Each ONAP project shall improve its CII Badging score by improving input validation and documenting it in their CII Badging site. To Do |
|
| |
|
|
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 setup a control 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 receives CSAR service package from SDC, 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 control loop flow.
The ONAP CLAMP platform abstracts the details of these systems under the concept of a control loop model. The setup 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 and events 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 readthedoc ONAP section : https://docs.onap.org/en/latest/index.html |
Sub-Components
....
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.
•CLAMP is separated in 3 areas, which are currently (in seed code) both supported by a single application:
- Design/Setup Time(Cockpit/UI to Configure the received templates)
- SDC will distribute a CSAR, for a service, the part of the CSAR that CLAMP will use are:
- the Control Loop flow Templates(e.g: blueprint) are defined in DCAE-D(sub-component of SDC) and distributed to CLAMP by SDC. The templates format is TOSCA. The blueprint is also pushed, by SDC, to DCAE platform orchestration engine.
- The policy-models defining the DCAE µS used inside the blueprint. note that policy-engine will also receive this SDC distribution and so should be also aware of those policy-models.
- 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.
- DCAE (in Frankfurt release), plan to introduce the DCAE-DESIGNER to(this is part of the new Self Serve Control Loop initiative):
- design control loop flow (sequences of µS)
- expose an API for CLAMP to retrieve the list of existing flow, so that CLAMP can use it to create new Control Loop's
- CDS (in Frankfurt release):
- expose by an API (or through CSAR distribution via SDC), the list of actors and corresponding actions, that CLAMP can then configure as part of an Operationnal policy configuration
- Run time(DCAE-Policy, grabbing events and triggering policies based actions)
- 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)
- Dashboard (ELK based)
- CLAMP also provides (as a separate components) an ELK stack (with specific configurations for the elk components) that listen to Control Loop events published on DMAAP on specific dmaap topics.
CLAMP will thus control the typical following control loop flow within ONAP :
Platform Maturity
Please check the centralized wiki page: Guilin Release Platform Maturity
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 previous release | 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) | Already available | ||
| Same as previous release | API exposed by Policy to create/update guard policies (used for scale out use case operational policies) | Already available | ||
| Same as previous release | API exposed by Policy to create/update policies | Already available | ||
| Same as previous release | API exposed by policy to get a policy-model given the policy-model-id | Already available | ||
| Same as previous release | API exposed by Policy to create polidy pdp group | Already available | ||
| Same as previous release | API exposed by DCAE to start/stop a Closed Loop | Already available | ||
| Same as previous release | API exposed by DCAE to trigger the deployment/undeployment of a Control Loop template | Already available | ||
| Same as previous release | API exposed by DCAE to get status of a CLAMP deployed µS | Already available | ||
| API exposed by DCAE to get status of all µS | ongoing | TBD | ||
| API exposed by DCAE to get the list of Control Loop Flow available to use by CLAMP | ongoing | TBD | ||
| Same as previous release | API exposed by CDS to retriev CDS actors/actions | Already available |
API Outgoing Dependencies
API this release 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) |
|---|---|---|---|---|
| N/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 |
|---|---|---|
| Camel | framework to define routing and mediation rules | 2.24.0 |
| Docker | Container engine | 1.17 |
| MariaDB | database container | 10.3.12 |
| Spring boot | Spring boot Framework dependencies | 2.1.5 |
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.
CLAMP will invest in CSIT tests to allow further integration testing, CLAMP already provided some tests as part of previous releases.
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 |
Known Defects and Issues
Please refer to Guilin Defect Status (TBC)
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).
Please update any risk on the centralized wiki page - Guilin Risks
Resources
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.
Also, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable |
|---|---|---|
| To fill out | sdc | sdc UI/UX SDK |
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 project table available at Project FOSS
Charter Compliance
The project team comply with the ONAP Charter.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.