Update branch references
[integration.git] / docs / docs_E2E_network_slicing.rst
1 .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
2 .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
3
4 .. contents::
5    :depth: 3
6 ..
7 .. _docs_E2E_network_slicing:
8
9
10 E2E Network Slicing Use Case
11 ============================
12
13 Overall Blueprint
14 -----------------
15
16 The objective of this use case is to realize End-to-End 5G Network
17 Slicing using ONAP. An End-to-End Network Slice consists of RAN (Radio
18 Access Network), Transport Network (TN) and Core Network (CN) slice
19 sub-nets. This use case intends to demonstrate the modeling,
20 orchestration (life cycle and resources) and assurance of a network
21 slice which are implemented in alignment with relevant standards. The
22 key highlights of this use case include:
23
24 -  Modular architecture providing building blocks and flexibility under
25    various deployment scenarios
26
27 -  Functionality aligned with 3GPP and other relevant standards such as
28    ETSI and IETF
29
30 -  Interfaces and APIs aligned with relevant standards (3GPP, IETF,
31    ETSI, TM Forum, etc.) while enabling easy customization through use
32    of appropriate plug-ins. This would enable easier interoperability of
33    slice management functions realized within ONAP with 3\ :sup:`rd`
34    party slice management functions, as well as northbound and
35    southbound systems.
36
37 -  Taking a step-by-step approach to realizing different architectural
38    options in an extendable manner.
39
40 -  Providing flexibility in network slice selection by providing an
41    option of manual intervention, as well as abstracting the network
42    internals as needed.
43
44 -  The use case implementation team is composed of service providers,
45    software and hardware vendors, solution providers and system
46    integrators thereby taking into consideration different perspectives
47    and requirements.
48
49 This use case is a multi-release effort in ONAP with the first steps
50 taken in Frankfurt release. It will continue to expand in scope both in
51 breadth and depth, and along the journey it shall also align with
52 updates to the relevant standards which are also currently evolving.
53 This use case shall also collaborate with other open initiatives such as
54 O-RAN to enable wider adoption and use.
55
56 Further details can be obtained from:
57 https://wiki.onap.org/display/DW/Use+Case+Description+and+Blueprint
58
59
60 Abbreviations
61 -------------
62
63 +---------------+--------------------------------------------+
64 |  Abbreviation |                   Meaning                  |
65 +===============+============================================+
66 | CSMF          | Communication Service Management Function  |
67 +---------------+--------------------------------------------+
68 | CSI           | Communication Service Instance             |
69 +---------------+--------------------------------------------+
70 | CST           | Communication Service Template             |
71 +---------------+--------------------------------------------+
72 | NSI           | Network Slice Instance                     |
73 +---------------+--------------------------------------------+
74 | NSMF          | Network Slice Management Function          |
75 +---------------+--------------------------------------------+
76 | NSSI          | Network Slice Sub-net Instance             |
77 +---------------+--------------------------------------------+
78 | NSSMF         | Network Slice Sub-net Management Function  |
79 +---------------+--------------------------------------------+
80 | NST           | Network Slice Template                     |
81 +---------------+--------------------------------------------+
82 | NSST          | Network Slice Sub-net Template             |
83 +---------------+--------------------------------------------+
84
85
86 Scope for Frankfurt
87 -------------------
88
89 To realize the three layers of the slice management function, we need to decide whether to implement CSMF, NSMF or NSMF within ONAP, or use the external CSMF, NSMF or NSSMF. This implies that for ONAP-based network slice management, we have different choices from an architectural perspective. For Frankfurt release, our scope is to implement CSMF and NSMF within ONAP, while connecting to an external Core NSSMF.
90
91 From the NSI Life Cycle perspective, the scope for Frankfurt includes NSI design and pre-provision, NSI instantiation and configuration, and NSI activation and deactivation. In particular:
92
93 - CSMF: Functions of slice service creation, slice service activation and deactivation are implemented.
94
95 - NSMF: Functions of NSI instantiation, NSI activation and deactivation are
96   implemented. In addition, manual intervention is also provided in NSMF slice task
97   management portal to ensure the selected NSI/NSSI as well as ServiceProfile and
98   SliceProfile are fine or need adjustment.
99
100 - Design of CST, NST and onboarding NSST that are required to support the run-time   orchestration functions is also provided.
101
102 - To connect to the external (core) NSSMF, an adaptor is implemented to provide
103   interface between ONAP and 3rd party core NSSMF.
104
105 To support the above functions, code impacts in U-UI, SO, OOF and ExtAPI components, and schema change in A&AI are implemented.
106
107 Further details can be obtained from:
108 https://wiki.onap.org/display/DW/Proposed+Functions+for+R6+and+Impacted+Modules
109
110
111 Impacted Modules for Frankfurt
112 ------------------------------
113
114 SO
115 ~~
116
117 CSMF and NSMF are implemented using SO BPMN workflows to support 5G
118 network slicing use case. CSMF workflow will process the user input
119 (service request) that comes from CSMF portal (UUI) and save the order
120 information into a communication service instance in AAI. Then CSMF will
121 send network slice request to NSMF workflow, and NSMF will then create
122 service profile, NSI and NSSI. Service profile is a logical concept
123 which exists only in AAI - it contains two AAI instances, one is a
124 profile instance that will hold the slice parameters, and the other is a
125 service instance which will be used to organize the NSI. NSI is also a
126 service instance in AAI which will be used to organize NSSI. NSSI is the
127 actual entity which will be created by NSSMF and an AAI service instance
128 will also be created to represent NSSI in ONAP context. NSI and NSSI can
129 both be shared.
130
131 SO queries OOF for slice template selection and then slice instance
132 selection. In response to slice instance selection query, OOF may return
133 an existing slice instance or may recommend SO to create a new slice
134 instance. A new process called Orchestration Task is created to manage
135 recalibration of NSI&NSSI selection with manual intervention from the
136 portal. A new SO adapter is created to be the adapter of NSSMF which
137 will interact with external NSSMF for NSSI management.
138
139 Further details can be obtained from:
140 https://wiki.onap.org/display/DW/SO%3A+Impacts+and+Interfaces
141
142 U-UI
143 ~~~~
144
145 Usecase-UI (UUI) has added CSMF and NSMF portal components to ONAP to
146 support this use case.
147
148 CSMF component includes the functions of creating network slicing, as
149 well as displaying and processing all the created network slices. The
150 customers need to fill the create communication service form to create a
151 network slice and then they can see the created network slice in the
152 list and execute operations of activating, deactivating or terminating
153 the network slice.
154
155 NSMF component mainly includes two modules: slicing task management and
156 slice resource management which provides the functions of displaying and
157 processing all the slicing tasks and slice resources. In slicing task
158 management module, network operators can find all the slicing tasks
159 created by customers in CSMF component and executing proper operations
160 according to different task status. In slice resource management module,
161 there are three sub-modules which provide the functions of displaying
162 and processing the existing NS, NSI and NSSI. In addition, the NSMF
163 component provides the monitoring function so that users can check the
164 statistics of network slices. In this page, the statistics of slice
165 usage (traffic), online users and total bandwidth can be monitored and
166 displayed in the form of pi-charts and lines.
167
168 Further details can be obtained from:
169 https://wiki.onap.org/display/DW/UUI%3A+Impacts
170
171 OOF
172 ~~~
173
174 For this use case OOF introduced two APIs which are used by SO, one for
175 slice template selection, and another for NSI/NSSI selection. Within
176 OOF, both the OSDF and HAS sub-components were enhanced for this use
177 case. OSDF maps the new API request contents to the appropriate format
178 for HAS to perform the optimization. After the optimization is done by
179 HAS, OSDF maps the response in the API response format as expected by
180 SO. Further, HAS always returns NSSI info (when existing NSSIs can be
181 reused) and OSDF then determines whether it refers to reuse of an
182 existing NSI or creation of a new NSI, and then prepares sends the
183 response to SO.
184
185 HAS sub-component of OOF has been enhanced to use a couple of new policy
186 types, the AAI plug-in within HAS was enhanced to fetch the slice and
187 slice sub-net related details from AAI. Two new plug-ins were developed
188 in HAS – one for fetching slice templates and another for generating
189 slice profile candidates. Existing policies were reused and suitably
190 adapted for constraints and optimal selection of slice template and
191 slice instance. In case of new NSSI creation, HAS returns appropriate
192 slice profile for the sub-net for which a new NSSI has to be created.
193
194 Further details can be obtained from:
195 https://wiki.onap.org/display/DW/OOF%3A+Impacts+and+Interfaces
196
197 EXT-API
198 ~~~~~~~
199
200 The EXT-API has undergone some minimal enhancements for this use case in
201 Frankfurt release. A new value “CST” for the serviceType attribute in
202 the Service Order API has been introduced.
203
204 The CSMF Portal in UUI captures the values for the requested
205 serviceCharacteristics that are required as inputs to CST Service model.
206 The relatedParty attribute in the Service Order is set according to the
207 Customer, where relatedParty.id will map to the AAI "global-customer-id“
208 in the “customer” object. The serviceSpecification.id is to be set to
209 the UUID of the CST from SDC (i.e., this is the template for the Service
210 we are ordering from CSMF). The action field will be set to “add” to
211 indicate creation of a new service instance. CSMF Portal in UUI then
212 sends POST with the JSON body to /{api_url}/nbi/api/v4/serviceOrder/.
213 ExtAPI will generate a Service Order ID and send it in the response –
214 this ID can be used to track the order. ExtAPI will then invoke SO’s API
215 for creating the service.
216
217 As can be seen from above explanation, the existing constructs of ExtAPI
218 has been reused with minor enhancements.
219
220 Further details can be obtained from:
221 https://wiki.onap.org/display/DW/ExtAPI%3A+Impacts+and+Interfaces
222
223 A&AI
224 ~~~~
225
226 To support this use case,A&AI module has added 3 new nodes
227 (Communication-service-profile, Service-profile and
228 Slice-profile),modified service-instance nodes, added 3 new nodes as
229 new attributes of service-instance node. To map to SDC templates
230 (Communication Service Template/Service Profile
231 Template/NST/NSST),run-time instances of this use case have
232 Communication Service Instance/Service Profile Instance/NSI/NSSI. To
233 align with ONAP’s model-driven approach, this use case reuses
234 "service-instance" for all run-time instances. The relationship between
235 service-instances use the existing attribute "relationship-list" or
236 "allotted-resources". Communication-service-profile means the original
237 requirement of Communication-service-instance, such as latency,
238 data-rate, mobility-level and so on. Service-profile means the slice
239 parameter info of Service-profile-instance. Slice-profile holds the
240 slice sub-net parameter info of different network domain NSSIs, such as
241 (Radio) Access Network (AN), Transport Network (TN) and Core Network
242 (CN) NSSI.
243
244 A&AI provides query APIs to CSMF and NSMF, such as:
245
246 -  Query
247    Communication-service-instances/Service-profile-instances/NSI/NSSI
248
249 -  Query Service-profile-instance by specified
250    Communication-service-instance
251
252 -  Query NSI by specified Service-profile-instance, query NSSI by
253    specified NSSI.
254
255 A&AI also supply creation APIs to SO, such as:
256
257 -  Create Communication-service-profile/Service-profile/Slice-profile,
258    and
259
260 -  Create relationship between service-instances.
261
262 Further details can be obtained from:
263 https://wiki.onap.org/pages/viewpage.action?pageId=76875989
264
265
266 Functional Test Cases
267 ---------------------
268
269 The functional testing of this use case shall cover creation and
270 activation of a service with an E2E Network Slice Instance which
271 contains a Core Slice Sub-net instance. It also addresses the
272 termination of an E2E Network Slice Instance. It covers the following
273 aspects:
274
275 -  Creation of a new customer service via CSMF portal in UUI resulting
276    in creation of a new NSI
277
278 -  Creation of a new customer service via CSMF portal in UUI resulting
279    in re-use of an existing NSI
280
281 -  Activation of a customer service via CSMF portal in UUI
282
283 -  Creation of a new customer service via postman request to EXT-API
284    resulting in creation of a new NSI
285
286 -  Creation of a new customer service via via postman request to ExtAPI
287    resulting in re-use of an existing NSI
288
289 -  Manual intervention via NSMF portal during NSI selection (NSI
290    selection adjustment)
291
292 -  Termination of a NSI and associated NSSI
293
294 -  Interaction between ONAP and external NSSMF for new core NSSI
295    creation
296
297 -  Checking inventory updates in AAI for NSIs, service and slice
298    profiles and NSSIs.
299
300 Further details can be obtained from:
301 https://wiki.onap.org/display/DW/Functional+Test+Cases
302
303
304 Operation Guidance
305 ------------------
306
307 How to install 5G E2E Slicing Minimum Scope
308 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
309 For 5G E2E Slicing use case, we support the minimum-scope installation
310 of ONAP to reduce the resource requirements. From the module
311 perspective, 5G E2E Slicing use case involves SDC, SO, A&AI, UUI,
312 EXT-API, OOF and Policy modules of ONAP. So we will configure these
313 required modules along with the mandatory common modules such as DMaaP.
314 Further, for each module, the use case also does not use all of the
315 charts,so we removed the not needed Charts under those modules to
316 optimize the resources required for setting up the use case. This
317 approach will help to install a minimum-scope version ONAP for 5G E2E
318 Slicing use case.
319
320 Further details of the installation steps are available at:
321 https://wiki.onap.org/display/DW/Install+Minimum+Scope+ONAP+for+5G+Network+Slicing
322
323
324 Configuration aspects
325 ~~~~~~~~~~~~~~~~~~~~~
326 The template design, UI configuration, as well as manual configurations for some
327 of the components are all described in the following wiki page and its sub-pages:
328 https://wiki.onap.org/display/DW/Operation+Guidance+for+5G+Network+Slicing+Use+Case