Versions Compared

Key

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

...

  • 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 
  • Support AAF (Authentication and Authorization Framework) for API access
  • . 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)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:
      • ActionCancelActionCancel  (will not be part of Beijing Release)
      • ActionStatus
      • AttachVolume
      • DetachVolume
  • CDT Tool
  • Documentation updates for Beijing
  • 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.

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.

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 Minimum Viable Product

Describe the MVP for this release.

...

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

<insert diagram>

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
CDT tool

Sub-Components

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 commandsappc/cdt Git repository (NEW)


Sub-Components

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

...

List the other ONAP projects you depends depend on.

APPC depends on the the following components as part of the general ONAP architecture:

  • SDC: 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. 
  • 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 scenarioAAF - AAF is used for authentication of APIs

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.

Image Added

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
Performance0TBD0Awaiting guidance from Benchmark subcommittee
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability0

1

APPC will do a 72 hr soak test

We assume integration team will do a 72 hour soak test at the platform level.

2 (assumption is that 72 hour soak test will be done by Integration team testing); not separate testing will be done at component level

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

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.

Local HA is a function of ODL clustering

For Geo-Red, we will support manual failover

  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)redundancy)
Security01We will target 50% Sonar coverage for Beijing and  complete the Passing badge Survey.
  • 0
Security01
  • 0 – none
  • 1 – CII Passing badge + 50% Test Coverage
  • 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls
  • 3 – CII Gold
Scalability111

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.

1

  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
Manageability11APPC supports/integrates EELF.
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability11Documentation is already available on readthedocs. It will be updated for Beijing as needed.
  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial documentation

...

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 API
TBD
Currently Available, but needs to be updated to use onap.orgTBDLink toward the detailed API description
AAIREST APICurrently AvailableCurrently Available
CCSDKOpenDayLight, SLI,
and AAI Client
AAI Client, dblibTBDTBD
DMaaPAPI  to publish/subscribe to  events sent for VNF/VM action requests.Currently AvailableCurrently AvailableDMaaP API
AAFApplication Authorization FrameworkTBDTBD


  • API Outgoing Dependencies

...

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

TBD

3/8/18

3/18/18TBD

Link toward the detailed

API description

API description

http://onap.readthedocs.io/en/latest/submodules/appc.git/docs/APPC%20LCM%20API%20Guide/APPC%20LCM%20API%20Guide.html


  • Third Party Products Dependencies

...

NameDescriptionVersion
ODLOpenDaylight controller platform?Nitrogen
Docker Docker container host1.12
MariaDB MariaDB-server Docker  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.

  • Unit CSIT tests are run automatically added 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.
  • 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 itemsFunctional 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.

...

None
Risk identifiedMitigation PlanContingency Plan

ODL upgrade to Nitrogen & DB to MariaDB - depends on CCSDK/SDNC to provide dockers

Accept risk

CCSDK/SDNC projects

Accept riskNone
AAF delivery of AAF-91 in time to allow APPC to complete and test their workWorking closely with AAF team to understand their design approachTurn 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
titleNote

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

...