Move integration tests to k8s

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

diff --git a/docs/index.rst b/docs/index.rst
index 316ef9e..26a89e0 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -39,14 +39,28 @@ Integration testing
 ===================
 
 This tests A1’s external API with two test receivers. Note, this
-currently depends on docker-compose, meaning you cannot run this if
-docker-compose is not installed. Note2: this is not fast. It builds the
-containers and launches requests against the API so it takes time.
+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
 =======
 
@@ -64,12 +78,15 @@ which is an initial delay until the first rcv is tried. 2)
 timeouts and send failures should be retried before A1 gives up and
 returns a 503. The default is ``4``.
 
-Docker
-------
+K8S
+---
+The "real" helm chart for A1 is in the LF it/dep repo. That repo holds all of the helm charts for the RIC platform. There is a helm chart in `integration_tests` here for running the integration tests as discussed above.
+
+Local Docker
+------------
 
 building
 ~~~~~~~~
-
 ::
 
    docker build --no-cache -t a1:X.Y.Z .
@@ -79,8 +96,6 @@ building
 running
 ~~~~~~~
 
-(TODO: this will be enhanced with Helm.)
-
 ::
 
    docker run -dt -p 10000:10000 -v /path/to/localrt:/opt/route/local.rt -v /path/to/ricmanifest:/opt/ricmanifest.json a1:X.Y.Z -v