Skip to content

Commit d0b454b

Browse files
1 parent cf80523 commit d0b454b

File tree

1 file changed

+55
-54
lines changed

1 file changed

+55
-54
lines changed

code/API_definitions/Traffic_Influence.yaml

+55-54
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ info:
1919
operator's EdgeCloud may comprise multiple Edge Cloud Zones, each in a
2020
discrete location to bring latency benefits to end users across a country.\
2121
The operator can help developers know which of the Edge Cloud Zones will
22-
bring the best performance benefit for a given end user and application\.
23-
The Traffic Influence API (TI API) provides the fastest routing from the
22+
bring the optimal performance for a given end user and application\.
23+
The Traffic Influence API (TI API) provides the optimal routing from the
2424
user Device (e.g. a Smartphone) to the optimal EAS instance in a specific
2525
geographical location, installed in an Edge Cloud Zone.\
2626
If a Service is offered by Cloud Instances and by Edge Instances, the TI API
@@ -34,25 +34,26 @@ info:
3434
the TI API can be invoked to get the optimal routing in the new geographical
3535
location for that Device.
3636
## Introduction
37-
The TI API provides the capability to establish the best routing, in terms
38-
of latency, in a specific geographical area, between the user Device, e.g.
39-
the user’s smartphone, and the optimal EAS instance nearby. If the Device
40-
moves in a different geographical location where a more suitable EAS
37+
The TI API provides the capability to establish the optimal routing, in
38+
terms of latency, in a specific geographical area, between the user Device,
39+
e.g. the user’s smartphone, and the optimal EAS instance nearby. If the
40+
Device moves in a different geographical location where a more suitable EAS
4141
instance is available, the TI API can be invoked to influence the Device
42-
connectivity to get the optimal routing to the that local instance. It is i
43-
mportant to notice that it is a task of the Application invoking the TI API
42+
connectivity to get the optimal routing to the that local instance. It is
43+
important to notice that it is a task of the Application invoking the TI API
4444
to detect the changes in the Device location.\
4545
The generic architecture for the Service can foresee some Cloud instances of
46-
the Application, one or more Edge Instances of the Application. A component
47-
of the Service is the TI API Consumer. This logical component can be
48-
integrated in other components of the Service to invoke the TI API, creating
49-
a "TrafficInfluence" resource specifying the desired intent.\
46+
the Application, one or more Edge Instances of the Application. The TI API
47+
Consumer invokes the TI API creating a "TrafficInfluence" resource
48+
specifying the desired intent.\
5049
The TI API Producer implements the intent specified in the
5150
"TrafficInfluence" resource.\
5251
While the TI API can be invoked to activate the fastest routing for any
53-
user, it can also be used to request the best routing for a specific user.
54-
Invoking the TI API for each user, many "TrafficInfluence" resources are
55-
created for each user to provide the requested routing for a set of users.\
52+
user, it can also be used to request the best routing for a specific user
53+
also specifying,as an option, a source public port and a destination public
54+
port. Invoking the TI API for each user, many "TrafficInfluence" resources
55+
are created for each user to provide the requested routing for a set of
56+
users.\
5657
The same approach is used for the geographical locations where the influence
5758
of the traffic must be applied. Invoking the TI API without specifying a
5859
geographical area activates the optimal routing toward any EAS instance,
@@ -70,10 +71,9 @@ info:
7071
available, it can invoke the TI API to get the optimal routing toward
7172
that EAS instance.
7273
If the Device moves to another geographical location, served by another
73-
EAS instance, the routing might not be optimal anymore for the new EAS
74-
instance. In the case the Application detects a location change, it can
75-
invoke the TI API again to request a new routing optimization toward
76-
the new EAS instance.
74+
EAS instance, the routing might not be optimal anymore. In the case the
75+
Application detects a location change, it can invoke the TI API again to
76+
request a new routing optimization toward the new EAS instance.
7777
## Quick Start
7878
The usage of the TI API is based on the management of a "TrafficInfluence"
7979
resource, an object containing the intent requested invoking the TI API and
@@ -114,26 +114,25 @@ info:
114114
Unique identifier for the TI API Consumer.\
115115
\
116116
**region:**
117-
The developer can specify in which geographical area he requires the fastest
118-
routing toward the nearest application instance. A "region" is a wide
117+
The Developer can specify in which geographical area he requires the optimal
118+
routing toward application instances running there. A "region" is a wide
119119
geographical area and it contains one or more "zones". A "zone" is where the
120120
Edge Cloud Zone is located. Zones and Regions identifiers are defined and
121121
provided by the Telco Operator and can also be used or retrieved with other
122122
CAMARA APIs (“MEC Exposure & Experience Management API” and “Simple Edge
123123
Discovery”). To add more regions the TI API must be invoked (POST) for each
124-
region. New "TrafficInfluence" resources are created (with different
125-
"trafficInfluenceID"). All the created resources are aggregated by the
126-
Application (identified by "appId").\
124+
region. If in a "region" there are many Application instances active in
125+
different "zones", the TI API can be invoked to configure the optimal routing
126+
for all the instances with just one API call specifying the region. If just
127+
the Application instances in some regions must be affected, the TI API can be
128+
invoked for the regions of interest, without specifying "zone" in the API call.
129+
If just some specific Application instance must be affected, it is not required
130+
to specify any "region" or "zone", the parameter "appInstanceId" can be used.\
127131
\
128132
**zone:**
129-
The developer can specify in which geographical area he requires the fastest
130-
routing toward the nearest Application instance. A "zone" is a smaller
131-
geographical area inside a "region". A "zone" is where the Edge Cloud Zone
132-
is located.\
133-
To add more zones the TI API must be invoked (POST) for each "zone".
134-
New "TrafficInfluence" resources are created (with different
135-
"trafficInfluenceID"). All the created resources are aggregated by the
136-
Application (identified by "appId").\
133+
A "zone" is a smaller geographical area inside a "region". A "zone" is where
134+
the Edge Cloud Zone (th data center) is located.\
135+
To add more zones the TI API must be invoked (POST) for each "zone".\
137136
\
138137
**appId:**
139138
A globally unique identifier associated with the application. This
@@ -144,13 +143,15 @@ info:
144143
\
145144
**appInstanceId:**
146145
A globally unique identifier generated by the Operator Platform to identify
147-
a specific instance of the Application on a specific zone. To influence a
148-
traffic toward a specific Application instance.\
146+
a specific instance of the Application in a specific zone. To influence a
147+
traffic toward a specific Application instance. If just some specific
148+
Application instance must be affected, it is not required to specify any
149+
"region" or "zone", the parameter "appInstanceId" can be used.\
149150
\
150151
**sourceTrafficFilters:**
151-
The traffic can be from a specific port in the device. If this parameter is
152-
used, the influenced flow is from the port defined in "sourceTrafficFilters"
153-
rathar than the port specified in "Device"\
152+
The traffic can be from a specific public port in the device. If this
153+
parameter is used, the influenced flow is from the public port defined in
154+
"sourceTrafficFilters" rathar than the public port specified in "Device"\
154155
\
155156
**destinationTrafficFilters:**
156157
The Application can expose different service on different interfaces,
@@ -166,21 +167,22 @@ info:
166167
the Device) and the public (as seen over Internet by a server connected to
167168
the Device) can be used. To add more users the TI API must be invoked (POST)
168169
of each user Device. New "TrafficInfluence" resources are created (with
169-
different "trafficInfluenceID"). All the created resources are aggregated by
170-
the Application (identified by "appId"). The routing toward the selected
171-
Application instance is only applied for provided user Devices. "publicPort"
172-
can be used to identify the device. "publicPort" can be also used to
173-
identify the flow to be influenced. If the flow to be influenced is from a
174-
different port, "sourceTrafficFilters" can be used.\
170+
different "trafficInfluenceID"). The routing toward the selected Application
171+
instance is only applied for provided user Devices. "publicPort" can be used
172+
to identify the device. "publicPort" can be also used to identify the flow
173+
to be influenced. If the flow to be influenced is from a different public
174+
port, "sourceTrafficFilters" can be used.\
175175
\
176176
**Notification URL and token:**
177-
Developers have a chance to specify call back URL on which notifications
178-
(e.g. session termination) regarding the session can be received from the
179-
service provider. This is also an optional parameter.
177+
Developers can specify a callback URL on which notifications
178+
regarding the requested intent can be received. For example to be notified
179+
when the requested optimal routing is active.
180180
## Authentication and Authorization
181181
CAMARA guidelines defines a set of authorization flows which can grant API
182182
clients access to the API functionality, as outlined in the document
183-
[CAMARA-Security-Interoperability.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md).
183+
[CAMARA-API-access-and-user-consent.md](https:\
184+
//github.com/camaraproject/IdentityAndConsentManagement/blob/main/\
185+
documentation/CAMARA-API-access-and-user-consent.md).
184186
Which specific authorization flows are to be used will be determined during
185187
onboarding process, happening between the API Client and the Telco Operator
186188
exposing the API, taking into account the declared purpose for accessing the
@@ -221,12 +223,11 @@ info:
221223
invoked with a user Device identifier (“Device”). For each user Device,
222224
a TI API invocation is required.
223225
## Release Notes
224-
The Traffic Influence API reduces the complexity of the 3GPP Traffic
225-
Influence API exposed by the 3GPP Network Exposure Function (NEF) [1]. While
226-
the 3GPP TI API offers fastest routing activation and user mobility among
227-
different edge sites, this version of the CAMARA Traffic Influence API
228-
covers only the fastest routing activation, also for selected users.
229-
User mobility will be introduced in a future version.\
226+
The Traffic Influence API reduces the complexity of activating the optimal
227+
routing toward an Application Instance and o provides the optimal routing for
228+
an user moving among geographical areas maybe served by different Application
229+
instances. In this release it is up to the API Consumer to detect the user
230+
moving among geographical areas.\
230231
\
231232
**Enhancements with respect to the previous release V0.8.1:**
232233
- These release also effects existing data sessions
@@ -658,7 +659,7 @@ components:
658659
- 'deletion in progress'
659660
- 'deleted'
660661
sourceTrafficFilters:
661-
description: Port used locally by the device for flows to which
662+
description: Public source port used by the device for flows to which
662663
the requested traffic influence should apply. Traffic influence will
663664
be applied to the flow between "sourcePort" and the Application
664665
Server address and port specified in "destinationTrafficFilters".

0 commit comments

Comments
 (0)