Gitiles
Code Review Sign In
gerrit.opencord.org / aether-docs / d1e873395caaaaf4c3e798dfe86ad9686b7b7651 / . / index.rst
blob: b48673bb82643ada67e0d01f63fceae820a2accd [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
30* `SD-Core <https://opennetworking.org/sd-core/>`_
Hung-Wei Chiu6ed79102021-08-24 14:27:26 -0700[diff] [blame]31* `SD-Fabric <https://opennetworking.org/sd-fabric/>`_
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]32* `SD-RAN <https://docs.sd-ran.org/master/index.html>`_
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]33
34More information about mobile networks and 5G can be found in the :doc:`5G
35Mobile Networks: A Systems Approach <sysapproach5g:intro>` book.
36
Zack Williams7f708f82020-07-07 12:18:20 -0700[diff] [blame]37Community
38---------
39
40Information about participating in the Aether community and development process
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]41can be found on the `ONF Wiki
42<https://wiki.opennetworking.org/display/COM/Aether>`_.
Hung-Wei Chiu77c969e2020-10-23 18:13:07 +0000[diff] [blame]43
44.. toctree::
45 :maxdepth: 3
46 :caption: Edge Deployment
47 :hidden:
48 :glob:
49
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]50 edge_deployment/overview
51 edge_deployment/site_planning
52 edge_deployment/management_net_bootstrap
53 edge_deployment/server_bootstrap
54 edge_deployment/fabric_switch_bootstrap
55 edge_deployment/vpn_bootstrap
56 edge_deployment/runtime_deployment
Hyunsun Moond12f32b2021-07-30 12:55:00 -0700[diff] [blame]57 edge_deployment/bess_upf_deployment
Hung-Wei Chiud06947b2021-08-10 16:10:07 -0700[diff] [blame]58 edge_deployment/sdfabric_deployment
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]59 edge_deployment/connectivity_service_update
60 edge_deployment/enb_installation
Hyunsun Moond1e87332022-02-18 15:07:20 -0800[diff] [blame^]61 edge_deployment/site_remove
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]62 edge_deployment/troubleshooting
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]63 edge_deployment/pronto
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]64
Scott Bakera91cbd52021-07-28 09:23:08 -0700[diff] [blame]65.. toctree::
66 :maxdepth: 3
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]67 :caption: Operations
68 :hidden:
69 :glob:
70
71 operations/procedures
72 operations/subscriber
73 operations/vcs
Scott Bakerd3a7ec52021-11-08 22:59:07 -0800[diff] [blame]74 advanced/appfilter
Scott Baker0fae6062022-02-02 16:09:26 -0800[diff] [blame]75 advanced/metering
Scott Bakerb260e922022-02-22 16:30:58 -0800[diff] [blame]76 advanced/subproxy
Zack Williams589ac232021-08-19 08:52:18 -0700[diff] [blame]77
78.. toctree::
79 :maxdepth: 3
Scott Bakera91cbd52021-07-28 09:23:08 -0700[diff] [blame]80 :caption: Aether Management Platform
81 :hidden:
82 :glob:
83
84 amp/roc
Andy Bavier0478ee52021-07-29 17:05:22 -0700[diff] [blame]85 amp/monitoring
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -0700[diff] [blame]86
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]87.. toctree::
88 :maxdepth: 3
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -0700[diff] [blame]89 :caption: Aether Test Automation
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]90 :hidden:
91 :glob:
92
Jeremy Ronquillo35428fe2021-04-12 12:25:04 -0700[diff] [blame]93 testing/about_system_tests
Elena Stoeva084ee832021-08-04 20:45:03 +0300[diff] [blame]94 testing/aether-roc-tests
Jeremy Ronquillo311aa262021-04-15 15:00:49 -0700[diff] [blame]95 testing/acceptance_specification
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]96
97.. toctree::
Scott Bakerfab7c9e2021-07-29 17:12:16 -0700[diff] [blame]98 :maxdepth: 3
99 :caption: Aether Developer Notes
100 :hidden:
101 :glob:
102
Andy Bavierf73c3d22021-08-30 10:29:06 -0700[diff] [blame]103 developer/aiab
Scott Bakerfab7c9e2021-07-29 17:12:16 -0700[diff] [blame]104 developer/roc
Scott Baker00df5a82021-08-13 16:01:57 -0700[diff] [blame]105 developer/roc-api
Scott Bakerfab7c9e2021-07-29 17:12:16 -0700[diff] [blame]106
107.. toctree::
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]108 :maxdepth: 2
109 :caption: Releases
110 :hidden:
111 :glob:
112
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]113 release/1*
Zack Williams5d2d6782021-08-26 13:08:44 -0700[diff] [blame]114 release/process.rst
Zack Williams1ae109e2021-07-27 11:17:04 -0700[diff] [blame]115
116.. toctree::
Zack Williams794532a2021-03-18 17:38:36 -0700[diff] [blame]117 :maxdepth: 1
118 :caption: Meta
119 :hidden:
120 :glob:
121
122 readme