Versions Compared

Key

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

...

Project NameEnter the name of the project
Target Release NameR1 Beijing Release
Project Lifecycle StateIncubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information
Participating Company AT&T, Intel, Huawei, OrangeChinaMobile, 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. 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

...

  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)

...

  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

:

  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 and Huawei resources. 
  2. API Versioning and Backward Compatibility Testing (Technical Debt)
  3. 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
  4. Testing (Technical Debt)- AT&T, IBM, TechM support
    1. CSIT tests for new Casablanca features.
    2. Convert ECOMP selenium tests into CSIT ONAP Robot Framework tests.
    3. Enable JavaScript Unit tests.
    4. Code Coverage needs to be improved to 50% on both portal and portal/sdk repos with JavaScriptSupport 50% code coverage without JavaScript. However, enable JavaScript Unit tests coverage to view the coverage results.
  5. Reporting feature enhancement in portal/sdk (Platform Feature) - AT&T support
  6. 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).

...

Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.

...

List the other ONAP projects your depends on. 

AAF (Application Authorization Framework) - for role/user creation, authentication, authorization.

OOM

MUSICUsecaseUI for internationalization feature contribution.

Architecture

High level architecture diagram

...

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.

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-171

...

  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented

...

  • 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

...

Integrating with MUSIC

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-210

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-5

...

  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)

...

Image Removed

>50% Test Coverage - https://sonar.onap.org/dashboard?id=org.onap.portal%253Aonap-portal-parent

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-145
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-155
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-136

...

  • 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

...

Integrating with MUSIC

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-210

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-5

...

  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-170

...

  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyPORTAL-147

...

  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial documentation

...

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 this release is delivering to other releases.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
InternationalizationAPIsTo support language and localeJune 25, 2018Aug 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

...

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: 80% 50% code coverage is the goal for all repositories without javascript

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

...

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.

To fill out
Gaps identifiedImpactTo fill out

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.

...

Risk identifiedMitigation PlanContingency Plan
ResourcesActively seeking community support.Current resources are only not enough to satisfy even the Highest Priority Epics (Platform Maturity, JUnit 80% test coverage). But that will be difficult to achieve.

Resources

Fill out the Resources Committed to the Release centralized page.

Release Milestone

...

The project team comply with the ONAP Charter.

Release Key Facts

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