blob: df751dd439ba3fb410c61d7c4064833388612d53 [file] [log] [blame]
ajayb3f40982021-12-08 14:26:11 -08001..
2 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
ajayd19711c2021-12-07 12:07:04 -08005Configuration Overview
6======================
ajay60fd69f2021-11-23 22:38:10 -08007
ajayb5ad6db2021-12-09 15:23:24 -08008SD-Core has been developed with a cloud-based deployment and consumption model as
9its foundation. It has a rich and extensible set of APIs to allow for runtime configurability of
10subscriber management, access management, session management, and network slice
11management. This configuration may be conducted via ONFs Runtime Operational Control
12(ROC) platform directly for consumption as a cloud-managed service, or the APIs can be
13used by third-party automation and management platforms.
14
ajay2c0f6f42021-12-02 22:45:19 -080015Reference helm chart
16--------------------
ajay60fd69f2021-11-23 22:38:10 -080017
ajay2c0f6f42021-12-02 22:45:19 -080018 - `SD-Core Helm Chart Repository <https://gerrit.opencord.org/admin/repos/sdcore-helm-charts>`_
19
20Configuration Methods
21---------------------
22SD-Core supports 2 ways to configure network functions and micro services.
23
24 - Helm Chart
25
26 - Each individual network function and microservice has its own helm chart.
27 - User needs to provide override values and deploy the network functions as per their need.
28
29 - REST Config Interface
30
31 - Basic static configuration is passed through helm chart
ajaycbd17062022-03-06 11:12:58 -080032 - Dynamic *Network Slice* management APIs are provided through REST interface.
ajay2c0f6f42021-12-02 22:45:19 -080033 - REST APIs are defined to create/modify/delete network slice.
34 - REST APIs are also provided to provision subscribers and grouping the subscribers under device Group.
35
ajaycbd17062022-03-06 11:12:58 -080036.. image:: ../_static/images/config_slice.png
37 :width: 500px
38 :align: center
39
40
41
ajayec9bb9d2021-12-08 00:03:36 -080042Configuration Steps
43-------------------
Vijaya Rani59a17832021-12-03 19:27:41 +053044This Configuration describes what to configure at high level from RoC/SIMAPP. ConfigPod stores this configuration
ajayec9bb9d2021-12-08 00:03:36 -080045and publish to respective clients over REST/grpc.
ajay2c0f6f42021-12-02 22:45:19 -080046
ajayec9bb9d2021-12-08 00:03:36 -080047 - Step1 : Provision subscriber in 4G/5G subsystem
ajay2c0f6f42021-12-02 22:45:19 -080048
ajayec9bb9d2021-12-08 00:03:36 -080049 - This step is used to configure IMSI in the SD-Core
50 - This procedure is used to configure security keys for a subscriber
51 - Subscribers can be created during system startup or later
52
53 - Step2 : Device Group Configuration
54
55 - Group multiple devices under device group
56 - Configure QoS for the device group
57 - Configure IP domain configuration for the device group e.g. MTU, IP Pool, DNS server
58
59
60 - Step3: Network Slice Configuration
61
62 - Configuration to create a Network Slice
63 - Add device Group into Network Slice
64 - Slice contains the Slice level QoS configuration
Vijaya Rani59a17832021-12-03 19:27:41 +053065 - Site configuration including UPF, eNBs/gNBs assigned to the slice
ajay87945292021-12-08 00:52:00 -080066 - Applications allowed to be accessed by this slice (see :ref:`application-filtering`)
Vijaya Rani59a17832021-12-03 19:27:41 +053067
Vijaya Rani59a17832021-12-03 19:27:41 +053068