...
| Info | ||
|---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Dublin Release |
| Project Lifecycle State | Incubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
| Participating Company | AT&T, Tech Mahindra, Ericsson, Orange, IBM |
Scope
What is this release trying to address?
The Dublin Release will be focusing on the following areas:
- Upgrade of ODL to Fluorine SR2 (CCSDK dependency)
- Platform Maturity (i.e., S3P items) https://wiki.lf-onap.org/pages/viewpage.action?pageId=16003367, https://wiki.onap.orgatlassian.net/wiki/display/DW/Dublin+Release+Platform+Maturity
- Brown→ Jason's goal Green color → Target level ( details see Platform Maturity below)
- Performance: Level 1, Level 2 (Stretch)
- Level 1: baseline performance criteria identified and measured (such as response time, transaction/message rate, latency, footprint, etc. to be defined on per component)
- Level 2: performance improvement plan created
- unzip feature.zip during building docker.
- Remove un-used bundles from CCSDK’s odlsli - depends on CCSDK
- Stability: Level 2
Level 1 (remain test coverage 50%)- Level 1: 72 hour component-level soak test (random test transactions with 80% code coverage; steady load)
- Level 2: 72 hour platform-level soak test (random test transactions with 80% code coverage; steady load)
- Configuration Enhancement https://wikilf-onap.onapatlassian.orgnet/wiki/display/DW/APPC+Configuration+Enhancement - Stretch goal
- Resiliency: Level 2
- Level 2: support automated failure detection & rerouting
- within a single geographic site
- stateless components: establish baseline measure of failed requests for a component failure within a site
- stateful components: establish baseline of data loss for a component failure within a site
- OOM: move to variable for database’s user/password
- CSIT OOM - Integration team
- Level 2: support automated failure detection & rerouting
- Security:
Absolute Minimum expectation: - CII badging passing level Continuously retaining no critical or Level 1, level 2 (Stretch)
- Level 1: CII Passing badge
- Including no critical and high known vulnerabilities > 60 days old
All communication - Level 2: CII Silver badge, plus:
- All internal/external system communications shall be able to be encrypted: there is http internal connection between CDT and APPC, we need to find the resource to migrate from http to https.
- All internal/external service calls shall have common role-based access control and authorization using CADI framework.
- Desired expectation is full CII badging silver level, if not 75% towards that.
- Scalability: Level 1
- Level 1: supports single site horizontal scale out and scale in, independent of other component
- APPC does not support dynamic cluster configuration in k8s only support static cluster configuration
- Clustering env with downstream: netconf, ansible
- Using Alpine linux distribution docker image as base.
- Manageability: Level1, Level 2 (Stretch)
- Level 2:
- A component can be independently upgraded without impacting operation interacting components
- Component configuration to be externalized in a common fashion across ONAP projects
All application logging to adhere to ONAP Application Logging Specification v1.2Implement guidelines for a minimal container footprint - See this presentation and follow the Container Image Minimization Guidelines
- Level 2:
- Usability: Level 21
- Level 2
- 1:
- API Documentation
- All new API’s must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines
- All existing APIs must be documented in Swagger 2.0
- User guide created
- Deployment documentation
- API documentation
- Adherence to coding guidelines
- Documentation updates (readthedocs) for Dublin, such as, but not limited to:
- LCM API Guide
- Release Notes
- CDT GUI Guide
- Code Coverage for CDT (Javascript) - TBD, no commitment at this stage
- Use Cases
- Closed Loop / E2E AutomationIntegrate automation test
- Change Management - APPC will continue supporting it.
- Closed Loop / E2E AutomationIntegrate automation test
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).The use cases supported in Beijing release will continue to be supported as part of regression assuming all other components do likewise.
APPC will contribute partially to the following use cases as part of the functional requirements.
- TBD
...
- Closed Loop / Integrate automation test
- Change Management (will be done by Orange team)
Minimum Viable Product
Same as was defined for Casablanca, but with the adding of increasing better performance for starting application, geo-redundancy etc. For details, please see above on S3P section
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
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=appc and issuetype in (epic) and fixVersion = "Dublin Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=appc and issuetype in (story) and fixVersion = "Dublin Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
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:
- Align to the controller architecture proposed as part of ONAP by the architecture team.
- Work with SDNC team to converge on a single controller design tool
- Support different types of clouds, currently only support Openstack;
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 LCM action | 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 |
| Parent Repo | The repository for the parents pom files. | appc/parents Git repository |
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.
...
- 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. (Currently we have no use case for this, although supported)
- 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 ODL API authorization
- MultiVIM - APPC can access Openstack via MultiVIM or CPD-PAL. MultiVIM is optional for APPC at this stage. Support of MultiVIM is limited to the Generic_Restart action only.
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 Dublin+Architecture.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
...
For details on the APPC architecture, refer to the APPC User Guide.
Platform Maturity
Refering to to CII Badging Security Program and Platform Maturity Requirements S3P, 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 | 02 | Stability | 1 - project team 2 - Integration team | 1 - project team 2 - Integration team Assume Integration team will address Level 2 - 72 hour test in Dublin | *current (1/9/19) code coverage is 66% | Resiliency | 2 | Security | 1 | Minimum Expectation | Absolute Minimum expectation:
| Scalability | 1 | maybe 2 | depends on how to setup the lab for geo-redundancy | Manageability | 1 | 1 TBD Recommendation for Casablanca is Level 2; however, Level 2 requirements are unclear and cannot be committed to. |
| Usability | 1 | 1 TBD Recommendation for Casablanca is Level 2; however, we cannot meeting Level 2 All new API’s must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines; - There was an issue with ODL & API version - need to investigate further Swagger 2.0 - We dependent on what ODL Oxygen for API documentation and they dictate version of Swagger used, currently looked like v1.2 E2E tutorial ??? |
|
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.
...
Stretch goal |
| |||||||||||
| Stability | 1 - project team 2 - Integration team | 1 - project team but we may not reach 80% code coverage 2 - Integration team Assume Integration team will address Level 2 - 72 hour test in Dublin | *current (1/13/19) code coverage is 67.9%
| |||||||||
| Resiliency | 2 | 2 | ||||||||||
| Security | 1 | 1, 2 (partial, please see the comments) | there is http internal connection between CDT and APPC, we need to find the resource to migrate from http to https. | |||||||||
| Scalability | 1 | 1 | ||||||||||
| Manageability | 1 | 1, 2(partial, please see the comments, APPC will comply two items on level 2) |
| |||||||||
| Usability | 1 | 1 | Recommendation for Casablanca is Level 2; however, we cannot meeting Level 2 All new API’s must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines; - There was an issue with ODL & API version - need to investigate further |
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 Name
| API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |
|---|---|---|---|---|
| SDC | REST API | Currently Available |
| TBD | ||||
| AAI | REST API | Currently Available | TBD | |
| CCSDK | OpenDayLight, SLI, AAI Client, dblib | End of |
| March | TBD | |
| DMaaP | API to publish/subscribe to events sent for VNF/VM action requests. |
| Currently Available | TBD | DMaaP API | ||
| AAF | Application Authorization Framework | Currently Available | Currently Available |
API Outgoing Dependencies
API this project is delivering to other projects.
...
| API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |
|---|---|---|---|---|
| NB Interface | REST API | Link toward the detailed API description https://onap.readthedocs.io/en/latest/submodules/appc.git/docs/APPC%20LCM%20API%20Guide/APPC%20LCM%20API%20Guide.htmllAPPC API Guide |
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, ...).
...
| Description | Version | |
|---|---|---|
| ODL | OpenDaylight controller platform | Fluorine SR2 |
| Docker | Docker container host | 1.12 |
| MariaDB | data base container | 10.1.11 |
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.
...
- CSIT tests added as part of R1 will continue to be supported in R3
- Pairwise testing will be done in the WindRiver Dev lab similar to what was done in R3.
- 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.
| Gaps identified | Impact |
|---|---|
| To fill out | To fill out |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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).
...
|
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 identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| ODL upgrade to Fluorine - depends on CCSDK projects | Fall back to Nitrogen |
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.
...
| Date | Project | Deliverable |
|---|---|---|
| To fill out | To fill out | To fill out |
Documentation, Training
- Highlight the team contributions to the specific document related to he the 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 assetAPPC will follow requirement by documentation team based on the APPC release capacities. |
Documentation updates planned for Beijing Dublin release are tracked under Documentation Epic: APPC-993
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
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.
...