Skip to end of metadata
Go to start of metadata

DRAFT PROPOSAL FOR COMMENTS

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

Info

Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much diagrams and flow charts as you need, directly in the wiki, to convey your message.


Overview

Project NameEnter the name of the project
Target Release NameBeijing
Project Lifecycle StateIncubation
Participating Company AT&T, Huawei, Amdocs, Intel, TechMahindra, ZTE

Scope

What is this release trying to address?

The primary focus of the ONAP release 2 (Beijing) is to advance platform maturity, with a focus on S3P (Scalabllity, Stability, Security and Performance).

Use Cases

CCSDK will support the same use cases as Amsterdam:

  • vFW
  • vDNS
  • vCPE
  • VoLTE

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 T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Stories

Key Summary T Created Updated Due Assignee Reporter P 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.

Release Deliverables


Deliverable NameDeliverable DescriptionDeliverable Location
CCSDK Source CodeSource code for CCSDK projectONAP gerrit
CCSDK Maven ArtifactsCompiled code that can be referenced in other projects as maven dependenciesONAP Nexus
CCSDK Docker Containers

Docker containers associated with SDNC project:

  • Controller (OpenDaylight) container
  • Database container
  • Directed Graph Builder container
ONAP Nexus
DocumentationUser and developer guidesONAP Wiki
CCSDK CI/CD automationScripts to automate compilation and deployment of maven artifacts and docker containers

ONAP gerrit

ONAP Jenkins


Sub-Components

Subcomponents of each ONAP project may be found on the Resources and Repositories page on this wiki.  Please see the CCSDK section of that page for subcomponent list of CCSDK.


Architecture

High level architecture diagram

CCSDK will be delivered as a set of libraries accessible as Maven dependencies, as well as a set of base Docker containers. The docker containers themselves are intended to be used by other projects as a basis for their own controller-specific docker containers.

The following diagram illustrates how CCSDK is used by the controller projects:


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.

AreaActual LevelTargeted Level for current ReleaseHow, EvidencesComments
Performance00Awaiting guidance from Benchmark subcommittee
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability0N/AAs a project that provides a library framework, CCSDK has no standalone component that can be soaked
  • 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
Resiliency12While CCSDK itself has no standalone component, it does provide an OpenDaylight docker container used by SDNC and APPC. In Beijing, CCSDK will support a clustered OpenDaylight configuration in Kubernetes, as well as a clustered database, to allow for automated detection and recovery within a site.
  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
Security01CCSDK will achieve 50% code coverage
  • 0 – none
  • 1 – CII Passing badge + 50% Test Coverage + 50% test coverage
  • 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls
  • 3 – CII Gold
Scalability0N/AScaling does not apply to CCSDK itself, as a set of libraries.
  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability11CCSDK will support ONAP standard logging.
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability11See readthedocs and wiki.
  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial documentation


API Incoming Dependencies

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
A&AI : schemasA&AI schemas used by CCSDK aaa-service moduleDefined in seed codeIncluded in seed codeTBD
SDC : distribution clientAPI used by ueb-listener (in CCSDK sdnc-northbound repo) to receive artifacts from SDCDefined in seed codeIncluded in seed codeTBD

API Outgoing Dependencies


API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Maven librariesLibraries used as dependencies by SDN-C, APP-C, DCAE and OOMIncluded in seed codeDelivered in seed codeJavadoc will be provided
Docker containersBase docker containers will be provided which can be used by SDN-C and APP-C as a basis for their docker containersIncluded in seed codeDelivered in seed code


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

NameDescriptionVersionOpenDaylightOpenDaylight SDN controller platformCarbon

NameDescriptionVersion
OpenDaylightOpenDaylight SDN Controller PlatformNitrogen

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.

  • 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 identifiedImpact
To fill outTo fill out
  • Known Defects and Issues

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

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
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 identifiedMitigation PlanContingency Plan
To fill outTo fill outTo fill out
  • 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.

DateProjectDeliverable
To fill outTo fill outTo 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.