blob: 1d347f265ab1fcaab2b7caaeca55a15c89efd78e [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
Zack Williams7d058a92022-03-08 14:50:08 -07005SD-Core
6=======
ajayb3f40982021-12-08 14:26:11 -08007
Zack Williams7d058a92022-03-08 14:50:08 -07008The SD-Core project is a 4G/5G disaggregated mobile core optimized for public
ajayb5ad6db2021-12-09 15:23:24 -08009cloud deployment in concert with distributed edge clouds and is ideally suited
10for carrier and private enterprise 5G networks. It exposes standard 3GPP interfaces
11enabling use of SD-Core as a conventional mobile core.
Zack Williamsccaa38a2021-11-16 15:36:05 -070012
ajayb5ad6db2021-12-09 15:23:24 -080013SD-Core is an integral component of Aether, ONFs 5G Connected Edge platform for
14private mobile connectivity and edge cloud services. It can be rapidly deployed
15pre-integrated with Aether, as a standalone 5G/4G mobile core, or as control and
16dataplane (UPF) components integrated into custom designed solutions. This range
17of versatility makes the open source SD-Core platform ideally suited for the
18broadest range of use cases and deployment scenarios.
19
Zack Williamsccaa38a2021-11-16 15:36:05 -070020
21Getting Started with SD-Core
22----------------------------
ajay60fd69f2021-11-23 22:38:10 -080023- Learn more about SD-Core
Zack Williamsccaa38a2021-11-16 15:36:05 -070024
ajay60fd69f2021-11-23 22:38:10 -080025 - `SD-Core Website <https://opennetworking.org/sd-core/>`_
26 - `SD-Core Whitepaper <https://opennetworking.org/wp-content/uploads/2021/07/SD-Core-Technical-White-Paper-FINAL-1.pdf>`_
27 - `SD-Core Techinar <https://youtu.be/-eQzbSxXgSU>`_
28 - `SD-Core Wiki <https://wiki.opennetworking.org/display/COM/SD-Core>`_
Zack Williamsccaa38a2021-11-16 15:36:05 -070029
ajay60fd69f2021-11-23 22:38:10 -080030- Stay in touch by joining
31
32 - `SD-Core mailing list <https://groups.google.com/a/opennetworking.org/g/sdcore-announce>`_
33 - \#sdcore-dev channel in `ONF Community Slack <https://onf-community.slack.com>`_
34
Zack Williamsccaa38a2021-11-16 15:36:05 -070035
36Community
37---------
38
ajay60fd69f2021-11-23 22:38:10 -080039Information about participating in the SD Core community and development process
ajay07514982021-12-07 22:24:32 -080040can be found on the `SD-Core Wiki
Zack Williamsccaa38a2021-11-16 15:36:05 -070041<https://wiki.opennetworking.org/display/COM/SD-Core>`_.
42
ajay60fd69f2021-11-23 22:38:10 -080043.. toctree::
44 :maxdepth: 2
45 :caption: Overview
46 :hidden:
47 :glob:
48
49 overview/introduction.rst
50 overview/architecture.rst
51 overview/3gpp-compliance-5g.rst
52 overview/3gpp-compliance-4g.rst
53 overview/faq.rst
ajay2c0f6f42021-12-02 22:45:19 -080054 glossary.rst
ajay60fd69f2021-11-23 22:38:10 -080055
56.. toctree::
57 :maxdepth: 2
ajayd19711c2021-12-07 12:07:04 -080058 :caption: Configuration & Deployment
ajay60fd69f2021-11-23 22:38:10 -080059 :hidden:
60 :glob:
61
62 configuration/config.rst
ajay87945292021-12-08 00:52:00 -080063 configuration/config_rest.rst
64 configuration/config_simapp.rst
65 configuration/application_filtering.rst
ajay07514982021-12-07 22:24:32 -080066 deployment/deployment4G.rst
67 deployment/deployment5G.rst
ajay60fd69f2021-11-23 22:38:10 -080068
69.. toctree::
ajayf66b38e2021-12-09 23:44:54 -080070 :maxdepth: 3
ajayce0380c2021-12-14 21:51:00 -080071 :caption: Test Automation
ajayf66b38e2021-12-09 23:44:54 -080072 :hidden:
73 :glob:
74
75 testing/about_system_tests
76 testing/sdcore_testing
77 testing/acceptance_specification
78
79
80.. toctree::
ajay60fd69f2021-11-23 22:38:10 -080081 :maxdepth: 2
82 :caption: Troubleshooting Guide
83 :hidden:
84 :glob:
85
86 troubleshooting/flowchart.rst
87
88.. toctree::
89 :maxdepth: 2
90 :caption: Developer Guide
91 :hidden:
92 :glob:
93
ajayd19711c2021-12-07 12:07:04 -080094 developer/aiab.rst
ajay60fd69f2021-11-23 22:38:10 -080095 developer/gnbsim.rst
96 developer/testpod.rst
97
Zack Williamsccaa38a2021-11-16 15:36:05 -070098
99.. toctree::
100 :maxdepth: 2
101 :caption: Releases
102 :hidden:
103 :glob:
104
105 release/1*
106 release/process.rst