RIC:1060: Change in PTL

[ric-plt/a1.git] / docs / developer-guide.rst

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 4c0d38d..e2e258b 100644 (file)
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1,8 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-A1 Developer Guide
-==================
+Developer Guide
+===============
 
 .. contents::
    :depth: 3
@@ -11,71 +11,25 @@ A1 Developer Guide
 Tech Stack
 ----------
 
--  OpenAPI3
--  Connexion
--  Flask with Gevent serving
--  Python3.8
+The A1 Mediator is implemented in Golang.
 
-Version bumping A1
-------------------
 
-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/v2/healthcheck
 
-5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
-
-6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
-
-
-Version bumping RMR
--------------------
-
-As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three
-integration test receivers use an Alpine base image and install RMR
-from a base builder image.  Must update and rebuild all 5 containers
-in the A1 repo (or just A1 itself for prod usage).
-
-In addition these items in this repo must be kept in sync:
-* ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
-* ``integration_tests/install_rmr.sh`` is a useful script for a variety of local testing.
-
-Version bumping Python
-----------------------
-
-If you want to update the version of python itself (ie just done from 37 to 38):
-
-1) ``Dockerfile``
-
-2) ``Dockerfile-Unit-Test``
-
-3) ``tox.ini``
-
-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
 -------------------
@@ -101,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 3 helm charts (5 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