Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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.

...

Code of the Designer and run time of CLAMP

...

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.

Overall ArchitectureImage RemovedCLAMP CORE Technology ArchitectureImage Removed

...

  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 :

Image Removed

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.

...

serverONAP JIRA
jqlQueryproject = EXTAPI AND fixVersion = "Frankfurt Release" AND type = Epic
serverId425b2b0a-557c-3c0c-b515-579789cceedb

Stories

Jira
serverONAP JIRA
jqlQueryproject = EXTAPI AND fixVersion = "Frankfurt Release" AND type = Story
serverId425b2b0a-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.

Provide a clear and unambiguous ONAP service abstraction so that the BSS/OSS can exchange service requirements and service capabilities in a common and consistent fashion.
Provide a way to rapidly integrate new Services and Service Components into ONAP so that they can quickly introduce capabilities for their customers and within their infrastructure.
Enable management the entire lifecycle of Services within ONAP in a common way so that they can ensure orchestration, manageability and control of each Service in an easily integrateable and low cost way.
Model Driven approach: a cohesive way to have a shared view of information across ONAP external interfaces that can be used for or be input into a model driven process whereby the cost of delivering platform functionality is drastically reduced and the time to delivery is dramatically decreased.

Image Added

It is envisioned that from a Service Provider to BSS/OSS interaction context (i.e. MEF Legato), the ONAP External API will support the following types of interacts:

  • BSS/OSS retrieves Service Models
  • BSS/OSS requests service feasibility determination.
  • BSS/OSS requests reservations of capabilities related to a potential Service.
  • BSS/OSS requests activation of Service.
  • BSS/OSS receives Service activation tracking status updates.
  • BSS/OSS retrieves Service Inventory
  • BSS/OSS receives usage events due to a Customer initiating dynamic activity on their Service (e.g., increase in bandwidth).
  • BSS/OSS receives a summary of Service quality and usage information.
  • BSS/OSS receives Service state and fault event information
  • BSS/OSS receives Service Activation Testing results.
  • BSS/OSS receive capability information about the Service layer.
  • BSS/OSS manages Licenses
  • BSS/OSS receives License Usage information

It is envisioned that from a Service Provider to Partner Provider interaction context (i.e. MEF Interlude), the ONAP External API will support the following types of interacts:

  • Service Provider controls aspects of the Service within the Partner domain (on behalf of the Customer) by requesting changes to dynamic parameters as permitted by service policies.
  • Service Provider queries state of the Service.
  • Service Provider requests change to administrative state or permitted attributes of a Service.
  • Service Provider request creation of connectivity between two Service Interfaces as permitted by established business arrangement.
  • Service Provider request instantiation of functional service components as permitted by established business arrangement.
  • Service Provider queries the Partner for detailed information related to Services provided by the Partner to the Service Provider.
  • Service Provider receives Service specific event notifications (e.g., Service Problem Alerts) from the Partner.
  • Service Provider receives Service specific performance information from the Partner.
  • Service Provider request Service related test initiation and receive test results from the Partner.

Image Added


Release Deliverables

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

Deliverable NameDeliverable Description
DocumentationDocumentation of User Stories; Use Cases and Interactions (e.g., UML); Information Models (e.g., UML); Data Models (e.g., JSON); Interface Profiles and Functional Definition;ONAP Component Mapping and Functional Analysis
External APIJSON Swagger / OpenAPI for the External Interface
External API Agent SoftwareCode contribution for External API Agent functionality

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.

  1. External API Agent:
    1. Core Agent Functionality
    2. Service Catalog API
    3. Service Ordering API
    4. Service Inventory API

ONAP Dependencies

List the other ONAP projects your depends on.

Dependent on APIs from SDC, SO, and AAI

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.

Image Added

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

Performance00
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability00
  • 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
Resiliency00
  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
Security01
  • 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
Scalability00
  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability00
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability00
  • 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 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)

SDC: Catalog APIExposes Service CatalogTBDTBDhttps://wiki.onap.org/display/DW/SDC+API
SO: Service Instantiation APIRequests for Service InstantiationTBDTBD
AAI: Service Inventory APIQuery for Service InventoryTBDTBD

API Outgoing Dependencies

API this release is delivering to other releases.

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

ExtAPI: Service CatalogExternal Service Catalog APITBDTBDTBD
ExtAPI: Service OrderingExternal Service Ordering APITBDTBDTBD
ExtAPI: Service InventoryExternal Service Inventory APITBDTBDTBD

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

SpringbootJava Platform FrameworkTBD
MariaDBMySQL open fork

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.

Potential Test Cases for External API include:

  • BSS/OSS retrieves Service Models
  • BSS/OSS orders a new Service.
  • BSS/OSS subscribes to Service order tracking status notifications.
  • BSS/OSS retrieves Service Inventory


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

