Versions Compared

Key

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

...

Project NameEnter the name of the project
Target Release NameEnter the name of the release you are targeting to deliverDublin
Project Lifecycle StateEither Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information
Participating Company List the company participating in this release. At least 3-4 organizations, including an operator are recommended.AT&T, Bell Canada, Huawei, IBM, Tech Mahendra

Scope

What is this release trying to address?

Describe the problem being solved by this releaseThe primary focus of the ONAP release 4 (Dublin) is to advance platform maturity, with a focus on S3P (Scalabllity, Stability, Security and Performance).

Use Cases

...

CCSDK will support the following use cases from previous releases:

  • vFW
  • vDNS
  • vCPE
  • VoLTE
  • CCVPN

CCSDK will also support the following additional use cases for Dublin:

  • 5G



Minimum Viable Product

Describe the MVP for this release.

...

Deliverable NameDeliverable Description
To fill outTo fill out

Sub-Components

List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.

Deliverable 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 CCSDKSub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.


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.

Indicate where your project fit within the ONAP Archiecture diagram.

Block and sequence diagrams showing relation within the project as well as relation with external components are expected.

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:

Image AddedAnyone 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.

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

...

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description
  • API Outgoing Dependencies

...

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)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description
  • Third Party Products Dependencies

...

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

NameDescriptionVersion
To fill outTo fill outTo fill out

...

OpenDaylightOpenDaylight SDN Controller PlatformFluorine


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.

Jira
serverONAP JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox and issuetype in (bug)
serverId425b2b0a-557c-3c0c-b515-579789cceedb

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.

...

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

...