blob: 5ae9d47b5fc1f2d2f409ee814f4d24a5ae99b37e [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
5
6.. image:: _static/sdcore-logo.svg
ajay87945292021-12-08 00:52:00 -08007 :width: 400px
8 :align: center
9
10
11=====================
Zack Williamsccaa38a2021-11-16 15:36:05 -070012SD-Core Documentation
13=====================
14
ajay07514982021-12-07 22:24:32 -080015SD-Core is an ONF's 4G/5G Core. SD-Core is cloud native implementation of 4G/5G core network functions.
16Aether uses SD-Core to provided connectivity as a service.
Zack Williamsccaa38a2021-11-16 15:36:05 -070017
18Getting Started with SD-Core
19----------------------------
ajay60fd69f2021-11-23 22:38:10 -080020- Learn more about SD-Core
Zack Williamsccaa38a2021-11-16 15:36:05 -070021
ajay60fd69f2021-11-23 22:38:10 -080022 - `SD-Core Website <https://opennetworking.org/sd-core/>`_
23 - `SD-Core Whitepaper <https://opennetworking.org/wp-content/uploads/2021/07/SD-Core-Technical-White-Paper-FINAL-1.pdf>`_
24 - `SD-Core Techinar <https://youtu.be/-eQzbSxXgSU>`_
25 - `SD-Core Wiki <https://wiki.opennetworking.org/display/COM/SD-Core>`_
Zack Williamsccaa38a2021-11-16 15:36:05 -070026
ajay60fd69f2021-11-23 22:38:10 -080027- Stay in touch by joining
28
29 - `SD-Core mailing list <https://groups.google.com/a/opennetworking.org/g/sdcore-announce>`_
30 - \#sdcore-dev channel in `ONF Community Slack <https://onf-community.slack.com>`_
31
Zack Williamsccaa38a2021-11-16 15:36:05 -070032
33Community
34---------
35
ajay60fd69f2021-11-23 22:38:10 -080036Information about participating in the SD Core community and development process
ajay07514982021-12-07 22:24:32 -080037can be found on the `SD-Core Wiki
Zack Williamsccaa38a2021-11-16 15:36:05 -070038<https://wiki.opennetworking.org/display/COM/SD-Core>`_.
39
ajay60fd69f2021-11-23 22:38:10 -080040.. toctree::
41 :maxdepth: 2
42 :caption: Overview
43 :hidden:
44 :glob:
45
46 overview/introduction.rst
47 overview/architecture.rst
48 overview/3gpp-compliance-5g.rst
49 overview/3gpp-compliance-4g.rst
50 overview/faq.rst
ajay2c0f6f42021-12-02 22:45:19 -080051 glossary.rst
ajay60fd69f2021-11-23 22:38:10 -080052
53.. toctree::
54 :maxdepth: 2
ajayd19711c2021-12-07 12:07:04 -080055 :caption: Configuration & Deployment
ajay60fd69f2021-11-23 22:38:10 -080056 :hidden:
57 :glob:
58
59 configuration/config.rst
ajay87945292021-12-08 00:52:00 -080060 configuration/config_rest.rst
61 configuration/config_simapp.rst
62 configuration/application_filtering.rst
ajay07514982021-12-07 22:24:32 -080063 deployment/deployment4G.rst
64 deployment/deployment5G.rst
ajay60fd69f2021-11-23 22:38:10 -080065
66.. toctree::
67 :maxdepth: 2
68 :caption: Troubleshooting Guide
69 :hidden:
70 :glob:
71
72 troubleshooting/flowchart.rst
73
74.. toctree::
75 :maxdepth: 2
76 :caption: Developer Guide
77 :hidden:
78 :glob:
79
ajayd19711c2021-12-07 12:07:04 -080080 developer/aiab.rst
ajay60fd69f2021-11-23 22:38:10 -080081 developer/gnbsim.rst
82 developer/testpod.rst
83
Zack Williamsccaa38a2021-11-16 15:36:05 -070084
85.. toctree::
86 :maxdepth: 2
87 :caption: Releases
88 :hidden:
89 :glob:
90
91 release/1*
92 release/process.rst
93
94.. toctree::
95 :maxdepth: 1
96 :caption: Meta
97 :hidden:
98 :glob:
99
100 readme