External API Requirements for supporting Inter-Provider APIRoles / 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)
- Partner B (assuming anonONAP deployment)
- Administrator: Manages lifecycle of Services
- OperationEngineer :Manages Operational
Types of InteractionsImage Modified Scenario 1: Both SP and Partner have ONAP Scenario 2: SP uses Non-ONAP solution and Partner uses ONAP (SP is the Master for all interactions - ONAP at Partner domain is Subordinate) Scenario 3: SP uses ONAP solution and Partner uses non-ONAP solution (SP is Master) General User Stories- As a Designer in SP A ONAP, I shall be able to design a composite hybrid service with constituent services that may be realized by SP and or Partner, so that I can represent services in an abstract model which may be used by the ONAP runtime environmentdesign the services as per business need.
- As a designer of theSP the SP A ONAP I shall be able to represent the policy and access mechanism with end-point URL, 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
- As a designer of SP AONAPI A ONAP I 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 ensuredcreate configuration policies that represent access rights, allowed management operations, overall interaction controls so that I can abide by the business agreement between the SP and Parties.
- As an Operation engineer of SP A ONAP I shall be able to dynamically register Partner API gateway on the A&AI Inventory so that reachability information to Partner can be configured on demand
- As an administrator of SP A ONAP I shall be able to query onboarded on boarded Services in the Partner Service Catalog via theSP the SP A External API exposed REST APIs so that the correct service specification can be verified with the abstract model maintained locally
- As an operation engineer of SP A or Partner A ONAP, I shall be able to configure the services set of management operations that can be accessed on the partner side, so that unsubscribed service operation access can be avoided
- As an administrator of SP A ONAP I shall be able to query the instantiated services in the Partner Service Inventory via theSP the SP 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.
- As an administrator ofSPA of SPA ONAP I shall be able to place a request for Service Configuration on Partner API gateway via theSP the SP 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.
- 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.
- As an administrator operations engineer of SP A ONAP I shall be able to define the filter and transformation rules that govern 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 reconciledso that I can route the request to appropriate domain.
- 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
- 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- As a designer an operations engineer of SP A or Partner A ONAP, I shall be able to uniquely identify and represent service characteristics that can be modified on demand Service models in the SP domain and Partner domain so that any unnecessary service impacting changes can be avoidedinternal changes to service models is handled by appropriate mapping within respective domains.
Service Configuration and Control Stories- As a designer of SP A or Partner A ONAP, I shall be able to identify and represent service characteristics which are service impacting that can be modified on demand so that any unnecessary service impacting changes can be avoided
- 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.
- 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 or simultaneous access by multiple users can be avoided
- As an administrator of SP A ONAP I shall be able to assign ownership mastership 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
- As an administrator of SP A or Partner A ONAP, I shall be able to check the feasibility of Service configuration and control on the Partner domain so that I can ensure that the subsequent configuration request can be fulfilled without issue
- As an administrator of SPA ONAP Is hall be able to activate or deactivate a Service on the Partner domain via the SP A External API exposed REST APIs so that the partner services can be used during desired period and desired condition.
- 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 the inventory
- 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 the error by executing a predefined recovery logic so that Service jeopardy condition can be mitigated.
S3P Requirements
Component Specific Requirements (To be elaborated in detail later)ONAP Component | Requirement No |
---|
Ext-API | - API support for Service Configuration and Control - TMF 641 (or TMF 655)
- Integration with Policy Engine to check the Partner API access policies
- Integration with OOF to schedule Service Configuration
- Integration with SO to invoke Service Configuration Operation
- Integration with SDC Catalog to fetch Service Model details
- Integration with A&AI to check and update the Partner service status
| SO | - Support for Service Modification API for end to end and nested service through a Patch or Put Request
- Handling of Service Modification request with appropriate workflow invocation (dynamic or static workflow)
- Management of Service Modification jeopardy conditions - additional workflow
| SDC |
| Policy |
| OOF |
|
|