DRAFT PROPOSAL FOR COMMENTS

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

Overview

Scope

What is this release trying to address?

The Beijing Release will be focusing on Platform Maturity as a priority. Additional LCM actions will be added to the scope of APIs supported. These additional LCM actions have already been developed and validated by AT&T and will be contributed to ONAP. 

More specifically, APPC will focus on the following areas in Beijing.

• Remove references and use of openecomp and replace  with onap 
• Address S3P requirements to the extent possible to comply with minimum requirements requested for Beijing for areas not already at this level.
  • Notes:  
    • Compliancy for Performance Level 1 is still being investigated
    • Compliancy for Stability is assumed to be addressed by Integration team system level testing
    • Resiliency -
      • Local HA: this is a function of ODL clustering capability, so whatever is supported by ODL Nitrogen defines local HA capabilities
      • Geo-red: manual site failover only will be supported in Beijing 
• Support AAF (Authentication and Authorization Framework) for API access
• Upgrade ODL version to Nitrogen (driven by CCSDK dependency)
• Replace MySQL with MariaDB (driven by CCSDK dependency)
• Increase Code Coverage to 50%
• Provide support for the following new LCM actions:
  • Following Actions in support of In-place software upgrade
    • QuiesceTraffic
    • ResumeTraffic
    • UpgradeSoftware
    • UpgradePreCheck
    • UpgradePostCheck
    • UpgradeBackup
    • UpgradeBackout
  • Additional LCM actions including:
    • ActionCancel
    • ActionStatus
    • AttachVolume
    • DetachVolume

Use Cases

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

The use cases supported in Amsterdam release will continue to be supported as part of regression.

At this writing, APPC will not be contributing to any new use cases in Beijing.

The Change Management use case is working with SDNC for an L3 device firmware upgrade.

There is no impact for APPC as part of HPA use case at this point.

Discussions are still taking place around the Scaling use case; however, no definite outcome yet.

Minimum Viable Product

Describe the MVP for this release.

• Northbound REST Layer - This layer is responsible for interfacing with APPC clients such as SO, SDC, etc... via YANG-based API vis REST HTTP, message bus (DMaaP) and exposes APPC APIs enabling performance of lifecycle operations.
• APPC Provider - responsible for validating the YANG Remote Processing Call (RPC) input and for rejected when malformed. Upon successful validation, the APPC Provider call the Dispatcher to continue the request processing.
• APPC Dispatcher - responsible for processing requests received by the Request Handler and, if valid, selects the correct Directed Graph (DG) workflow for execution. Upon DG execution completion, the Dispatcher informs the initiator of results of the execution and updated data in AAI.
• Service Logic Interpreter (SLI) - responsible for executing the DGs. The Dispatcher invokes the SLI framework to execute a specific DG based on the input action. The SLI executes the DG and the sub-DG and returns a success or failure response to the Dispatcher.
• AAI Interface - APPC uses AAI as a source of VNF data, including status, topology, and operational data. It also makes updates to AAI as a result of a lifecycle operation.
• Southbound Layer - plugin architecture, uses several adapters to communicate to VNFs
  • Restcont adaptor
  • Netconf
  • SSH (XML/CLI)
  • IaaS - Interface as a Service, which is part of the OpenDaylight platform, which provides the framework for APPC
  • Chef
  • Ansible
• Components that operate across all the APPC modules, including Logging, Security, KPI Service, data access service for access to internal DB (MySQL in R1, MariaDB planned in R2)

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

Stories

Longer term roadmap

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

The long term road map is to achieve all the goals outlined in the approved project proposal; to be fully model and standards driven, be agnostics and make no assumptions about the network. Support configuration and lifecyle management of VNF/VNFC in a generic fashion so that on-boarding any new VNF/VNFC is just a matter of configuration and data. Additional long term goal is to align to the controller architecture proposed as part of ONAP by the architecture team.

<insert diagram>

Release Deliverables

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

Sub-Components

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

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

ONAP Dependencies

List the other ONAP projects you depends on.

• SDC: Rest based interface exposed by SDC. APPC receives notifications from SDC on VNF information. SDC team provides an SDC Listener, which is used by APPC.
• AAI: APPC retrieves and updates VNF data from/to AAI.
• DMaaP: Message bus for communication with other components in the solution (SDC, DCAE, MSO, Portal, OOM)
• CCSDK - APPC currently gets ODL & DB package from CCSDK; CCSDK and AAPC currently must align on ODL version. 
• AAF - AAF is used for authentication of APIs

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.

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.

• API Incoming Dependencies

List the API this project is expecting from other projects.
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 Outgoing Dependencies

API this project is delivering to other projects.

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

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.

• Unit tests are run automatically as part of every code merge.
• Once the final Docker image is compiled, it will be installed onto a Docker host and will be checked to ensure no errors occur during start-up.
• Functional testing will occur to ensure that the use cases are functioning correctly.

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

• Known Defects and Issues

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

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

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

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

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.