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