TBDTBD

Known Defects and Issues

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



KeySummaryTCreatedUpdatedDueAssigneeReporterPStatusResolution
EXTAPI-307nbi pod not started after a fresh master installationBugImage AddedSep 02, 2019Sep 04, 2019
Adrian OSullivanMorgan RichommeHighImage AddedCLOSEDCannot Reproduce
EXTAPI-305No Need for "ReadWriteMany" access on storage when deploying on KubernetesBugImage AddedAug 29, 2019Sep 04, 2019
Sylvain DesbureauxSylvain DesbureauxHighImage AddedCLOSEDDone
EXTAPI-287NBI to SDC connectivity health checks failBugImage AddedAug 08, 2019Aug 12, 2019
Adrian OSullivanAdrian OSullivanMediumImage AddedCLOSEDDone
EXTAPI-251Add external var for tmp directoryBugImage AddedMay 24, 2019Sep 02, 2019
Matthieu GeerebaertMatthieu GeerebaertMediumImage AddedOPENUnresolved
EXTAPI-249Change to oom dockers causing permissions failing when tosca parsingBugImage AddedMay 22, 2019Aug 07, 2019
romain gimbertAdrian OSullivanMediumImage AddedCLOSEDDone
EXTAPI-248ExtAPI should not be polling SDC-DISTR-NOTIF-TOPIC-AUTO without authenticatingBugImage AddedMay 22, 2019Aug 07, 2019
Adrian OSullivanAdrian OSullivanMediumImage AddedCLOSEDDone
EXTAPI-247Fix API version in helm chartBugImage AddedMay 16, 2019May 17, 2019
Morgan RichommeMorgan RichommeHighImage AddedCLOSEDDone
EXTAPI-246Fix broken sonar code coverageBugImage AddedMay 16, 2019May 17, 2019
Matthieu GeerebaertMatthieu GeerebaertMediumImage AddedCLOSEDDone
EXTAPI-241Adapt NBI testBugImage AddedMay 14, 2019May 16, 2019
Morgan RichommeMorgan RichommeMediumImage AddedCLOSEDDone
EXTAPI-222Add support for HTTPS with AAF artefactsBugImage AddedMar 20, 2019Oct 16, 2019
Matthieu GeerebaertMatthieu GeerebaertMediumImage AddedOPENUnresolved
EXTAPI-218Update to latest msb-java-sdkBugImage AddedMar 14, 2019Apr 26, 2019
Matthieu GeerebaertMatthieu GeerebaertMediumImage AddedCLOSEDDone
EXTAPI-214outdated version for NBIBugImage AddedMar 13, 2019Apr 04, 2019
Matthieu GeerebaertSylvain DesbureauxHighImage AddedCLOSEDDone
EXTAPI-213mariadb container is outdatedBugImage AddedMar 13, 2019Apr 29, 2019
Matthieu GeerebaertSylvain DesbureauxMediumImage AddedCLOSEDDone
EXTAPI-197Bad hostname while registering on MSBBugImage AddedJan 29, 2019Sep 02, 2019
Matthieu GeerebaertMatthieu GeerebaertMediumImage AddedOPENUnresolved
EXTAPI-196fix nbi testsBugImage AddedJan 29, 2019Jan 30, 2019
romain gimbertromain gimbertMediumImage AddedCLOSEDDone
EXTAPI-188serviceOrder.id might be overridden by client appBugImage AddedJan 25, 2019Jun 05, 2019
Matthieu Geerebaertromain gimbertMediumImage AddedCLOSEDDone
EXTAPI-187multiple identical hub might be created by client appBugImage AddedJan 24, 2019Jun 05, 2019
romain gimbertMatthieu GeerebaertMediumImage AddedCLOSEDDone
EXTAPI-180hub resource format dateBugImage AddedJan 18, 2019Jan 21, 2019
romain gimbertromain gimbertMediumImage AddedCLOSEDDone
EXTAPI-178Fix unit testing instabilityBugImage AddedJan 11, 2019Jan 23, 2019
Ezekiela RakotoarijaonaMatthieu GeerebaertMediumImage AddedCLOSEDDone
EXTAPI-172Multiple service orders in a single requestBugImage AddedNov 23, 2018Jan 16, 2019
romain gimbertMatthieu GeerebaertMediumImage AddedCLOSEDDone


Showing 20 out of 59 issues  Refresh

...

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

...




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

TBDTBDTBD

Resources

Please update any risk on the centralized wiki page - Frankfurt Risks

Resources

...

Fill out 

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 is optional and may be used to document internal milestones

...

within a project team or multiple project teams. For instance, 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, it is erecommended to provide these agreements and dates in this section.

It is not expected to have a detailed project plan.

Date

Project

Deliverable

To fill out
TBD
sdcsdc UI/UX SDK
TBDTBD

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

...

.