Overview

Scope

What is this release trying to address?

• Deliver points of interoperability between ONAP and External Systems
• Focus on ONAP External APIs to BSS/OSS (i.e., MEF Legato)
  • Service Catalog
    • Add notification for serviceCatalog API
      
      • Description:
        
        • Allow BSS catalog function to receive service catalog notification as serviceSpec status change or characteristic change (new value in an enum list for example). Could be interesting to track these serviceSpec update to update accordingly productSpec
      • Relevance:
      • Complexity: Moderate - need to subscribe to authenticated topic
      • Prerequisites: It requires to have a notification from SDC via DMaaP
      • Resources: Adrian O'Sullivan
  • Service Ordering
    
    • Add Support for serviceOrder API for Service Instantiation via macro mode
      
      • Description: 

        • With Dublin, a new mode is available in SO to instantiate a service : the "macro" mode.

          In SDC, a service can be declared with an instantiationType equal to "A-la-carte" or equal to "Macro". This information is then available in the Tosca service definition file.

          When "Macro" mode is choosen for a service, the SO will use different kind of BPMN workflow.

          This "macro" mode need to be managed by NBI.

          NBI needs to look at service definition in Tosca file, select the mode, build the "macro" request toward SO  when service instantiationType is "Macro". 

          REQUEST 1 : NBI have to send a request to SO with the parameter "aLaCarte": false when instantiationType is Macro in service definition file

          In macro mode, the SO request may also contain, in the "userParams" section, all needed information about VNFs and VF-module(s) to be instantiated.

          All those necessary information are in the Tosca service definition file generated by SDC.

          If NBI do not fill those information, the serviceOrder sent to NBI will have to provide those informations (that means an external system will have to do the job)

          REQUEST 2 : NBI to look at VNF, VF-module and Network in the Tosca service definition file in order to build the full "macro" request toward SO.

      • Relevance:
      • Complexity: High
      • Prerequisites: 
      • Resources: Romain and Rene
    • Update serviceOrder API to use GR_API
      
      • Description: 

        • SO can use two kind of API with SDNC : Generic-Resource API (GR_API) or VNF_API.It seems that it is better to indicate to SO to use GR_API now. It is the value of the field "testApi" that need to be modified in SO request to instantiate service object. Can be an environment variable.

      • Relevance:
      • Complexity: Easy
      • Prerequisites: 
      • Resources: Romain
    • Update ServiceOrder to accommodate Service Characteristics of "object" type
      
      • Description: 

        • Need to handle service orders which use "object" type in the serviceCharacteristics, i.e. utiizing the new specificationInputSchema  

          also update the object to be stored as "object" v "Object" in the service catalog response.

      • Relevance:
      • Complexity: Easy
      • Prerequisites: 
      • Resources: Adrian O'Sullivan
  • Performance Management (specification focus) (stretch goal: implementation associated with Network Slicing KPI reporting)
  • Integration 
    • Integrate External API/NBI within ONAP DMaap for authenticated topics ( Adrian )
    • Integrate External API/NBI with AAF for security enhancement  ( Matthieu )

Use Cases

The existing use cases are still going to be supported and additional use cases will be supported for the Frankfurt Release (as defined by the Control loop sub committee and TSC). Network Slicing Use case is a new use case which have plans to use External API Service Order APIs.

Minimum Viable Product

• Documentation of User Stories; Use Cases and Interactions (e.g., swagger ); Data Models (e.g., JSON); Interface Profiles and Functional Definition; 
• ONAP Component Mapping and Functional Analysis; 
• Code contribution for External API Agent functionality.

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

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.

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:

1. Design/Setup Time(Cockpit/UI to Configure the received templates)
1.  SDC will distribute a CSAR, for a service, the part of the CSAR that CLAMP will use are:
   1.   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.
   2. 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.
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. 
3. DCAE (in Frankfurt release), plan to introduce the DCAE-DESIGNER to(this is part of the new Self Serve Control Loop initiative):
   1. design control loop flow (sequences of µS)
   2. expose an API for CLAMP to retrieve the list of existing flow, so that CLAMP can use it to create new Control Loop's
4. CDS (in Frankfurt release):
   1. 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
2. Run time(DCAE-Policy, grabbing events and triggering policies based actions)
   1. 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)
3. Dashboard (ELK based)
   1. 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: Frankfurt Release Platform Maturity v1

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 Outgoing Dependencies

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

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, ...).

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.

Known Defects and Issues

Please refer to Frankfurt Defect Status

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 - Frankfurt 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.

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
  • ...

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.