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 NameAmsterdam Release
Project Lifecycle StateIncubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for definition of Project Lifecycle states
Participating Company AT&T, AMDOCS, Bell Canada, Intel, Orange

Scope

What is this release trying to address?

The Amsterdam release will continue evolving the design driven architecture of and functionality for APPC. APPC aims to be completely agnostic and make no assumption about the network.

Amsterdam release will add Ansible support, enhancements for Chef, new Data Graphs (DG) and nodes in support of Ansible, enhancements to existing APIs in support of ONAP Operations Manager, plus capabilities that address operations efficiency.

We will continue to elaborate this section as the release progresses.

Use Cases

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

  • APPC will contribute to the vCPE use case closed loop scenario, assuming that Restart action is on the VM, not the VNF.
  • APPC will support vFW use case from a regression perspective; i..e, they need to work the same with the new code base.

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 (UEB/DMaaP) and exposes APPC OAM 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 (with Release 1)
    • Ansible (with Release 1)
  • Components that operate across all the APPC modules, including Logging, Security, KPI Service, data access service for access to internal DB (MySQL)

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 T Summary Status Reporter Created Updated
Loading...
Refresh

Stories

Key T Summary Status Reporter Created Updated
Loading...
Refresh

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. The diagram below will evolve as discussions around APPC and VF-C take place.

Release Deliverables

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

Deliverable NameDeliverable Description Deliverable Location
"App-c Image" Docker ContainerExecutable Docker images available on nexus3
Java Source CodeThe Java code for the main App-c components. appc Git repository
Deployment ScriptsLinux shell scripts and Maven pom files used to generate the Docker containers. appc/deployment Git repository
Directed Graph Xml Files (DGs)Xml files define the directed graphs which are installed to database during startup and are used to determine actions taken by app-c appc/deployment Git repository
Yang Model Files Yang files are used to define the... appc Git repository
Property Files Property files are used to define values that may need to be changed depending on the environment app-c is run in. appc Git repository

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 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/UEB: Message bus for communication with other components in the solution (SDC, DCAE, MSO, Portal, OOM)
  • MultiVIM: TBD - currently under architecture discussions. Today, AAPC interfaces to OpenStack via CDP-PAL, which is open source software available via Github.
  • SDNC/CCSDK - APPC currently gets ODL package from SDNC; SDNC and AAPC currently must align on ODL version. SDNC has indicated plans to upgrade to Carbon as part of R1. This creates a dependency on SNDC for R1.

Architecture

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.

High level architecture diagram

What is currently available is documented in the APPC User Guide. This document will be updated as part of the project.


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 NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
SDCREST APITBDTBDLink toward the detailed API description
AAIREST API8/23/178/23/17
MultiVIMREST API8/23/178/23/17
CCSDKOpenDayLight, SLI, and AAI Client8/23/178/23/17
DMaaPAPI  ti publish/subscribe to  events sent for VNF/VM action requests.8/23/178/23/17DMaaP API

API Outgoing Dependencies

API this release is delivering to other releases.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
NB InterfaceREST API

TBD

TBDLink toward the detailed API description

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

NameDescriptionVersion
ODLOpenDaylight4.0.1
Docker Docker container host
MySql mysql-server Docker container 5.6

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.

Gaps identifiedImpact
To fill outTo fill out

Known Defects and Issues

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

T Key severity Summary Status Assignee Reporter
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

ODL upgrade to Carbon - depends on SDNC, SDNC will not have ODL Docker available until end of July. If  Carbon docker is delayed, could impact APPC timeline.

Accept risk - need ODL from SDNC

Resources

Fill out and provide a link toward the Resources Committed to the Release centralized page.

Resource Page Link

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 may be used to document internal milestones that the team agreed on.

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

Release Key Facts

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