blob: 02965993c5f3ff65b0ec110c0a8e2eac1af8d5ad [file] [log] [blame]
Zack Williams7f708f82020-07-07 12:18:20 -07001Aether Documentation
2====================
3
Zack Williams589ac232021-08-19 08:52:18 -07004Aether is an ONF's 5G/LTE Connected Edge Platform-as-a-Service. More
5information about Aether can be found at the `ONF website
6<https://opennetworking.org/aether/>`_.
7
8Aether Components
9-----------------
10
11Aether uses components from several ONF projects. More information can be found
12at these sites:
13
14* `SD-Core <https://opennetworking.org/sd-core/>`_
Hung-Wei Chiu6ed79102021-08-24 14:27:26 -070015* `SD-Fabric <https://opennetworking.org/sd-fabric/>`_
Zack Williams589ac232021-08-19 08:52:18 -070016* `SD-RAN <https://docs.sd-ran.org/master/index.html>`_
17* `Stratum <https://github.com/stratum/stratum/>`_
18* `µONOS <https://docs.onosproject.org/>`_
19
20More information about mobile networks and 5G can be found in the :doc:`5G
21Mobile Networks: A Systems Approach <sysapproach5g:intro>` book.
22
Zack Williams7f708f82020-07-07 12:18:20 -070023Community
24---------
25
26Information about participating in the Aether community and development process
Zack Williams589ac232021-08-19 08:52:18 -070027can be found on the `ONF Wiki
28<https://wiki.opennetworking.org/display/COM/Aether>`_.
Hung-Wei Chiu77c969e2020-10-23 18:13:07 +000029
30.. toctree::
31 :maxdepth: 3
32 :caption: Edge Deployment
33 :hidden:
34 :glob:
35
Zack Williams794532a2021-03-18 17:38:36 -070036 edge_deployment/overview
37 edge_deployment/site_planning
38 edge_deployment/management_net_bootstrap
39 edge_deployment/server_bootstrap
40 edge_deployment/fabric_switch_bootstrap
41 edge_deployment/vpn_bootstrap
42 edge_deployment/runtime_deployment
Hyunsun Moond12f32b2021-07-30 12:55:00 -070043 edge_deployment/bess_upf_deployment
Hung-Wei Chiud06947b2021-08-10 16:10:07 -070044 edge_deployment/sdfabric_deployment
Zack Williams794532a2021-03-18 17:38:36 -070045 edge_deployment/connectivity_service_update
46 edge_deployment/enb_installation
47 edge_deployment/troubleshooting
Zack Williams1ae109e2021-07-27 11:17:04 -070048 edge_deployment/pronto
Zack Williams794532a2021-03-18 17:38:36 -070049
Scott Bakera91cbd52021-07-28 09:23:08 -070050.. toctree::
51 :maxdepth: 3
Zack Williams589ac232021-08-19 08:52:18 -070052 :caption: Operations
53 :hidden:
54 :glob:
55
56 operations/procedures
57 operations/subscriber
58 operations/vcs
59
60.. toctree::
61 :maxdepth: 3
Scott Bakera91cbd52021-07-28 09:23:08 -070062 :caption: Aether Management Platform
63 :hidden:
64 :glob:
65
66 amp/roc
Andy Bavier0478ee52021-07-29 17:05:22 -070067 amp/monitoring
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -070068
Zack Williams794532a2021-03-18 17:38:36 -070069.. toctree::
70 :maxdepth: 3
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -070071 :caption: Aether Test Automation
Zack Williams794532a2021-03-18 17:38:36 -070072 :hidden:
73 :glob:
74
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -070075 testing/about_system_tests
You Wangee3a4db2021-04-13 18:50:40 -070076 testing/sdcore_testing
Elena Stoeva084ee832021-08-04 20:45:03 +030077 testing/aether-roc-tests
Jeremy Ronquillo311aa262021-04-15 15:00:49 -070078 testing/acceptance_specification
Zack Williams794532a2021-03-18 17:38:36 -070079
80.. toctree::
Scott Bakerfab7c9e2021-07-29 17:12:16 -070081 :maxdepth: 3
82 :caption: Aether Developer Notes
83 :hidden:
84 :glob:
85
Andy Bavierf73c3d22021-08-30 10:29:06 -070086 developer/aiab
Scott Bakerfab7c9e2021-07-29 17:12:16 -070087 developer/roc
Scott Baker00df5a82021-08-13 16:01:57 -070088 developer/roc-api
Scott Bakerfab7c9e2021-07-29 17:12:16 -070089
90.. toctree::
Zack Williams1ae109e2021-07-27 11:17:04 -070091 :maxdepth: 2
92 :caption: Releases
93 :hidden:
94 :glob:
95
96 release/process.rst
97 release/1*
98
99.. toctree::
Zack Williams794532a2021-03-18 17:38:36 -0700100 :maxdepth: 1
101 :caption: Meta
102 :hidden:
103 :glob:
104
105 readme