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