Page History

External API Requirements for supporting Inter-Provider API

Roles / Actors

• • SP A(ONAP deployment)
    • Administrator: Manages lifecycle of Services
    • Operation Engineer: Manages operational tasks like distribution of packages, manage/process work orders
    • Designer: Onboard VNF packages and designs Service Package
    • Tester: Verifies the Service package and approves the package for distribution
  • SP B (assuming anon-ONAP deployment)
    • Administrator: Manages the lifecycle of services
    • OperationEngineer:Managesoperational tasks
  • Partner A (assuming an ONAP deployment)
    • same as for ONAP SP
  • Partner B (assuming anonONAP deployment)
    • Administrator: Manages lifecycle of Services
    • OperationEngineer :Manages Operational

Types of Interactions

General User Stories

1. As a Designer in SP A ONAP, I shall be able to design a hybrid service with constituent services that may be realized by SP and Partner, so that I can represent services in an abstract model which may be used by the ONAP runtime environment.
2. As a designer of theSP A ONAP I shall be able to represent the policy and security credentials in the partner service abstract model to access the partner API gateway (the equivalent of Ext-API on the partner side) so that unauthorized access to partner domain can be avoided
3. As a designer of SP AONAPI shall be able to represent the URL of the Partner API gateway in the partner service abstract model so that reachability to partner API gateway can be ensured.
4. As an Operation engineer of SP A ONAP I shall be able to register Partner API gateway on the A&AI Inventory so that reachability information to Partner can be configured on demand
5. As an administrator of SP A ONAP I shall be able to query onboarded Services in the Partner Service Catalog via theSP A External API exposed REST APIs so that the correct service specification can be verified with the abstract model maintained locally
6. As an administrator of SP A ONAP I shall be able to query the instantiated services in the Partner Service Inventory via theSP A External API exposed REST APIs so that state, configured service characteristics of the instantiated services can be verified and reconciled with the local inventory.
7. As an administrator ofSPA ONAP I shall be able to place a request for Service Configuration on Partner API gateway via theSP A External API exposed REST APIs with appropriate Service Characteristics associated and as defined in a Service Specification, so that desired end to end service requirement can be fulfilled.
8. As an administrator of SP A ONAP I shall be able to control and enforce the policies for accessing the Partner API gateway from SP A External API so that I can manage the ongoing operational requirements.
9. As an administrator of SP A ONAP I shall be able to filter the API requests on SP A External API and as needed and forwarded to Partner API Gateway so that SP A runtime components are not loaded andrealtimePartner Service state can be realized and reconciled.
10. As an administrator of SP A ONAP I shall be able to register for Service notification on the Partner API gateway for receiving any notifications related to Service Configuration and Control Request so that requests placed on the Partner domain can be monitored in an asynchronous manner
11. As an administrator of SP A ONAP I shall be able to manage life cycle of collectors for receiving the performance related statistics (this can be SLA update) from the Partner API gateway so that performance metrics associated with Partner Services can be collected on demand
    
    

Service Configuration and Control Stories

1. As a designer of SP A or Partner A ONAP, I shall be able to identify and represent service characteristics that can be modified on demand so that any unnecessary service impacting changes can be avoided
2. As a designer of SP A or Partner A ONAP, I shall be able to identify and represent service characteristics which are service impacting so that unnecessary service impacting changes can be avoided
3. As an administrator of SP A ONAP I shall be able to schedule Service Configuration request through SP A External API to be executed and forwarded to Partner API gateway so that I can ensure optimal execution of request based on the desired condition.
4. As an administrator of SP A ONAP I shall be able to lock or unlock a partner service configuration and control through SP A External API REST API so that any service impacting Service configurations can be avoided
5. As an administrator of SP A ONAP I shall be able to assign ownership of the Partner Service (Partner owned, configured or SP owned configured) to SP A or Partner so that Service updates are not carried out in a consistent manner
6. As an administrator of SPA ONAP Is hall be able to activate or deactivate a Service on the Partner domain via theSP A External API exposed REST APIs so that the partner services can be used during desired period and desired condition.
7. As an administrator of SP A ONAP I shall be able to check the status of a Service Configuration and Control request placed on the Partner API gateway in an asynchronous manner so that state of the service can be updated in inventory
8. As an administrator of SP A ONAP I shall be able to retry a Service Configuration and Control request on the Partner API gateway or recover from error by executing a predefined recovery logic so that Service jeopardy condition can be mitigated.
   
   

S3P Requirements

Component Specific Requirements