Final A1 V1.0.0 Release (but 1.1.0 to come)

[ric-plt/a1.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 26a89e0..7cb73bf 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,56 +25,15 @@ You can see the API (OpenAPI3 spec) at ``a1/openapi.yml``. You can also
 see the “pretty” version if you run the container at
 ``http://localhost:10000/ui/``.
 
-Unit Testing
-============
-
-Note, this requires rmr to be installed!
-
-::
-
-   tox
-   open htmlcov/index.html
-
-Integration testing
-===================
-
-This tests A1’s external API with two test receivers. Note, this
-currently depends on helm+k8s, meaning you cannot run this if
-this is not installed.
-
-If you've never run the integration tests before, build the test receiver
-::
-
-    cd integration_tests
-    docker build  --no-cache -t testreceiver:latest .
-
-Else, from the root,
-::
-
-   tox -c tox-integration.ini
-
-This script:
-1. Deploys 3 helm charts into a local kubernetes installation
-2. Port forwards a pod ClusterIP to localhost
-3. Uses “tavern” to run some tests against the server
-4. Barrages the server with apache bench
-5. Tears everything down
-
-
 Running
 =======
 
 Optional ENV Variables
 ----------------------
 
-You can set the following ENVs to change the A1 behavior: 1)
-``RMR_RCV_RETRY_INTERVAL`` the number of milliseconds that execution
-will defer (back to the server loop to handle http request if
-applicable) when an expected ack is not received by rmr call. The
-default is ``1000`` (1s). The time for the full HTTP request to
-``PUT /policies`` will be > this if an ACK is not recieved within 10ms,
-which is an initial delay until the first rcv is tried. 2)
-``RMR_RETRY_TIMES`` the number of times failed rmr operations such as
+You can set the following ENVs to change the A1 behavior:
+
+1. ``RMR_RETRY_TIMES`` the number of times failed rmr operations such as
 timeouts and send failures should be retried before A1 gives up and
 returns a 503. The default is ``4``.