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