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 user story #13

Merged
merged 2 commits into from
May 7, 2024
Merged

Conversation

ShutingQing
Copy link
Collaborator

What type of PR is this?

add user story

Add one of the following kinds:

  • bug
  • correction
  • enhancement/feature
  • cleanup
  • documentation
  • subproject management
  • tests

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

@ShutingQing ShutingQing marked this pull request as ready for review April 28, 2024 08:28
@ShutingQing ShutingQing mentioned this pull request Apr 28, 2024
Copy link
Collaborator

@Kai-hw Kai-hw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

Copy link
Collaborator

@chinaunicomyangfan chinaunicomyangfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look goot to me

@chinaunicomyangfan chinaunicomyangfan merged commit 7a1826d into camaraproject:main May 7, 2024
| API family name | Network Slicing API |
| API family owner | China Unicom, China Telecom, Huawei |
| API family supporter | China Mobile, China Unicom, China Telecom, Huawei, TBD |
| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time:Start Time ~ End Time<br />Service Area:Geographical area (Point, Line, Area)<br />Guaranteed terminals:Number of terminals<br />SLA Targets:SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result: network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled in some place.|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on-demand network slicing service: We should avoid the slogan "on-demand" here to avoid confusion with QOD..

| API family name | Network Slicing API |
| API family owner | China Unicom, China Telecom, Huawei |
| API family supporter | China Mobile, China Unicom, China Telecom, Huawei, TBD |
| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time:Start Time ~ End Time<br />Service Area:Geographical area (Point, Line, Area)<br />Guaranteed terminals:Number of terminals<br />SLA Targets:SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result: network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled in some place.|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SLA assurance expected by developers: This SLA will not only cover the time period and the service area. The commitment should also include the provided service quality.

| API family name | Network Slicing API |
| API family owner | China Unicom, China Telecom, Huawei |
| API family supporter | China Mobile, China Unicom, China Telecom, Huawei, TBD |
| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time:Start Time ~ End Time<br />Service Area:Geographical area (Point, Line, Area)<br />Guaranteed terminals:Number of terminals<br />SLA Targets:SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result: network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled in some place.|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guaranteed terminals:Number of terminals: At time of booking, only an approximate number of terminals may be known.

| API family name | Network Slicing API |
| API family owner | China Unicom, China Telecom, Huawei |
| API family supporter | China Mobile, China Unicom, China Telecom, Huawei, TBD |
| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time:Start Time ~ End Time<br />Service Area:Geographical area (Point, Line, Area)<br />Guaranteed terminals:Number of terminals<br />SLA Targets:SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result: network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled in some place.|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SLA Targets: Suggestion, include the intended service area and time period onto the SLA Target. The provided service is only available during the time period and at the service area.

| API family name | Network Slicing API |
| API family owner | China Unicom, China Telecom, Huawei |
| API family supporter | China Mobile, China Unicom, China Telecom, Huawei, TBD |
| API summary | There are emerging requirements in high-rate time-critical applications in the areas of Cloud-gaming, AR/VR, Live Video Streaming, Real-time Multi-Media etc through mobile networks. The on-demand network slicing service technology can provide a network slice reservation method for such scenarios to meet the SLA assurance expected by developers for a specific time period and a dedicated service area. The Network Slicing API provides such abilities for developers to reserve, dynamically provisioning, query, dynamically destroy a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations and so on. <br /> <br /> Proposed API Definitions <br /> -Input Parameters:<br />Service Time:Start Time ~ End Time<br />Service Area:Geographical area (Point, Line, Area)<br />Guaranteed terminals:Number of terminals<br />SLA Targets:SLA KPIs (such as DL/UL Avg Throughput, Latency) <br /> <br /> -Output Parameters:<br />Slice Reservation Result: network slice reservation success (with Slice ID) or failure. <br /> <br /> An example: a developer may use this API to book a network slice with expected service time, expected service area, expected guaranteed numbers of terminals and expected SLA targets for 2 hours to 2 weeks in advance for some scheduled events like a live stream festival scheduled in some place.|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a developer: Suggestion, only consider the API user / API consumer. The developers will only use the APIs during testing.


**API End Users:**

OTT Customers Eg: Tiktok Influencer Studios
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OTT Customers: Suggestion to rename to 'Tiktok Customer'.

**API End Users:**

OTT Customers Eg: Tiktok Influencer Studios
1. Influencers Companies or Studios may order "Dedicate/Premium Streaming Service" provided by Tiktok.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

order: suggestion to replacer 'order' with 'book'


**API Consumers:**

Enterprises Developer. Eg: TV Station Developer
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TV Station Developer: Suggestion to replace with "TV Station" or "News Company". They are likely NOT doing developments around the API.


Enterprises Developer. Eg: TV Station Developer
1. TV Stations usually have grand TV Live Streaming Business. They need Slice Assurance Services to assure that they have dedicated network resources for their streaming.
2. TV Stations APP developer call Slice Assurance Services provided by Telecom NaaS Platform/Aggregator Platform directly. And developer make it "Streaming Assurance" function on the APP.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TV Stations APP developer: "The Program Director of the TV Station will trigger the call for .."

**API End Users:**

Enterprise. Eg: TV Station
1. Live Video Streaming Team One have a Live Streaming Task. Team One order the "Streaming Assurance" Service on TV Stations APP.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Team One order the "Streaming Assurance" Service on TV Stations APP. suggested rewording: 'The TV producers book the "Streaming Assurance" Services for their TV production teams'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants