CLAMP R4 - M1 Release Planning

CLAMP R4 - M1 Release Planning




Overview

Project Name

Enter the name of the project

Project Name

Enter the name of the project

Target Release Name

DublinRelease

Project Lifecycle State

Incubation.( Refer to ONAP Charter, section 3.3 Project Lifecycle for further information)

Participating Company 

AT&T, Nokia, .... (TBC)

Scope

What is this release trying to address?

CLAMP want to consolidate Casablanca achievement by

  1. achieve the Casablanca S3P requirement for Casablanca in the limits the available resources permit.

  2. making the support of new micro-service generic(no code development needed to support new mS)
    by implementing policy-models concept (together with DCAE-DS/SDC, Policy-engine).

Scope

Priority

Committer Lead

Resources Committed

Epic 

Dependencies 

Scope

Priority

Committer Lead

Resources Committed

Epic 

Dependencies 

 CLAMP Architecture

 high

 @Gervais-Martial Ngueko

 AT&T, Nokia

 https://lf-onap.atlassian.net/browse/CLAMP-260

 Policy, SDC

 

 

 

 

 

 

S3P 

 high

 @Gervais-Martial Ngueko

 Nokia

 https://lf-onap.atlassian.net/browse/CLAMP-258

https://lf-onap.atlassian.net/browse/CLAMP-265

 





Use Cases

The existing use cases are still going to be supported and additional use cases will be supported for the Casablanca Release (as defined by the Control loop sub committee: auto-scale out use case, BBS use case is a stretch goal depending on resources committed by interested companies)

Minimum Viable Product

The minimum viable product that we aim to reach within R4 is to have the CLAMP application Casablanca(R3) features at least running with, the new policy-model and blueprint template, as artifact exchanged between CLAMP and DCAE-D.

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 type created updated due assignee reporter priority status resolution
Loading...
Refresh

Stories

key summary type created updated due assignee reporter priority 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 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 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

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 git repository

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, which are both deployed within ONAP portal.



CLAMP is separated in 3 areas, which are currently (in seed code) both supported by a single application:

  1. Design Time(Cockpit/UI to Configure the received templates)

  2.  

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

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

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.

see also Platform Maturity Requirements (S3P).

Area

Actual level

Targeted level for current release

How, Evidences

Comments

Area

Actual level

Targeted level for current release

How, Evidences

Comments

Performance

0

0

(given CLAMP is design time there is no point to adhere to L2 requirement) 

Run performance basic test, depends on performance criteria availability for level 1 - not able to commit to more than what was done on Beijing

  • Level 0: no performance testing done

  • Level 1: baseline performance criteria identified and measured  (such as response time, transaction/message rate, latency, footprint, etc. to be defined on per component)

  • Level 2: performance improvement plan created 

  • Level 3: performance improvement plan implemented for 1 release (improvement measured for equivalent functionality & equivalent hardware)

minimum level for Dublin is 0 except for Control Loop projects. 



see Performance levels

Stability

1

2

Participate to Stability runs Level 1

https://lf-onap.atlassian.net/browse/CLAMP-276



Integration Team is responsible to run the platform test to prove level 2.

  • Level 0: none beyond release requirements

  • Level 1: 72 hour component-level soak test (random test transactions with 80% code coverage; steady load)

  • Level 2: 72 hour platform-level soak test (random test transactions with 80% code coverage; steady load)

  • Level 3: track record over 6 months of reduced defect rate

minimum level for Dublin:2 

see Stability levels

Resiliency

1

1

(given CLAMP is design time there is no point to adhere to L2 requirement) 

https://lf-onap.atlassian.net/browse/CLAMP-83

  • Level 0: no redundancy

  • Level 1: support manual failure detection & rerouting or recovery within a single site; tested to complete in 30 minutes

  • Level 2: support automated failure detection & rerouting 

    • within a single geographic site

    • stateless components: establish baseline measure of failed requests for a component failure within a site 

    • stateful components: establish baseline of data loss for a component failure within a site

  • Level 3: support automated failover detection & rerouting 

    • across multiple sites 

    • stateless components 

      • improve on # of failed requests for component failure within a site 

      • establish baseline for failed requests for site failure 

    • stateful components 

      • improve on data loss metrics for component failure within a site 

      • establish baseline for data loss for site failure



Minimum Levels (Dublin)

  • Runtime Projects: Level 2 (stretch goal Level 3)

    • NOTE: For Dublin, the building blocks will be put in place for Level 3 geo-redundancy, and a few projects will pilot it

  • All other Projects: Level 1 (stretch goal Level 2)

see Resiliency Levels 

 

Security

1

1

same as in Casablanca, not enough resource to allocate to this effort.





see Security Levels

Scalability

1

1

Level 1 single site horizontal scaling

https://lf-onap.atlassian.net/browse/CLAMP-102

  • Level 0: no ability to scale

  • Level 1: supports single site horizontal scale out and scale in, independent of other components

  • Level 2: supports geographic scaling, independent of other components

  • Level 3: support scaling (interoperability) across multiple ONAP instances

Minimum Levels (Dublin)

  • Runtime Projects: Level 1 

    • NOTE: For Dublin, the building blocks will be put in place for Level 2 geographic scaling, and a few projects will pilot it

  • All other Projects: Level 0 

see Scalability levels 

Manageability

1

1

(2, if CLAMP can get more resource from the community)



  • Level 1:

    • All ONAP components will use a single logging system.

    • Instantiation of a simple ONAP system should be accomplished in <1 hour with a minimal footprint

  • Level 2:

    • A component can be independently upgraded without impacting operation interacting components

    • Component configuration to be externalized in a common fashion across ONAP projects

    • All application logging to adhere to ONAP Application Logging Specification v1.2

    • Implement guidelines for a minimal container footprint

  • Level 3

    • Transaction tracing across components

Minimum Levels (Dublin)

  • All Projects: Level 2

    • New projects should adhere to v1.2

    • Existing projects have stretch goal for v1.2

  • Stretch Goal: Level 3 

  • Note: some work will be done in Dublin to test/prep for a release upgrade strategy

see Manageability Levels 

Usability

1

1

(2, if CLAMP can get more resource from the community)

CLAMP is not anticipating new API at this point, so we are technically compliant with API CVS at this point

  • Level 1:

    •  

      • User guide created

      • Deployment documentation

      • API documentation

      • Adherence to coding guidelines

  • Level 2:

  • Level 3

    •  

      • Consistent UI across ONAP projects

      • Usability testing conducted

      • API Documentation

  • Level 4

    Minimum Levels (Dublin)

    • All Projects: Level 2

    • Stretch Goal: External APIs also follow the Versioning Strategy



  • see Usability Levels



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)

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

Same as Casablanca

API exposed by SDC to get list of Alarms and service information's

Date for which the API is reviewed and agreed

Already available

Link toward the detailed API description

Same as Casablanca

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



 

 API exposed by Policy to create/update guard policies 
(used for scale out use case operational policies)

 ongoing

TBD

 



API exposed by Policy to create/update policies 

ongoing

TBD
(new set of api based on policy-models)



Same as Casablanca

API exposed by DCAE to start/stop a Closed Loop



Already available



Same as Casablanca

API exposed by DCAE to trigger the deployment/undeployment of a Control Loop template



Already available



Same as Casablanca

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

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)