blob: a083be06e1d80f20dc3df3c184fe9075e9079bf5 [file] [log] [blame]
Aether Documentation
====================
Aether is an ONF's 5G/LTE Connected Edge Platform-as-a-Service. More
information about Aether can be found at the `ONF website
<https://opennetworking.org/aether/>`_.
Getting Started with Aether
---------------------------
Here are some useful places to start with Aether:
* Setup an Aether software development environment with :doc:`Aether-in-a-Box </developer/aiab>`.
* For a PoC deployment, bring up an :doc:`Aether-in-a-Box on Real Radios <developer/aiabhw>`.
* Learn about how to :doc:`configure Aether using the ROC </operations/gui>`.
* Learn the requirements of hosting an :doc:`Aether Connected Edge
</edge_deployment/overview>`.
* Read the most recent :doc:`Release Notes </release/2.0>`.
Aether Architecture and Components
----------------------------------
Aether uses components from several ONF projects. More information can be found
at these sites:
* SD-Core
* `SD-Core Website <https://opennetworking.org/sd-core/>`_
* :doc:`SD-Core Documentation <sdcore:index>`
* SD-Fabric
* `SD-Fabric Website <https://opennetworking.org/sd-fabric/>`_
* :doc:`SD-Fabric Documentation <sdfabric:index>`
* SD-RAN
* `SD-RAN Website <https://opennetworking.org/sd-ran/>`_
* :doc:`SD-RAN Documentation <sdran:index>`
More information about mobile networks and 5G can be found in the :doc:`5G
Mobile Networks: A Systems Approach <sysapproach5g:intro>` book.
Community
---------
Information about participating in the Aether community and development process
can be found on the `ONF Wiki
<https://wiki.opennetworking.org/display/COM/Aether>`_.
.. toctree::
:maxdepth: 3
:caption: Aether Quick Start
:hidden:
:glob:
developer/aiab
developer/aiabhw
developer/contributing.rst
.. toctree::
:maxdepth: 3
:caption: Operations
:hidden:
:glob:
operations/gui
operations/subscriber
operations/application
operations/slice
operations/metering
operations/monitor
operations/procedures
.. toctree::
:maxdepth: 3
:caption: Production Edge Deployment
:hidden:
:glob:
edge_deployment/overview
edge_deployment/site_planning
edge_deployment/management_net_bootstrap
edge_deployment/server_bootstrap
edge_deployment/fabric_switch_bootstrap
edge_deployment/vpn_bootstrap
edge_deployment/runtime_deployment
edge_deployment/bess_upf_deployment
edge_deployment/sdfabric_deployment
edge_deployment/connectivity_service_update
edge_deployment/enb_installation
edge_deployment/site_remove
edge_deployment/troubleshooting
edge_deployment/pronto
.. toctree::
:maxdepth: 3
:caption: Aether Management Platform
:hidden:
:glob:
amp/roc
amp/subproxy
amp/monitoring
.. toctree::
:maxdepth: 3
:caption: ROC Development
:hidden:
:glob:
developer/roc
developer/roc-api
.. toctree::
:maxdepth: 3
:caption: Aether Test Automation
:hidden:
:glob:
testing/about_system_tests
testing/aether-roc-tests
testing/system-tests
testing/acceptance_specification
.. toctree::
:maxdepth: 2
:caption: Releases
:hidden:
:glob:
release/1*
release/2*
release/process.rst