Gitiles
Code Review Sign In
gerrit.opencord.org / aether-docs / refs/tags/2.1.0 / . / index.rst
blob: af7b22760267db00787d15852b7ea008a5e39b99 [file] [log] [blame]
Zack Williams7f708f82020-07-07 12:18:20 -0700[diff] [blame]1Aether Documentation
2====================
3
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]4Aether 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
Zack Williams5d2d6782021-08-26 13:08:44 -0700[diff] [blame]8
9Getting Started with Aether
10---------------------------
11
12Here are some useful places to start with Aether:
13
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]14* Setup an Aether software development environment with :doc:`Aether-in-a-Box </developer/aiab>`.
15
Ajay Lotan Thakur2127ee92022-08-31 07:09:04 -0700[diff] [blame]16* For a PoC deployment, bring up an :doc:`Aether-in-a-Box on 4G Real Radios <developer/aiabhw>`.
17
18* For a PoC deployment, bring up an :doc:`Aether-in-a-Box on 5G Real Radios <developer/aiabhw5g>`.
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]19
20* Learn about how to :doc:`configure Aether using the ROC </operations/gui>`.
Zack Williams5d2d6782021-08-26 13:08:44 -0700[diff] [blame]21
22* Learn the requirements of hosting an :doc:`Aether Connected Edge
23 </edge_deployment/overview>`.
24
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]25* Read the most recent :doc:`Release Notes </release/2.0>`.
Zack Williams5d2d6782021-08-26 13:08:44 -0700[diff] [blame]26
27Aether Architecture and Components
28----------------------------------
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]29
30Aether uses components from several ONF projects. More information can be found
31at these sites:
32
Scott Bakerfc102df2022-03-10 11:13:08 -0800[diff] [blame]33* SD-Core
34
35 * `SD-Core Website <https://opennetworking.org/sd-core/>`_
36 * :doc:`SD-Core Documentation <sdcore:index>`
37
38* SD-Fabric
39
40 * `SD-Fabric Website <https://opennetworking.org/sd-fabric/>`_
41 * :doc:`SD-Fabric Documentation <sdfabric:index>`
42
43* SD-RAN
44
Andy Bavier77b8f772022-07-12 14:25:28 -0700[diff] [blame]45 * `SD-RAN Website <https://opennetworking.org/open-ran/>`_
Scott Bakerfc102df2022-03-10 11:13:08 -0800[diff] [blame]46 * :doc:`SD-RAN Documentation <sdran:index>`
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]47
48More information about mobile networks and 5G can be found in the :doc:`5G
49Mobile Networks: A Systems Approach <sysapproach5g:intro>` book.
50
Zack Williams7f708f82020-07-07 12:18:20 -0700[diff] [blame]51Community
52---------
53
54Information about participating in the Aether community and development process
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]55can be found on the `ONF Wiki
56<https://wiki.opennetworking.org/display/COM/Aether>`_.
Hung-Wei Chiu77c969e2020-10-23 18:13:07 +0000[diff] [blame]57
58.. toctree::
59 :maxdepth: 3
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]60 :caption: Aether Quick Start
61 :hidden:
62 :glob:
63
64 developer/aiab
65 developer/aiabhw
Ajay Lotan Thakur2127ee92022-08-31 07:09:04 -0700[diff] [blame]66 developer/aiabhw5g
67 developer/troubleshooting
Scott Baker4232d4f2022-03-31 10:52:37 -0700[diff] [blame]68 developer/contributing.rst
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]69
70.. toctree::
71 :maxdepth: 3
72 :caption: Operations
73 :hidden:
74 :glob:
75
76 operations/gui
77 operations/subscriber
78 operations/application
79 operations/slice
80 operations/metering
81 operations/monitor
82 operations/procedures
83
84.. toctree::
85 :maxdepth: 3
86 :caption: Production Edge Deployment
Hung-Wei Chiu77c969e2020-10-23 18:13:07 +0000[diff] [blame]87 :hidden:
88 :glob:
89
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]90 edge_deployment/overview
91 edge_deployment/site_planning
92 edge_deployment/management_net_bootstrap
93 edge_deployment/server_bootstrap
94 edge_deployment/fabric_switch_bootstrap
95 edge_deployment/vpn_bootstrap
96 edge_deployment/runtime_deployment
Hyunsun Moond12f32b2021-07-30 12:55:00 -0700[diff] [blame]97 edge_deployment/bess_upf_deployment
Hung-Wei Chiud06947b2021-08-10 16:10:07 -0700[diff] [blame]98 edge_deployment/sdfabric_deployment
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]99 edge_deployment/connectivity_service_update
100 edge_deployment/enb_installation
Hyunsun Moond1e87332022-02-18 15:07:20 -0800[diff] [blame]101 edge_deployment/site_remove
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]102 edge_deployment/troubleshooting
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]103 edge_deployment/pronto
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]104
Scott Bakera91cbd52021-07-28 09:23:08 -0700[diff] [blame]105.. toctree::
106 :maxdepth: 3
107 :caption: Aether Management Platform
108 :hidden:
109 :glob:
110
111 amp/roc
Scott Baker3c7cfea2022-03-09 16:22:42 -0800[diff] [blame]112 amp/subproxy
Andy Bavier0478ee52021-07-29 17:05:22 -0700[diff] [blame]113 amp/monitoring
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -0700[diff] [blame]114
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]115.. toctree::
116 :maxdepth: 3
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]117 :caption: ROC Development
Scott Baker3c7cfea2022-03-09 16:22:42 -0800[diff] [blame]118 :hidden:
119 :glob:
120
Andy Bavierf3e24b62022-03-30 19:53:01 -0400[diff] [blame]121 developer/roc
122 developer/roc-api
Scott Baker3c7cfea2022-03-09 16:22:42 -0800[diff] [blame]123
124.. toctree::
125 :maxdepth: 3
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -0700[diff] [blame]126 :caption: Aether Test Automation
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]127 :hidden:
128 :glob:
129
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -0700[diff] [blame]130 testing/about_system_tests
Elena Stoeva084ee832021-08-04 20:45:03 +0300[diff] [blame]131 testing/aether-roc-tests
Bren Santos40966f32022-03-09 18:36:01 -0800[diff] [blame]132 testing/system-tests
Jeremy Ronquillo311aa262021-04-15 15:00:49 -0700[diff] [blame]133 testing/acceptance_specification
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]134
135.. toctree::
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]136 :maxdepth: 2
137 :caption: Releases
138 :hidden:
139 :glob:
140
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]141 release/1*
Scott Baker505738f2022-03-09 10:51:53 -0800[diff] [blame]142 release/2*
Zack Williams5d2d6782021-08-26 13:08:44 -0700[diff] [blame]143 release/process.rst