Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add api design #20

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Network Slice Booking API Design

## **Use Cases**
The business modes of Network Slice Booking can be B2B, B2B2C.

Note: Currently, we've come across the following business modes, which can be grouped into these 3 in general. If there's any other modes, please do not hesitate to propose.

**1. Scenario 1 - B2B**

In brief: toB Enterprise customers come to NaaS Platform, book a slice, telecom operator provide the service.

API Provided By: Telecom Operator's NaaS Platform, or Aggregator's NaaS Platform

API Consumer: Enterprise APP Developer

End User: toB Enterprise Customer

Example Use Cases: For enterprise customers, who in the past need to talk to a customer manager, to book a slice service. Now those group of customers may renew, modify, or cancel a slice service within a NaaS Service API call.


**2. Scenario 2 - B2B2C**

In brief: OTT abstract the slice api from NaaS Platform, provide a channel for toC individual customers, to buy a slice from NaaS Plaform.

API Provided By: Telecom Operator's NaaS Platform, or Aggregator's NaaS Platform

API Consumer: APP Developer (eg. OTT)

Slice Product Provider: APP Developer (eg. OTT)

End User: toC APP End Users (eg. Individuals / Influencers / Streaming Studios )

Example Use Cases:
- OTT call the API from any NaaS Platform, in the way of calling Network Slice Booking API.
- OTT abstract the API, make it a Slice Product, provided to toC customers, who are OTT APP End Users.
- End Users buy the service through the APP.
- OTT transfer the request to NaaS Platform.
- Telecom Operators provide the slice service to End Users directly.

**3. Scenario3 - B2B2C**

In brief: OTT buy the slice from NaaS Platform, and resell the slice to toC individual customers.

API Provided By: Telecom Operator's NaaS Platform, or Aggregator's NaaS Platform

API Consumer: APP Developer (eg. OTT)

API Reseller: APP Developer (eg. OTT)

End User: toC APP End Users (eg. Individuals / Influencers / Streaming Studios )

Example Use Cases:
- OTT book slices from any NaaS Platform, in the way of calling Network Slice Booking API.
- OTT may book a bunch of slices of different time and locations at one time.
- Telecom Operators provide slice service for OTT.
- OTT abstract the API to an APP function, and resell the service to End Users. Resell modes depends on OTT itself.
- End Users buy the service from OTT.



## **API Design**

Generally: Split the slice reservation function and device access control function
- API 1:Reserve a slice resource
- API 2:Device Access Management / Manage the access control of devices to the slice
- Note: Basically there should be a CRUD for "Reserve a Slice Resource" and a CRUD for "Manage the access control of devices to the slice".


**API 1:Reserve a slice resource**
- Function:
- Reserve a slice of one selected period and one selected area.
- Device Access Management may happen at any point in time while the resource is in revered-state and in active-state.


**API 2:Device Access Management / Manage the access control of devices to the slice**
- Function:
- Allow API caller manage the access control from devices to the slice.



Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/API_documentation/SliceMode3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions documentation/MeetingMinutes/MOM-2024-07-05.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# CAMARA Network Slice Booking Meeting - MOM-2024-05-24

*Friday, May 24th, 2024*

## Attendees (probably incomplete)
* Fan Yang (China Unicom)
* Dan Xu (China Telecom)
* Shuting Qing (Huawei)
* Jin Xu (Huawei)
* Ricardo Serrano (Telefonica)
* Steve Vickers (Vodafone)
* Thorsten Lohmar (Ericsson)
* Bart van Kaathoven (Ericsson)
* Veerat (Comviva)
* Vidhi Mehta (Comviva)
* Tanja de Groot (Nokia)
* Zach Callahan ()


## Agenda
* Welcome new contributors.
* Issues relevant for v0.1.0
* AOB

## Issues relevant for v0.1.0
* Issue#22 API Design
* For the current architecture part: "NaaS Portal" module is not clear, there are some misunderstandings.
* For the Service API part: questions from participant is clarified and aligned.
* Clarifications on participants questions:
* Arrows marked in camara blue are Service API. Arrows marked in black are other APIs.
* API from both Operator and Aggregator Platform, to Developer are CAMARA service api.
* Below the Operator/Aggregator Platform is transformation function.
* Alignments on the following modifications:
* Use "Operator Platform" to substitute "Operator NaaS Portal" expression.
* Refer to CAMARA slides architecture instead.
* Action points:
* Participant will provide architecture reference link under the PR. Modifications on the graph will start.
* Corresponding modifications towards contexts will be conduct after the graph.

## v0.1.0 Release scope & timeline
* Need to follow up with CAMARA release management.

## AOB
1. The next call will be on Friday, Jun 22th, 16:00 CST / 10:00 CET