Zack Williams | 7f708f8 | 2020-07-07 12:18:20 -0700 | [diff] [blame] | 1 | Aether Documentation |
| 2 | ==================== |
| 3 | |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 4 | Aether is an ONF's 5G/LTE Connected Edge Platform-as-a-Service. More |
| 5 | information about Aether can be found at the `ONF website |
| 6 | <https://opennetworking.org/aether/>`_. |
| 7 | |
Zack Williams | 5d2d678 | 2021-08-26 13:08:44 -0700 | [diff] [blame] | 8 | |
| 9 | Getting Started with Aether |
| 10 | --------------------------- |
| 11 | |
| 12 | Here 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 Williams | fcd19ec | 2021-09-01 18:11:54 -0700 | [diff] [blame] | 22 | </developer/aiab>`. |
Zack Williams | 5d2d678 | 2021-08-26 13:08:44 -0700 | [diff] [blame] | 23 | |
| 24 | Aether Architecture and Components |
| 25 | ---------------------------------- |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 26 | |
| 27 | Aether uses components from several ONF projects. More information can be found |
| 28 | at these sites: |
| 29 | |
| 30 | * `SD-Core <https://opennetworking.org/sd-core/>`_ |
Hung-Wei Chiu | 6ed7910 | 2021-08-24 14:27:26 -0700 | [diff] [blame] | 31 | * `SD-Fabric <https://opennetworking.org/sd-fabric/>`_ |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 32 | * `SD-RAN <https://docs.sd-ran.org/master/index.html>`_ |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 33 | |
| 34 | More information about mobile networks and 5G can be found in the :doc:`5G |
| 35 | Mobile Networks: A Systems Approach <sysapproach5g:intro>` book. |
| 36 | |
Zack Williams | 7f708f8 | 2020-07-07 12:18:20 -0700 | [diff] [blame] | 37 | Community |
| 38 | --------- |
| 39 | |
| 40 | Information about participating in the Aether community and development process |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 41 | can be found on the `ONF Wiki |
| 42 | <https://wiki.opennetworking.org/display/COM/Aether>`_. |
Hung-Wei Chiu | 77c969e | 2020-10-23 18:13:07 +0000 | [diff] [blame] | 43 | |
| 44 | .. toctree:: |
| 45 | :maxdepth: 3 |
| 46 | :caption: Edge Deployment |
| 47 | :hidden: |
| 48 | :glob: |
| 49 | |
Zack Williams | 794532a | 2021-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 Moon | d12f32b | 2021-07-30 12:55:00 -0700 | [diff] [blame] | 57 | edge_deployment/bess_upf_deployment |
Hung-Wei Chiu | d06947b | 2021-08-10 16:10:07 -0700 | [diff] [blame] | 58 | edge_deployment/sdfabric_deployment |
Zack Williams | 794532a | 2021-03-18 17:38:36 -0700 | [diff] [blame] | 59 | edge_deployment/connectivity_service_update |
| 60 | edge_deployment/enb_installation |
| 61 | edge_deployment/troubleshooting |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 62 | edge_deployment/pronto |
Zack Williams | 794532a | 2021-03-18 17:38:36 -0700 | [diff] [blame] | 63 | |
Scott Baker | a91cbd5 | 2021-07-28 09:23:08 -0700 | [diff] [blame] | 64 | .. toctree:: |
| 65 | :maxdepth: 3 |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 66 | :caption: Operations |
| 67 | :hidden: |
| 68 | :glob: |
| 69 | |
| 70 | operations/procedures |
| 71 | operations/subscriber |
| 72 | operations/vcs |
Scott Baker | d3a7ec5 | 2021-11-08 22:59:07 -0800 | [diff] [blame] | 73 | advanced/appfilter |
Zack Williams | 589ac23 | 2021-08-19 08:52:18 -0700 | [diff] [blame] | 74 | |
| 75 | .. toctree:: |
| 76 | :maxdepth: 3 |
Scott Baker | a91cbd5 | 2021-07-28 09:23:08 -0700 | [diff] [blame] | 77 | :caption: Aether Management Platform |
| 78 | :hidden: |
| 79 | :glob: |
| 80 | |
| 81 | amp/roc |
Andy Bavier | 0478ee5 | 2021-07-29 17:05:22 -0700 | [diff] [blame] | 82 | amp/monitoring |
Jeremy Ronquillo | 35428fe | 2021-04-12 12:25:04 -0700 | [diff] [blame] | 83 | |
Zack Williams | 794532a | 2021-03-18 17:38:36 -0700 | [diff] [blame] | 84 | .. toctree:: |
| 85 | :maxdepth: 3 |
Jeremy Ronquillo | 35428fe | 2021-04-12 12:25:04 -0700 | [diff] [blame] | 86 | :caption: Aether Test Automation |
Zack Williams | 794532a | 2021-03-18 17:38:36 -0700 | [diff] [blame] | 87 | :hidden: |
| 88 | :glob: |
| 89 | |
Jeremy Ronquillo | 35428fe | 2021-04-12 12:25:04 -0700 | [diff] [blame] | 90 | testing/about_system_tests |
Elena Stoeva | 084ee83 | 2021-08-04 20:45:03 +0300 | [diff] [blame] | 91 | testing/aether-roc-tests |
Jeremy Ronquillo | 311aa26 | 2021-04-15 15:00:49 -0700 | [diff] [blame] | 92 | testing/acceptance_specification |
Zack Williams | 794532a | 2021-03-18 17:38:36 -0700 | [diff] [blame] | 93 | |
| 94 | .. toctree:: |
Scott Baker | fab7c9e | 2021-07-29 17:12:16 -0700 | [diff] [blame] | 95 | :maxdepth: 3 |
| 96 | :caption: Aether Developer Notes |
| 97 | :hidden: |
| 98 | :glob: |
| 99 | |
Andy Bavier | f73c3d2 | 2021-08-30 10:29:06 -0700 | [diff] [blame] | 100 | developer/aiab |
Scott Baker | fab7c9e | 2021-07-29 17:12:16 -0700 | [diff] [blame] | 101 | developer/roc |
Scott Baker | 00df5a8 | 2021-08-13 16:01:57 -0700 | [diff] [blame] | 102 | developer/roc-api |
Scott Baker | fab7c9e | 2021-07-29 17:12:16 -0700 | [diff] [blame] | 103 | |
| 104 | .. toctree:: |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 105 | :maxdepth: 2 |
| 106 | :caption: Releases |
| 107 | :hidden: |
| 108 | :glob: |
| 109 | |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 110 | release/1* |
Zack Williams | 5d2d678 | 2021-08-26 13:08:44 -0700 | [diff] [blame] | 111 | release/process.rst |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 112 | |
| 113 | .. toctree:: |
Zack Williams | 794532a | 2021-03-18 17:38:36 -0700 | [diff] [blame] | 114 | :maxdepth: 1 |
| 115 | :caption: Meta |
| 116 | :hidden: |
| 117 | :glob: |
| 118 | |
| 119 | readme |