Versions Compared

Old Version 3

changes.mady.by.user Gregory Glover

Saved on

compared with

New Version Current

changes.mady.by.user Gregory Glover

Saved on

Key

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

...

Project NameEnter the name of the project
Target Release NameEnter the name of the release you are targeting to deliverBeijing
Project Lifecycle StateEither Incubation , Core, Mature.   Refer to ONAP Charter, section 3.3 Project Lifecycle for further information
Participating Company List the company participating in this release. At least 3-4 organizations, including an operator are recommended.AT&T, Amdocs, Huawei, Nokia, China Mobile, Orange, ZTE, Accenture

Scope

What is this release trying to address?

Describe the problem being solved by this release

Use Cases

Describe the use case this release is targeted for (better if reference to customer use case).

Minimum Viable Product

  1. Update project-level documentation for Beijing Release requirements
  2. Improving the Usability of the Platform:
    • Establish consistent tool chain and guidelines for API documentation
    • Create Welcome to ONAP and "sandbox" functionality for novices to ONAP
    • Automate verification process in the CI/CD Documentation tool chain
    • Migrate seed documentation currently in the wiki or gerrit that is being maintained by approved projects
    • Refine / expand current documentation for VNFs, OpenStack interfaces, UIs, and LF Tool Chain
    • Establish feedback mechanisms in Wiki and/or Readthedocs to improve documentation

Use Cases

The documentation created by this project must support ONAP high level Beijing use cases.

Lower level use cases specific to documentation project scope include:

  1. Publish a finished set of formal change-controlled documentation for any user audience working with the ONAP Beijing release.
  2. Establish a consistent method for documenting APIs
  3. Create welcoming documentation and a place to play for novices to ONAP
  4. Create a way for users to provide feedback

Minimum Viable Product

Final documentation for ONAP Beijing Use CasesDescribe the MVP for this release.

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.

...

Jira
serverONAP JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryprojectProject = sanbox and issuetype in (epic)
serverId425b2b0a-557c-3c0c-b515-579789cceedb

Stories

Jira
serverONAP JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject=sanbox and issuetype in (story) Doc and type = EPIC and status = Open
serverId425b2b0a-557c-3c0c-b515-579789cceedb

Stories


Longer term roadmap

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

...

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

To fill out
Required (Level 1)Deliverable Description
Beijing Project-level UpdatesPublished release documentation for all Beijing projects
Stretch Goals (Level 2)Deliverable Description
Content Initiatives
  • Published Guidelines for API documentation
  • Published "Welcome to ONAP" and "sandbox" functionality
  • Migrated seed documentation currently in the wiki or gerrit
  • Refined / expanded documentation for VNFs, OpenStack interfaces, UIs, and LF Tool Chain
Tool Chain Initiatives
  • Tool Chain established for API documentation
  • Refined and hardened CI/CD tool chain and processes
  • Feedback mechanisms implemented in Wiki and/or Readthedocs
Deliverable NameDeliverable Description
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.

Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.

...

Anyone reading this section should have a good understanding of all the interacting modules.




The diagram below illustrates what is accomplished in the setup steps above from the perspective of a file structure created for a local test, a jenkins verify job, and/or published release documentation including:

  • ONAP gerrit project repositories,
  • doc project repository master document index.rst, templates, configuration, and other documents
  • submodules directory where other project repositories and directories/files are referenced
  • file structure: directories (ellipses), files(boxes)
  • references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges)

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
PerformanceN/AN/A
  • 0 -- none
  • 1 – baseline performance criteria identified and measured
  • 2 & 3 – performance improvement plans created & implemented
Stability

N/A


N/A
  • 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
ResiliencyN/AN/A
  • 0 – none
  • 1 – manual failure and recovery (< 30 minutes)
  • 2 – automated detection and recovery (single site)
  • 3 – automated detection and recovery (geo redundancy)
SecurityN/AN/A
  • 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
ScalabilityN/AN/A
  • 0 – no ability to scale
  • 1 – single site horizontal scaling
  • 2 – geographic scaling
  • 3 – scaling across multiple ONAP instances
ManageabilityN/AN/A
  • 1 – single logging system across components; instantiation in < 1 hour
  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability11Usability Initiatives for Beijing (Release 2)
  • 1 – user guide; deployment documentation; API documentation
  • 2 – UI consistency; usability testing; tutorial documentation

...

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API descriptionN/A



  • API Outgoing Dependencies

...

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description
N/A



  • 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, ...).

NameDescriptionVersion
To fill outTo fill outTo fill outN/A

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

...

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 identifiedImpact
To fill outTo fill outN/A

  • Known Defects and Issues

Provide a link toward the list of all known project bugs. JiraserverONAP JIRAcolumnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolutionmaximumIssues20jqlQueryproject=sanbox and issuetype in (bug) serverId425b2b0a-557c-3c0c-b515-579789cceedb



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

To fill out
Risk identifiedMitigation PlanContingency Plan
Scope of release requirementsComplete and Interlock on Release IndexTo fill outTo fill out
Availability of contributorsRecruit resources as neededAdjust scope & deliverables accordingly

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

...