blob: cc8c6826d1eb8d9e7eb4e35144a70f0bedd0bb8b [file] [log] [blame]
ajayb3f40982021-12-08 14:26:11 -08001..
Badhrinath Padmanabhan5f125302022-08-24 12:50:15 +00002 SPDX-FileCopyrightText: 2022-present Intel Corporation
ajayb3f40982021-12-08 14:26:11 -08003 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
4 SPDX-License-Identifier: Apache-2.0
5
Zack Williams7d058a92022-03-08 14:50:08 -07006SD-Core
7=======
ajayb3f40982021-12-08 14:26:11 -08008
Zack Williams7d058a92022-03-08 14:50:08 -07009The SD-Core project is a 4G/5G disaggregated mobile core optimized for public
ajayb5ad6db2021-12-09 15:23:24 -080010cloud deployment in concert with distributed edge clouds and is ideally suited
11for carrier and private enterprise 5G networks. It exposes standard 3GPP interfaces
12enabling use of SD-Core as a conventional mobile core.
Zack Williamsccaa38a2021-11-16 15:36:05 -070013
ajayb5ad6db2021-12-09 15:23:24 -080014SD-Core is an integral component of Aether, ONFs 5G Connected Edge platform for
15private mobile connectivity and edge cloud services. It can be rapidly deployed
16pre-integrated with Aether, as a standalone 5G/4G mobile core, or as control and
17dataplane (UPF) components integrated into custom designed solutions. This range
18of versatility makes the open source SD-Core platform ideally suited for the
19broadest range of use cases and deployment scenarios.
20
Zack Williamsccaa38a2021-11-16 15:36:05 -070021
22Getting Started with SD-Core
23----------------------------
ajay60fd69f2021-11-23 22:38:10 -080024- Learn more about SD-Core
Zack Williamsccaa38a2021-11-16 15:36:05 -070025
ajay60fd69f2021-11-23 22:38:10 -080026 - `SD-Core Website <https://opennetworking.org/sd-core/>`_
27 - `SD-Core Whitepaper <https://opennetworking.org/wp-content/uploads/2021/07/SD-Core-Technical-White-Paper-FINAL-1.pdf>`_
28 - `SD-Core Techinar <https://youtu.be/-eQzbSxXgSU>`_
29 - `SD-Core Wiki <https://wiki.opennetworking.org/display/COM/SD-Core>`_
Badhrinath Padmanabhan5f125302022-08-24 12:50:15 +000030 - `SD-Core Public Folder <https://drive.google.com/drive/folders/1dM5b0B65LkQQ0dGK1m-iIceRJfAASEm1>`_
Zack Williamsccaa38a2021-11-16 15:36:05 -070031
ajay60fd69f2021-11-23 22:38:10 -080032- Stay in touch by joining
33
34 - `SD-Core mailing list <https://groups.google.com/a/opennetworking.org/g/sdcore-announce>`_
35 - \#sdcore-dev channel in `ONF Community Slack <https://onf-community.slack.com>`_
36
Zack Williamsccaa38a2021-11-16 15:36:05 -070037
38Community
39---------
40
ajay60fd69f2021-11-23 22:38:10 -080041Information about participating in the SD Core community and development process
ajay07514982021-12-07 22:24:32 -080042can be found on the `SD-Core Wiki
Zack Williamsccaa38a2021-11-16 15:36:05 -070043<https://wiki.opennetworking.org/display/COM/SD-Core>`_.
44
ajay60fd69f2021-11-23 22:38:10 -080045.. toctree::
46 :maxdepth: 2
47 :caption: Overview
48 :hidden:
49 :glob:
50
51 overview/introduction.rst
52 overview/architecture.rst
53 overview/3gpp-compliance-5g.rst
54 overview/3gpp-compliance-4g.rst
55 overview/faq.rst
ajay2c0f6f42021-12-02 22:45:19 -080056 glossary.rst
ajay60fd69f2021-11-23 22:38:10 -080057
58.. toctree::
59 :maxdepth: 2
ajayd19711c2021-12-07 12:07:04 -080060 :caption: Configuration & Deployment
ajay60fd69f2021-11-23 22:38:10 -080061 :hidden:
62 :glob:
63
64 configuration/config.rst
ajay87945292021-12-08 00:52:00 -080065 configuration/config_rest.rst
66 configuration/config_simapp.rst
67 configuration/application_filtering.rst
ajay07514982021-12-07 22:24:32 -080068 deployment/deployment4G.rst
69 deployment/deployment5G.rst
ajay60fd69f2021-11-23 22:38:10 -080070
71.. toctree::
ajayf66b38e2021-12-09 23:44:54 -080072 :maxdepth: 3
ajayce0380c2021-12-14 21:51:00 -080073 :caption: Test Automation
ajayf66b38e2021-12-09 23:44:54 -080074 :hidden:
75 :glob:
76
77 testing/about_system_tests
78 testing/sdcore_testing
79 testing/acceptance_specification
80
81
82.. toctree::
ajay60fd69f2021-11-23 22:38:10 -080083 :maxdepth: 2
84 :caption: Troubleshooting Guide
85 :hidden:
86 :glob:
87
88 troubleshooting/flowchart.rst
89
90.. toctree::
91 :maxdepth: 2
92 :caption: Developer Guide
93 :hidden:
94 :glob:
95
ajayd19711c2021-12-07 12:07:04 -080096 developer/aiab.rst
ajay60fd69f2021-11-23 22:38:10 -080097 developer/gnbsim.rst
98 developer/testpod.rst
99
Zack Williamsccaa38a2021-11-16 15:36:05 -0700100
101.. toctree::
102 :maxdepth: 2
103 :caption: Releases
104 :hidden:
105 :glob:
106
107 release/1*
108 release/process.rst