Gitiles
Code Review Sign In
gerrit.opencord.org / sdcore-docs / 8585ae1dfdbec01d2e4ce63442d0d4ecd0dc0bec / . / index.rst
blob: 85a06e38664835ace2f03f22d181e4407ad8742c [file] [log] [blame]
ajayb3f40982021-12-08 14:26:11 -0800[diff] [blame]1..
Badhrinath Padmanabhan5f125302022-08-24 12:50:15 +0000[diff] [blame]2 SPDX-FileCopyrightText: 2022-present Intel Corporation
ajayb3f40982021-12-08 14:26:11 -0800[diff] [blame]3 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
4 SPDX-License-Identifier: Apache-2.0
5
Zack Williams7d058a92022-03-08 14:50:08 -0700[diff] [blame]6SD-Core
7=======
ajayb3f40982021-12-08 14:26:11 -0800[diff] [blame]8
Zack Williams7d058a92022-03-08 14:50:08 -0700[diff] [blame]9The SD-Core project is a 4G/5G disaggregated mobile core optimized for public
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]10cloud deployment in concert with distributed edge clouds. It exposes standard 3GPP interfaces
11enabling use of SD-Core as a conventional mobile core. SD-Core is an integral component
12of Aether, ONF’s 5G Connected Edge platform for
ajayb5ad6db2021-12-09 15:23:24 -0800[diff] [blame]13private mobile connectivity and edge cloud services. It can be rapidly deployed
14pre-integrated with Aether, as a standalone 5G/4G mobile core, or as control and
15dataplane (UPF) components integrated into custom designed solutions. This range
16of versatility makes the open source SD-Core platform ideally suited for the
17broadest range of use cases and deployment scenarios.
18
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]19SD-Core is ideally suited for
20
21- Small carrier
22- Private enterprise 4G/5G networks
23- Research community or Universities who wish to study/learn more on 3gpp 4G/5G
24
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]25
26Getting Started with SD-Core
27----------------------------
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]28- Learn more about SD-Core
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]29
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]30 - `SD-Core Website <https://opennetworking.org/sd-core/>`_
31 - `SD-Core Whitepaper <https://opennetworking.org/wp-content/uploads/2021/07/SD-Core-Technical-White-Paper-FINAL-1.pdf>`_
32 - `SD-Core Techinar <https://youtu.be/-eQzbSxXgSU>`_
33 - `SD-Core Wiki <https://wiki.opennetworking.org/display/COM/SD-Core>`_
Badhrinath Padmanabhan5f125302022-08-24 12:50:15 +0000[diff] [blame]34 - `SD-Core Public Folder <https://drive.google.com/drive/folders/1dM5b0B65LkQQ0dGK1m-iIceRJfAASEm1>`_
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]35
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]36
37Community
38---------
39
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]40Information about participating in the SD Core community and development process
ajay07514982021-12-07 22:24:32 -0800[diff] [blame]41can be found on the `SD-Core Wiki
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]42<https://wiki.opennetworking.org/display/COM/SD-Core>`_.
43
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]44- Stay in touch by joining
45
46 - `SD-Core mailing list <https://groups.google.com/a/opennetworking.org/g/sdcore-announce>`_
47 - \#sdcore-dev channel in `ONF Community Slack <https://onf-community.slack.com>`_
48
49
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]50.. toctree::
51 :maxdepth: 2
52 :caption: Overview
53 :hidden:
54 :glob:
55
56 overview/introduction.rst
57 overview/architecture.rst
58 overview/3gpp-compliance-5g.rst
59 overview/3gpp-compliance-4g.rst
60 overview/faq.rst
ajay2c0f6f42021-12-02 22:45:19 -0800[diff] [blame]61 glossary.rst
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]62
63.. toctree::
64 :maxdepth: 2
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]65 :caption: Configuration
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]66 :hidden:
67 :glob:
68
69 configuration/config.rst
ajay87945292021-12-08 00:52:00 -0800[diff] [blame]70 configuration/config_rest.rst
71 configuration/config_simapp.rst
72 configuration/application_filtering.rst
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]73 configuration/qos_config.rst
Ajay Lotan Thakure1dfc222022-10-06 17:58:34 -0700[diff] [blame]74 configuration/config_upf.rst
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]75
76.. toctree::
77 :maxdepth: 2
78 :caption: Deployment
79 :hidden:
80 :glob:
81
ajay07514982021-12-07 22:24:32 -0800[diff] [blame]82 deployment/deployment4G.rst
83 deployment/deployment5G.rst
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]84 deployment/deploymentupf.rst
Ajay Lotan Thakur0b012662022-10-07 20:18:10 -0700[diff] [blame]85 deployment/deploymentgnbsim.rst
Ajay Lotan Thakur5e1c42e2022-11-03 22:36:44 -0700[diff] [blame]86 deployment/deploymentueransim.rst
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]87
88.. toctree::
Ankur Upadhyaya4f0e3b02022-10-06 11:15:39 -0600[diff] [blame]89 :maxdepth: 2
90 :caption: Design
91 :hidden:
92 :glob:
93
94 design/design-smf.rst
95 design/design-amf.rst
96
97.. toctree::
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]98 :maxdepth: 2
99 :caption: Developer Guide
100 :hidden:
101 :glob:
102
ajayd19711c2021-12-07 12:07:04 -0800[diff] [blame]103 developer/aiab.rst
Ajay Lotan Thakur05ce5ce2022-09-25 20:36:16 -0700[diff] [blame]104 developer/aiab5g.rst
ajay60fd69f2021-11-23 22:38:10 -0800[diff] [blame]105 developer/gnbsim.rst
106 developer/testpod.rst
107
Ajay Lotan Thakur0b012662022-10-07 20:18:10 -0700[diff] [blame]108.. toctree::
109 :maxdepth: 2
110 :caption: Troubleshooting Guide
111 :hidden:
112 :glob:
113
114 troubleshooting/flowchart.rst
115
116.. toctree::
117 :maxdepth: 3
118 :caption: Test Automation
119 :hidden:
120 :glob:
121
122 testing/about_system_tests
123 testing/sdcore_testing
124 testing/acceptance_specification
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]125
126.. toctree::
127 :maxdepth: 2
128 :caption: Releases
129 :hidden:
130 :glob:
131
132 release/1*
Ajay Lotan Thakur4a85af92022-10-17 10:22:45 -0700[diff] [blame]133 release/upcoming.rst
Zack Williamsccaa38a2021-11-16 15:36:05 -0700[diff] [blame]134 release/process.rst