...
- implemnting a new Control Loop creation flow: Self Serve Control Loop .
- Add Tosca policy-model support for Operationnal Policies definbitions.
- Add integration to CDS for Actor/Action selection.
...
- Move from SearchGuard to OpenDistro
- Document current upgrade component strategy (TSC must havve)
- SECCOM Perform Software Composition Analysis - Vulnerability tables (TSC must have)
- SECCOM Password removal from OOM HELM charts (TSC must have)
- SECCOM HTTPS communication vs. HTTP (TSC must have) - CLAMP has already moved to to HTTPS so no work is required here
| Scope | Priority | Committer Lead | Resources Committed | Epic | Dependencies | |||
|---|---|---|---|---|---|---|---|---|
| CLAMP Self Serve Control Loop | high | AT&T, Ericscson |
|
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)
Minimum Viable Product
The minimum viable product that we aim to reach within R6 is to have the CLAMP application El Alto(R5) features at least running with, the new Operationnal policy-model and the new additional self-serve Control Loop flow working.
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
...
| DCAE | |||||||||
| CLAMP use policy model for Ops Policy | high | AT&T, Ericcsson |
|
...
| Policy | |||||||||
| CLAMP - CDS integration | high | vidyashree.rama | AT&T, Huawei |
|
...
| CDS | |||||
| SearchGuard to OpenDistro move | high | AT&T |
- Design 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.
- 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
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 | 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 | Stability | 1 | 2 |
|---|
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
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
1
(given CLAMP is design time there is no point to adhere to L2 requirement)
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
- 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)
same as in Casablanca, not enough resource to allocate to this effort.
see Security Levels
Level 1 single site horizontal scaling
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
- 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
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
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
- API Documentation
- All new API’s must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines
- All existing APIs must be documented in Swagger 2.0
- Consistent UI across ONAP projects
- Usability testing conducted
- API Documentation
- All new API’s, all external APIs, and all existing API’s that are modified must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines
- API Documentation
- All API’s for a given project must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines
- API Documentation
Minimum Levels (Dublin)
- All Projects: Level 2
- Stretch Goal: External APIs also follow the Versioning Strategy
| Jira Legacy | ||||
|---|---|---|---|---|
|
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.
...
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, which are both deployed within ONAP portal.
...
| |||||||||||||
| Document current upgrade component strategy | high | AT&T |
| ||||||||||
| SECCOM Password removal from OOM HELM charts | high | AT&T |
| ||||||||||
| SECCOM Perform Software Composition Analysis - Vulnerability tables | high | AT&T |
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)
Minimum Viable Product
The minimum viable product that we aim to reach within R6 is to have the CLAMP application El Alto(R5) features at least running with, the new Operationnal policy-model and the new additional self-serve Control Loop flow working.
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
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=clamp and issuetype in (epic) and fixVersion="Frankfurt Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 25 jqlQuery project=clamp and issuetype in (story) and fixVersion="Frankfurt Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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: Frankfurt 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 | 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 |
| 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 guard policies (used for scale out use case operational policies) ongoing | Already available | ||
| API exposed by policy to get a policy-model given the policy-model-id | ongoing | TBD | ||
| API exposed by Policy to create /update policies polidy pdp group | ongoing | TBD(new set of api based on policy-models) | ||
| Same as Casablancaprevious release | API exposed by DCAE to start/stop a Closed Loop | Already available | ||
| Same as Casablancaprevious release | API exposed by DCAE to trigger the deployment/undeployment of a Control Loop template | Already available | ||
| Same as Casablancaprevious release | API API exposed by DCAE to get status of a CLAMP deployed µS | Already available | ||
| API API exposed by DCAE to get status of all µS | ongoingongoing | TBD | ||
| API exposed by DCAE to get the list of Control Loop Flow available to use by CLAMP | ongoing | TBD | ||
| API exposed by CDS to retriev CDS actors/actions | ongoing | TBD |
API Outgoing Dependencies
API this release of CLAMP is delivering to other ONAP Component(s) releases.
...
| Name | Description | Version |
|---|---|---|
| Camel | framework to define routing and mediation rules | 2.2224.10 |
| Docker | Container engine | 1.1217 |
| MariaDB | database container | 10.13.1112 |
| Spring boot | Spring boot Framework dependencies | 2.1.4.15 |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
...
CLAMP will invest in CSIT tests to allow further integration testing, CLAMP already provided some tests as part of R1previous 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
Provide a link toward the list of all known project bugs.
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| of final product |
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
...
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.