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