Versions Compared

Key

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

...

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 


Documenting ONAP APIs

Key Contacts -  Andy Mayer

Guilin Proposed Requirements 

Also see: Developing ONAP API Documentation

Executive Summary - Improve ONAP API Documentation:

  • Developer Friendly
  • Non-Developer Friendly
  • Easy to Find & Easy to Navigate
  • Common and Uniform Documentation Structure and Approach
  • Provides Information on Using the API (e.g., quick start)
  • Try It For Yourself (TIFY) Examples

Proposed non-functional requirements for Guilin release:

  1. All components should place externally facing (i.e. interfaces exposed by the ONAP component to either other ONAP components or components external to ONAP) API definitions (e.g. Swagger) in a common path within their Gerrit/Git 
    Suggested Path: <Component>/docs/api/swagger/
  2. Apply ReDoc to Swagger and place HTML in Readthedocs for the release
  3. Apply Minimum (Phase 1+) swagger guidelines

    1. See: Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
    2. Use the common insert for the info section (e.g., license info, contact info, etc): Swagger Insert Sample for Info Section

Business Impact - Enables developers, operators and service providers to use leverage ONAP; Improve integration velocity for API client developers; Ease development handoffs; 

Business Markets - All  developers,operators and service providers can leverage ONAP APIs 

Funding/Financial Impacts - Reduction in development and integration expense from using well defined open Interfaces.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 


ONAP installation shall be deterministic

Key Contacts - Alessandro D'Alessandro

Executive Summary - the result of ONAP installation is not yet deterministic. That also refer to the re-installation of single ONAP component.

Proposed non-functional requirements for Guiling release:

  1. ONAP installation shall be determinstic at k8s level with 99% success rate  (e.g. all POD are up and running)
  2. ONAP installation shall be deterministic at functional level with 97% success rate (e.g. all functional modules are up and running, APIs are responsiveness, etc)
  3. ONAP installation shall be determinstic at service level with 95% success rate (e.g. a service can be designed, distributed and deployed successfully)
  4. same requirements when a single functional module is re-installed 

Business Impact - Enables operators and service providers opex saving  

Business Markets - All operators and service providers can leverage the benefit of a deterministic installation 

Funding/Financial Impacts - Reduction in operations expense 

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.