AETHER-2011 (part1)
Add basic 1.5 release documentation framework
Update edge deployment docs
- Describe different topologies and add deployment diagrams
- Split out Pronto BOM and diagrams
- Make BESS diagram a SVG
Updates to Sphinx and modules, fixed linkcheck to have a timeout/retry
for faulty webservers.
Fix spelling and formatting issue across entire site, remove "Smart
quotes" that cause the spellchecker to throw errors. Add many more
dictionary entries. Make spelling fail the build. Fix all spelling and
grammar errors that triggered failures.
Add autosectionlabel, and manage duplicate section names where they
existed.
Updated readme on image/diagram embedding
Added docs on PoE power cycle with Aruba switches (Pronto)
Change-Id: I7f9f7afae13788f9fe29bfe2683a295ba7b8914e
diff --git a/testing/aether-roc-tests.rst b/testing/aether-roc-tests.rst
index 023fec4..2b5aa29 100644
--- a/testing/aether-roc-tests.rst
+++ b/testing/aether-roc-tests.rst
@@ -1,5 +1,5 @@
-Instructions For Running The ROC Tests
-======================================
+ROC Testing
+===========
The REST API and the GUI of the Aether ROC is tested utilizing the Robot Framework.
The tests are located inside the aether-system-tests repository and they are run nightly using
@@ -11,23 +11,24 @@
This can be done with the use of Helm (see instructions on
`this page <https://docs.onosproject.org/onos-docs/docs/content/developers/deploy_with_helm/>`_).
-Additionally, it is necessary to add the sdran chart repo with the following command:
+Additionally, it is necessary to add the SD-RAN chart repo with the following command:
.. code-block:: shell
helm repo add sdran --username USER --password PASSWORD https://sdrancharts.onosproject.org
-where USER and PASSWORD can be obtained from the Aether Login Information file, which is
-accessibble to the ``onfstaff`` group.
+where USER and PASSWORD can be obtained from the Aether Login Information file,
+which is accessible to the ``onfstaff`` group.
-Finally, the ROC GUI tests are running on the Firefox browser, so it is nesessary to have the Firefox browser and the
-Firefox web driver (geckodriver) installed on the system in order to run these tests.
+Finally, the ROC GUI tests are running on the Firefox browser, so it is
+necessary to have the Firefox browser and the Firefox web driver
+(``geckodriver``) installed on the system in order to run these tests.
Running the ROC API tests
-------------------------
Follow the steps below to access the ROC API:
-1. Deploy the aether-roc-umbrella chart from the sdran repo with the following command:
+1. Deploy the ``aether-roc-umbrella`` chart from the SD-RAN repo with the following command:
.. code-block:: shell
@@ -125,13 +126,17 @@
Running the ROC GUI tests
-------------------------
-We are testing the ROC GUI by installing the ROC on a local dex server. To install the dex server, please follow
-the steps under the "Helm install" section of the Readme file in `this repository <https://github.com/onosproject/onos-helm-charts/tree/master/dex-ldap-umbrella>`_.
-Once that you have installed the ``dex-ldap-umbrella`` chart, follow the steps below to install the ROC
-on a local dex server:
+We test the ROC GUI by installing the ROC on a local Dex server. To install the
+Dex server, please follow the steps under the "Helm install" section of the
+readme file in `this repository
+<https://github.com/onosproject/onos-helm-charts/tree/master/dex-ldap-umbrella>`_.
-1. Deploy the aether-roc-umbrella chart from the sdran repo with the following command:
+Once that you have installed the ``dex-ldap-umbrella`` chart, follow the steps
+below to install the ROC on a local Dex server:
+
+1. Deploy the ``aether-roc-umbrella`` chart from the SD-RAN repo with the
+ following command:
.. code-block:: shell
@@ -176,7 +181,7 @@
kubectl -n micro-onos port-forward $(kubectl -n micro-onos get pods -l type=api -o name) 8181
-3. Finalluy, port-forward the dex service to port 5556:
+3. Finally, port-forward the Dex service to port 5556:
.. code-block:: shell
@@ -227,11 +232,11 @@
mkdir results
-7. Run any Robot Framework test file from the ``3_0_0`` directory.
-Each test file corresponds to one of the Aether 3.0.0 models.
+7. Run any Robot Framework test file from the ``3_0_0`` directory. Each test
+ file corresponds to one of the Aether 3.0.0 models.
.. code-block:: shell
robot -d results <model-name>.robot
-| This will generate test reports and logs in the ``results`` directory.
+This will generate test reports and logs in the ``results`` directory.