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. |
| Table of Contents | ||
|---|---|---|
|
Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Frankfurt |
| Project Lifecycle State | Core |
| Participating Company | AT&T, Samsung, Nokia |
Scope
What is this release trying to address?
The core development is focused on building CMPv2 (Certificate Authority) abilities for both Direct Access from VNFs, but also from AAF's Certificate Manager.
AAF, as a project, wants to continue to integrate into overall ONAP goals with Logging Spec/Implementation and Swagger API documentation, as well as strive towards higher JUnit metrics.
Requirements
1) As an ONAP Environment:
...
I need the AAF Certificate Agent to support locally created private/public keys.
Minimum Viable Product
AAF continues to be viable if it provides current BasicAuth Authentication and Certificates to Apps with all its current components, and remains stable in Daily and Staging Environments.
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 server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox AAF and issuetype in (epic) and fixversion = "Frankfurt Release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Stories
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox AAF and issuetype in (story) and fixversion = "Frankfurt Release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspectiveONAP Goals are to have multiple Client certificates from different CA Chains available for use as needed by Clients.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
| Components | Java Stand-Alone services suitable for running in any Java Environment |
| Docker Images | Individual Components (see below) Init Docker Helm Chart examples for Clients for Auto Cert Gen |
| Tools |
|
| Source Code | Java |
| Libraries | Jars |
| API | Currently Accessible in GUI. Desire Swagger for Frankfurt. |
| Documentation | Read-the-Docs |
Sub-Components
Resources and Repositories for Application Authorization FrameworkSub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
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.
...
Anyone reading this section should have a good understanding of all the interacting modules.
Platform Maturity
Please fill out the centralized wiki page: Frankfurt Release Platform Maturity
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.
...
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |||||
|---|---|---|---|---|---|---|---|---|---|
| <NONE> | AAF is Infrastructure. AAF does not contact any ONAP APIs. | N/A | N/A | 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 |
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) | |||||
|---|---|---|---|---|---|---|---|---|---|
| Certman 2.0 | Update for Certman API. Note: Certman API 1.0 is not directly used by any existing ONAP App. In ONAP, it is only used by AAF Certman Agent | TBA (Dec 12th) | To fill out | TBA (Swagger APIs are a Frankfurt deliverable) | 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 | |||
|---|---|---|---|---|---|
| Cassandra | AAF uses Cassandra for Data Persistence (it can be external, or use the internal Docker Version) | 3.11 (current) | To fill out | To fill out | To fill out |
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.
Existing CSIT and JUnit plans are paramount.
If possible, we want to increase CSIT testing, depending on resource, per requests to PTLs.
Testing of CMPv2 Interfaces are not fleshed out as yet, because of outstanding questions:
1) Exactly how to deploy an CMPv2 Service (per ONAP?, per Lab? , per Deployment?)
2) Do we SHARE the core AAF CA Cert currently used in "Local", or create new?
3) How to describe testing for a non-essential component for Integration, assuming we continue to use "Local" CA for Frankfurt, or how to work out 2 CAs in future.
CMPv2 Developers have been informed, and agreed, that their new code must have both JUnit Testing, and some sort of testing against a REAL CMPv2 ServerDescribe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
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 | ||
|---|---|---|---|
Goals for Certificates is to deal with Multiple CAs. The PTL (Jonathan) believes that this can be planned for, but is too aggressiveto promise, given TEST Plans must be worked out for all setups. | Workable "single CA" structure for initial rollout will not affect ONAP. | To fill out | To fill out |
Known Defects and Issues
Please refer to Frankfurt Defect Status
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).
Please update any risk on the centralized wiki page - Frankfurt Risks
Resources
Fill out the Resources Committed to the Release centralized page.AAF for Frankfurt
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
Please update the following centralized wiki: Frankfurt Documentation
...
| 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.
...