Skip to end of metadata
Go to start of metadata



Overview

Project NameEnter the name of the project
Target Release NameBeijing  Release
Project Lifecycle StateIncubation.( Refer to ONAP Charter, section 3.3 Project Lifecycle for further information)
Participating Company AT&T, ZTE, Nokia.... (TBC)

Scope

What is this release trying to address?

CLAMP will be improved to enhance its resiliency and separate the UI duties (design time and runtime). The design time should be integrated into the SDC framework and the Runtime will stay in Portal.

Introduction of light dashboarding is also a goal for this release.

Use Cases

The existing Amsterdam use cases are still going to be supported and additional use cases will be supported for the Beijing Release (as defined by the Control loop sub committee)

Minimum Viable Product

The minimum viable product that we aim to reach within R2 is to have the CLAMP application Amsterdam (R1) features at least running in the new UI separation model. CLAMP team plans also to increase maturity level to support single site High Availability.

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

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh


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

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

Deliverable NameDeliverable DescriptionDeliverable location
CLAMP Docker containerDocker images available on nexus3Nexus3 docker registry
Source Code

Code of the Designer and run time of CLAMP

CLAMP git repository
Deployment scriptsScripts that can be used to help with the container instantiation and configurationCLAMP git repository
Property FilesProperties files that can be used to tune the configuration of CLAMP depending on the environmentCLAMP git repository
DocumentationRelease specific documentation (Release Note, user guide, deployment guide) provided through readthedocsCLAMP git repository

Sub-Components

There is no currently no sub-components in CLAMP, the R2 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 + SDC UX UI SDK
  • 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:

  1. Design Time(Cockpit/UI to define the templates)
    1. Templates are pushed to SDC. The template format is TOSCA blueprint, those blueprints will be pushed/provisioned, by SDC, to DCAE orchestration engine.
    2. 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).
      1. The DCAE team needs to provide models to Policy team in order for the Configuration policy to be built. 
  2. Run time(DCAE-Policy, grabbing events and triggering policies based actions)
    1. 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.
    2. The CLAMP cockpit will support the following action at runtime:
      1. start (start the provisioned Closed Loop on DCAE)
      2. stop (stop a provisioned Closed loop on DCAE)


CLAMP will thus control the typical following control loop flow within ONAP :


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.

AreaActual levelTargeted level for current releaseHow, EvidencesComments
Performance00Run performance basic test, depends on performance criteria availability for level 1 - not able to commit to more than what was done on Amsterdam
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability01 (assumption is that 72 hour soak test will be done by Integration team testing); not separate testing will be done at component level

Participate to Stability runs Level 1

CLAMP-100 - Getting issue details... STATUS

  • 0 – none
  • 1 – 72 hours component level soak w/random transactions
  • 2 – 72 hours platform level soak w/random transactions
  • 3 – 6 months track record of reduced defect rate
Resiliency11

CLAMP-83 - Getting issue details... STATUS

  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
Security01

Reach CII passing badge, increasing test coverage as remaining item

CLAMP-101 - Getting issue details... STATUS

  • 0 – none
  • 1 – CII Passing badge + 50% Test Coverage
  • 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls
  • 3 – CII Gold
Scalability11

Level 1 single site horizontal scaling

CLAMP-102 - Getting issue details... STATUS

  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability11Already using EELF common framework for logging
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability11

Documentation only for this release - Stretch to have automated API docs (Swagger)

CLAMP-32 - Getting issue details... STATUS

CLAMP-31 - Getting issue details... STATUS

  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial documentation


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 NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Same as AmsterdamAPI exposed by SDC to get list of Alarms and service information'sDate for which the API is reviewed and agreedAlready availableLink toward the detailed API description
Same as AmsterdamAPI exposed by SDC to publish Closed Loop template going to DCAE
Already available
Same as AmsterdamAPI exposed by Policy to create/update policies 
Already available
Same as AmsterdamAPI exposed by DCAE to start/stop a Closed Loop
Already available
Same as AmsterdamAPI exposed by DCAE to trigger the deployment/undeployment of a Control Loop template
Already available
Same as Amsterdam API exposed by DCAE to get status of a Closed Loop
Already available

API Outgoing Dependencies

API this release of CLAMP is delivering to other ONAP Component(s) releases.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI 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, ...).

NameDescriptionVersion
AJSCjava container6
AJSC-Camunda Camunda integration into AJSC 6
DockerContainer engine1.12
MariaDBdatabase container10.1.11
Spring bootSpring boot Framework dependencies1.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.

CLAMP will invest in CSIT tests to allow further integration testing, CLAMP already provided some tests as part of R1.

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 identifiedImpact
Testing/Integrationlimited testing of final product

Known Defects and Issues

Provide a link toward the list of all known project bugs.

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

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 identifiedMitigation PlanContingency Plan



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.

DateProjectDeliverable
To fill outsdcsdc 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 table within the [[Free_and_Open_Source_Software#Project_Licenses| Master Project License Table]].


Charter Compliance

The project team comply with the ONAP Charter.

Release Key Facts

Fill out and provide a link toward the centralized Release Artifacts.