...
| 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 | Application Authorization Framework |
|---|---|
| Target Release Name | Amsterdam Release |
| Project Lifecycle State | incubation |
| Participating Company | AT&T, ZTE & IBM |
Scope
What is this release trying to address?
Organize software authorizations so that applications, tools and services can match the access needed to perform job functions. AAF is designed to cover Fine-Grained Authorization, meaning that the Authorizations provided are able to use an Application's detailed authorizations, such as whether a user may be on a particular page, or has access to a particular Pub-SUB topic controlled within the App.
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).Use Case: vFW/vDNS (Approved)
Use Case: Residential Broadband vCPE (Approved)
Minimum Viable Product
Describe the MVP for this releaseProvide authentication and authorization.
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=aaf and issuetype in (epic) 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=sanbox aaf and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
Provide authentication and authorization support for ONAP projects. Add certificate manager which will be used to create certificates.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|---|
| cadi-authz | Source Code / Executable |
| cadi-client | Source Code / Executable |
| cadi-core | Source Code / Executable |
| cadi-cass | Source Code / Executable |
| AAF | Docker Image |
| REST API | Source Code / API description |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
None
Architecture
High level architecture diagram
.png?version=1&modificationDate=1499811765000&cacheVersion=1&api=v2&width=850)
API Incoming Dependencies
List the API this release is expecting from other releases.
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) |
|---|---|---|---|---|
API Outgoing Dependencies
API this release is delivering to other releases.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | Any project can use AAF|
|---|---|---|---|---|---|
| DMaaP | DMaaP API | ||||
| CLI |
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, ...).
...
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
- Unit tests are run automatically 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.
- Functional testing will occur to ensure that the use cases are functioning correctly.
- SonarQube will be used to test coverage report.
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).
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| To fill out | To fill out | To fill out |
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 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. |
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.
...