X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=f2db426ac82c21fb0268810a272f8ca4418a475f;hb=efeb06cc49320e812441a43a071907a9830955ad;hp=e3e47c5dab8b78f9302aab6920fe30002645bc6d;hpb=9d5ad7161f64346c17e9c466bf1992e4257e9bde;p=ric-plt%2Fa1.git

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index e3e47c5..f2db426 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,7 +1,7 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Developer-Guide
+Developer Guide
 ===============
 
 .. contents::
@@ -11,79 +11,41 @@ Developer-Guide
 Tech Stack
 ----------
 
--  OpenAPI3
--  Connexion
--  Flask with Gevent serving
--  Python3.7
+The A1 Mediator is implemented in Golang.
 
-Version bumping
----------------
 
-This project follows semver. When changes are made, the versions are in:
+Running A1 Standalone
+---------------------
 
-1) ``docs/release-notes.rst``
+The A1 container can be run standalone, which means using an in-memory mock
+version of SDL and a static route table. The host machine must have the RMR
+library and the environment must define the variable `prometheus_multiproc_dir`
+with a value like /tmp.  Alternately, use the following command to run A1 as
+a Docker container, using a route table mounted as a file from this git
+repository and exposing the server's HTTP port on the Docker host::
 
-2) ``setup.py``
+    docker run -e USE_FAKE_SDL=True -p 10000:10000 -v `pwd`:/opt/route [DOCKER_IMAGE_ID_HERE]
 
-3) ``container-tag.yaml``
+Then test the server with an invocation such as this::
 
-4) ``integration_tests/a1mediator/Chart.yaml``
+    curl localhost:10000/a1-p/healthcheck
 
-6) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
-
-7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
-
-
-Version bumping rmr
---------------------
-rmr is a critical dependency of A1. Bumping the rmr version dependency requires changes in:
-
-1) ``Dockerfile``
-
-2) ``Dockerfile-Unit-Test``
-
-3) ``integration_tests/Dockerfile-test-delay-receiver``
-
-4) ``integration_tests/Dockerfile-query-receiver``
-
-5) ``rmr-version.yaml``
-
-rmr-python is the python binding to rmr . Installing rmr per the above does not install it.
-Bumping the rmr python version dependency requires changes in:
-
-1) ``setup.py``
-
-2) ``integration_tests/Dockerfile-test-delay-receiver``
-
-3) ``integration_tests/Dockerfile-query-receiver``
-
-Run the integration tests after attempting this.
-
-Unit Testing
-------------
-Note,  before this will work, for the first time on the machine running the tests, run ``./install_deps.sh``. This is only needed once on the machine.
-Also, this requires the python packages ``tox`` and ``pytest``.
-
-::
-
-   tox
-   open htmlcov/index.html
-
-Alternatively, you can run the unit tests in Docker (this is somewhat less nice because you don't get the pretty HTML)
-
-::
-
-   docker build  --no-cache -t a1test:latest -f Dockerfile-Unit-Test
 
 Integration testing
 -------------------
-This tests A1’s external API with three test receivers. This depends on helm+k8s.
 
-Build all the containers:
+This tests A1’s external API with three test receivers. This requires
+docker, kubernetes and helm.
+
+Build all the images:
 
 ::
 
-    docker build  -t a1:latest .; cd integration_tests/; docker build  -t testreceiver:latest . -f Dockerfile-test-delay-receiver; docker build -t queryreceiver:latest . -f Dockerfile-query-receiver; cd ..
+    docker build  -t a1:latest .
+    cd integration_tests/testxappcode
+    docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
+    docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
+    docker build -t testreceiver:latest  -f Dockerfile-test-receiver  .
 
 
 Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
@@ -93,8 +55,9 @@ Then, run all the tests from the root (this requires the python packages ``tox``
    tox -c tox-integration.ini
 
 This script:
-1. Deploys 2 helm charts (4 containers) 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
+
+#. Deploys 3 helm charts (5 containers) into a local kubernetes installation
+#. Port forwards a pod ClusterIP to localhost
+#. Uses “tavern” to run some tests against the server
+#. Barrages the server with Apache bench
+#. Tears everything down