Portal R3 M1 Release Planning (Casablanca Release)

Owned by Manoop Talasila
Last updated: Aug 16, 2018
6 min read

The content of this template is expected to be fill out for M1 Release Planning Milestone.


Overview

Project Name

Enter the name of the project

Project Name

Enter the name of the project

Target Release Name

R1 Beijing Release

Project Lifecycle State

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

Participating Company 

AT&T, ChinaMobile, TechM, IBM, Huawei

Scope

What is this release trying to address?

Scope: The scope of this release will be for the Portal Platform to support the below list:

  1. Internationalization language support (Platform Feature) - ChinaMobile support

    1. Design language/internationalization component in Portal and provide service apis to partnering apps like Policy, VID, SDC, AAI.

    2. This is collaborative work with larger community (Use Case UI ONAP Team), expecting implementation details soon from ChinaMobile resources. 

  2. Testing (Technical Debt) - AT&T, IBM, TechM support

    1. CSIT tests for new Casablanca features.

    2. Support 50% code coverage without JavaScript. However, enable JavaScript Unit tests coverage to view the coverage results.

  3. Reporting feature enhancement in portal/sdk (Platform Feature) - AT&T support

  4. Defect fixes


Not-in-Scope: Please check Gaps.

Use Cases

Describe the use case this release is targeted for (better if the reference to customer use case).

Minimum Viable Product

Describe the MVP for this release.

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
Refresh

Stories

key summary type created updated due assignee reporter priority status resolution
Refresh



Longer term roadmap

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

Release Deliverables

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

Deliverable Name

Deliverable Description

Deliverable Name

Deliverable Description

Portal platform

Docker image of the application

SDK libraries

artifacts for onboarding applications  components

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.

ONAP Dependencies

List the other ONAP projects your depends on. 

UsecaseUI for internationalization feature contribution.

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.



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.

Portal's maturity requirements status is maintained for Casablanca release here - Portal R3 Casablanca - Integration Test Plans

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)

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)











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)

API Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

InternationalizationAPIs

To support language and locale

June 25, 2018

Aug 23, 2018

UsecaseUI team to contribute the details as they collaborating with Portal team on this requirement.

*Multi-Language Functionality API List:

  • GET  /auxapi/languageSetting/user/{loginId}                    Gets login user language setting in Portal

  • PUT  /auxapi/languageSetting/user/loginId}                     Updates login user language setting in Portal

  • POST  /auxapi/language                                                          Adds a language option in Portal

  • DELETE  /auxapi/language                                                     Deletes a language option in Portal

  • GET  /auxapi/languages                                                          Gets all language options in Portal

 

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

Name

Description

Version

MariaDB

The MariaDB is the repository that holds all the policies, templates, PDP group, and deployment information.

10.0

Nexus

The Nexus repository holds all the currently deployed Operational (i.e. Drools policies) and their dependent artifacts.

2.14.2-01

ElasticSearch

Used to search text within policy.

5.4.0

Ubuntu

Operating system

14.04

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.

JUnit tests: 50% code coverage is the goal for all repositories without javascript. 

If resources become available, we will add more CSIT test cases.

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

Gaps identified

Impact

Originally planned priority items, but de-scoped due to lack of resources (below items are added to backlog and not being committed for Casablanca release). 

  1. OOM integration and enhancement (Modularity)

    1. Support deployment, scalability issues of the platform (DB docker)

    2. Music cassandra as a service - integration

    3. Music team to provide DB as a service

  2. AAF integration (Technical Debt)

    1. Truning ON AAF and starting using role management for partners - Policy, SDC, VID, AAI requires SDK upgrade.

    2. AAF certificate management integration (both for FE HTTPs and BE rest API calls)

  3. Security issues from Nexus-IQ (Technical Debt)

    1. Angular upgrade to address the security issue - may impact partnering apps like Policy and VID.

    2. Possibly in phases - start removing the vulnerabilities that are maeked as - "Not vulnerable in ONAP".

    3. Fix pending Fortify issue

  4. API Versioning and Backward Compatibility (Technical Debt)

  5. Performance and Optimization (Technical Debt)

    1. Memory usage optimization

    2. Split DB, Portal and SDK docker images

    3. UI upgrades - Angular, Bower

    4. Simplify deployment by avoiding the etc/hosts file entries

    5. Logging enhancements

  6. Testing (Technical Debt)

    1. Convert ECOMP selenium tests into CSIT ONAP Robot Framework tests.

    2. Code Coverage needs to be improved to 50% on both portal and portal/sdk repos with JavaScript.

  1. Policy, VID apps that use portal/sdk will be directly impacted under S3P for logging support; also impacted under the JavaScript coverage support;

  2. Policy, VID, AAI, SDC will be impacted under Security for AAF role management support required from portal/sdk;

  3. OOM deployment is impacted if the DB scaling changes are not supported by Portal team; also the changes for simplification of etc/hosts entries impacts the OOM deployment which cannot be committed by Portal team.

Known Defects and Issues

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

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

Mitigation Plan

Contingency Plan

Risk identified

Mitigation Plan

Contingency Plan

Resources

Actively seeking community support.

Current resources are not enough to satisfy even the Highest Priority Epics

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

Date

Project

Deliverable

To fill out

To fill out

To fill out

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

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