...
- Remove references and use of openecomp and replace with onap onap
- Address S3P Platform Maturity 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 . Further details below in Platform Maturity table.
- Support AAF (Authentication and Authorization Framework) for API access
- Dependency on AAF project to provide feature (AAF-91) to enable AAF security on the web server level (jetty level). AAF has accepted the story for Beijing.
- Upgrade ODL version to Nitrogen (driven by CCSDK dependency)
- Replace MySQL with MariaDB (driven by CCSDK/SDNC 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(will not be part of Beijing Release)- ActionStatus
- AttachVolume
- DetachVolume
- Following Actions in support of In-place software upgrade
- Contribute CDT Tool - an APP-C Design Tool enabling VNF owners to create templates and other artifacts used by APP-C Configure actions (used to apply a post-instantiation configuration) as well as other life cycle commands.
- Documentation updates for Beijing
- Support new LCM action for ConfigScaleOut
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 assuming all other components do likewise.
APPC contribute to two use cases as part of the functional requirements.
- Manual Config Scale Out will be supported..
- Change Management did not flag APPC has impacted because the use case they are looking at is focusing on an L3 VNF, so that would be the pervue of SDNC to do the in place software upgrade; however, if it was an L4-L7 type VNF, this would be APPC executing action. APPC will be adding capability to support an in-place software upgrade. We will contribute the code, but don't have a specific use case planned to exercise it.
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.
...
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox appc and issuetype in (epic) and fixVersion = "Beijing Release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox appc and issuetype in (story) and fixVersion = "Beijing Release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
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. Longer term items include:
- Support different types of clouds, currently only support Openstack; Looking at re-architecting the southbound IaaS adapter to allow plugins for different cloud abstraction solutions (CDP-PAL, MultiCloud, etc...)
- Align to the controller architecture proposed as part of ONAP by the architecture team.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
---|
Deliverable Location | ||
---|---|---|
"App-c Image" Docker Container | Executable | Docker images available on nexus3 |
Java Source Code | The Java code for the main App-c components. | appc Git repository |
Deployment Scripts | Linux 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 |
CDT tool | an APP-C Design Tool enabling VNF owners to create templates and other artifacts used by APP-C Configure actions (used to apply a post-instantiation configuration) as well as other life cycle commands | appc/cdt Git repository (NEW) |
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 depend on.
APPC depends on the the following components as part of the general ONAP architecture:
- 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 APPC currently must align on ODL version.
- AAF - AAF is used for authentication of APIs
- MultiVIM - APPC can access Openstack via MultiVIM or CPD-PAL. MultiVIM is optional for APPC at this stage.
For the Beijing release, APPC has dependencies on the following three projects for specific deliverables:
- CCSDK - - Nitrogen ODL & MariaDB
- AAF - feature AAF-91 - needed to address API level security
- SO - for manual scale out scenario
Architecture
High level architecture diagram
...
Anyone reading this section should have a good understanding of all the interacting modules.
For details on the APPC architecture, refer to the APPC User Guide.
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.
Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
---|---|---|---|---|
Performance | 0 | 0 | Awaiting guidance from Benchmark subcommittee |
|
Stability | 0 | 1 | APPC will do a 72 hr soak test We assume integration team will do a 72 hour soak test at the platform level. |
|
Resiliency | 1 | 2 | Clarification was provided by Jason Hunt that Level 1 is manual failure detection and recovery within a single site. APPC leverages CCSDK/SDNC distributions of OpenDaylight and DB. We will work closely with CCSDK/SDNC team to leverage what they are doing and not duplicate effort. |
|
Security | 0 | 1 | We will target 50% Sonar coverage for Beijing and complete the Passing badge Survey. |
|
Scalability | 1 | 1 | APPC uses ODL distribution from CCSDK project. Scaling is a function of ODL capabilities - APPC can be scaled either by adding additional OpenDaylight containers and/or database containers, or by deploying multiple instances of APPC cluster. |
|
Manageability | 1 | 1 | APPC supports/integrates EELF. |
|
Usability | 1 | 1 | Documentation is already available on readthedocs. It will be updated for Beijing as needed. |
|
...
Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|
SDC | REST API | Currently Available, but needs to be updated to use onap.org | TBD |
Link toward the detailed API description | ||||
AAI | REST API | Currently Available | Currently Available | |
CCSDK | OpenDayLight, SLI, AAI Client, dblib | TBD | TBD | |
DMaaP | API to publish/subscribe to events sent for VNF/VM action requests. | Currently Available | Currently Available | DMaaP API |
AAF | Application Authorization Framework | TBD | TBD |
API Outgoing Dependencies
API this project is delivering to other projects.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | ||||
---|---|---|---|---|---|---|---|---|
NB Interface | REST API | 3/8/18 | 3/18/18 | To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link 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, ...).
Name | Description | Version | To fill out | To fill out | To fill out|
---|---|---|---|---|---|
ODL | OpenDaylight controller platform | Nitrogen | |||
Docker | Docker container host | 1.12 | |||
MariaDB | data base container | TBD |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
...
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.
- CSIT tests added as part of R1 will continue to be supported in R2
- Pairwise testing will be done in the WindRiver Dev lab similar to what was done in R1.
- Epics are created to track testing activities to address Platform Maturity items.
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.
...
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
...
Risk identified | Mitigation Plan | Contingency Plan | To fill out | To fill out | To fill out|
---|---|---|---|---|---|
ODL upgrade to Nitrogen & DB to MariaDB - depends on CCSDK/SDNC projects | Accept risk | None | |||
AAF delivery of AAF-91 in time to allow APPC to complete and test their work | Working closely with AAF team to understand their design approach | Turn AAF off for Beijing (same as in Amsterdam) | |||
Resources
Fill out the Resources Committed to the Release centralized page.
Release 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 recommended to provide these agreements and dates in this section.
...
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. |
Documentation updates planned for Beijing release are tracked under Documentation Epic: APPC-308
Other Information
Vendor Neutral
...