AAF R4 - M1 Release Plan
- Jonathan Gathman
- Sai Gandham
- cl664y@att.com
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Overview
Project Name | Enter the name of the project |
|---|---|
Target Release Name | Dublin |
Project Lifecycle State | Incubation, Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
Participating Company | AT&T Ericsson, Nokia, China Mobile, Amdocs |
Scope
What is this release trying to address?
The Dublin release of AAF project will address the following items:
bug fixes, maintenance and feature alignment
increased stability of running AAF in K8s environment
Enhance AAF Locator to handle Internal and External access information
helping ONAP Services engage with AAF generated Certificates and clients
(Stretch Goal) Provide CMPv2 Cert APIs for VNFs (This Stretch Goal is not doable in Dublin)
Note: AAF already has Silver CII Badging https://bestpractices.coreinfrastructure.org/en/projects/2303
Use Cases
ONAP Services will be able to engage AAF Configuration as a "Init Container", prior to starting, which will give them certificates, etc.
Both External and Internal services will be able to utilize AAF Locator to find AAF Resources in ONAP
(Stretch Goal) Present AAF Locator solution as part of Scalability/Resiliency initiatives
(Stretch Goal) Be able to generate Certificates for VNFs with CMPv2 Protocol. This stretch Goal cannot be done in Dublin
Minimum Viable Product
The ONAP AAF Project will deliver the following documentation as its minimum viable product:
AAF's 7 Microservices, running in OOM
AAF Documentation
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
Stories
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
|---|---|
Enhanced Locator | Be able to provide Location info for Internal ONAP services and External Access |
Note: The Enhanced Locator shows great promise to enable ONAP Components to achieve Geo Scalability and Resiliency. However, as is usual for Infrastructure, it must be essentially there and functional for Architecture to view and make recommendations. We are pursuing both essential Capabilities and Architectural Approval during this release.
Note: VNFs are asking for CMPv2 API. We cannot promise this because of Risks (see details below), which include not having a CMP compatible CA available to develop with, and lack of known Java CMP Libraries. We will be looking at this, however during the Dublin Release, and demonstrate however far along we can get.. This Stretch goal cannot be done in Dublin.
Sub-Components
List all sub-components part of this release.
aaf-service
aaf-locator
aaf-oauth
aaf-cm
aaf-gui
aaf-fs
aaf-hello
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.
Architecture
High level architecture diagram
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 | 1 | 1 | Note: AAF audit trails all transactions. With Dublin, we want to add additional Performance testing in ONAP, not just originating company. It will take time to pull in ONAP recommended monitoring. |
|
Stability | 2 | 2 | Note: AAF has clean record of Uptime in initial Company, 3 and beyond. However, there may not be time to prove this in Dublin |
|
Resiliency | 2 | 2 | Note: Will be demonstrating AAF Locator as a tool for all ONAP to gain GEO Redundancy |
|
Security | 2 | 2 | CII Badge: https://bestpractices.coreinfrastructure.org/en/projects/2303 |
|
Scalability | 2 | 2 | AAF Locator pattern we have brought in with AAF allows for High Scale and Resiliency. We are working on combining that within the context of OOM, etc. If accepted and implemented, will bring all users quickly to Massive GEO Scaling, and multi-ONAP Instances, multi-ONAP Clusters. However, part of the work is bring this up to Architecture during the Dublin Timeframe. |
|
Manageability | 1 | 1 | Will be looking at ONAP Logging. |
|
Usability | 1 | 1 | We will continue working on Documentation, and helping Apps start up with AAF. https://docs.onap.org/en/casablanca/guides/onap-provider/index.html |
|
API Incoming Dependencies
List the API this project is expecting from other projects.
AAF is Infrastructure. As such, it does not expect input from other projects.
API Outgoing Dependencies
API this project is delivering to other projects.
API is included in GUI
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, ...).
Cassandra, Version 3.11 (Note: The expectation is that users of AAF may have their own Cassandra installations. Chances are, Datastax client is compatible if near this version)
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.
Junits
CSIT (automated functional tests)
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.
(Note: Many bugs may be related to Side Tools (like SSM or Side-Car), which are add-ons, and do not necessarily affect ONAP functionality as a whole)
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 |
|---|---|---|
This Stretch Goal has been Descoped CMP interface integration requested, but to date, no pre-built CMP Java libraries have been identified. If no existing CMP Java client exists that can be used, then we will have to build the API from scratch, which will take time and resources which are in short supply. | We have put the CMP as something we will work on, but cannot commit to. This means it will not likely to be ready in Dublin, but may be ready in El Alto. | There is no contingency plan for the combination of lack of Java Library and lack of time to write the API from scratch . As a Stretch Goal, we can work on this during Dublin after commitments, in hopes of committing for El Alto. |
This Stretch Goal has been Descoped Explanation: Since AAF Certman would be functioning as intermediate to the Certificate Authority, that CA must exist and be deployed in ONAP before serious work can begin. | We cannot commit to anything that is not testable | There is no way to compensate for lack of CMP based CA. Until this is ready, CMP Access cannot be tested, and therefore, cannot be done. If ONAP works on obtaining and running a CMP based CA in Dublin, then there might be a good chance of committing for El Alto. |
RESOURCES
Fill out AAF Resources 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.
It is not expected to have a detailed project plan.
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 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
...
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.