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

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index d9a3a8a..9c0132c 100644
--- 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,60 +11,95 @@ A1 Developer Guide
 Tech Stack
 ----------
 
--  OpenAPI3
--  Connexion
--  Flask with Gevent serving
--  Python3.8
+The A1 Mediator is implemented in Python, currently version 3.8, and
+depends on these third-party packages and technologies:
+
+- OpenAPI3
+- Connexion
+- Flask with Gevent serving
+- Swagger
+- Prometheus
+
 
 Version bumping A1
 ------------------
 
-This project follows semver. When changes are made, the versions are in:
+This project follows semver. When the version string changes, these
+files must be updated:
 
-1) ``docs/release-notes.rst``
+#. ``setup.py``
+#. ``container-tag.yaml``
+#. ``integration_tests/a1mediator/Chart.yaml``
+#. ``docs/release-notes.rst``
+#. ``a1/openapi.yaml`` But note this is an API version, not a software version; there's no need to bump on non-API changes.
+#.  And over in the ric-plt/ric-dep repo that contains the A1 Mediator helm chart, files ``values.yaml`` and ``Chart.yaml``.
 
-2) ``setup.py``
+It's convenient to use the Python utility `bumpversion` to maintain
+the first three items.  After setup (``pip install bumpversion``) you
+can change the patch version like this::
 
-3) ``container-tag.yaml``
+    bumpversion --verbose patch
 
-4) ``integration_tests/a1mediator/Chart.yaml``
+Or change the minor version like this::
 
-5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
+    bumpversion --verbose minor
 
-6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
+After the `bumpversion` utility has modified the files, update the
+release notes then commit.
 
 
 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).
+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 production 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.
+
+#. ``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):
+If you want to update the version of python; for example this was
+recently done to move from 3.7 to 3.8, update these files:
+
+#. ``Dockerfile``
+#. ``Dockerfile-Unit-Test``
+#. ``tox.ini``
+
 
-1) ``Dockerfile``
+Running A1 Standalone
+---------------------
 
-2) ``Dockerfile-Unit-Test``
+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::
+
+    docker run -e USE_FAKE_SDL=True -p 10000:10000 -v `pwd`:/opt/route [DOCKER_IMAGE_ID_HERE]
+
+Then test the server with an invocation such as this::
+
+    curl localhost:10000/a1-p/healthcheck
 
-3) ``tox.ini``
 
 Unit Testing
 ------------
 
 Running the unit tests requires the python packages ``tox`` and ``pytest``.
 
-The RMR library is also required during unit tests. If running directly from tox
-(outside a Docker container), install RMR using the script in the integration_tests
-directory: ``install_rmr.sh``.
+The RMR library is also required during unit tests. If running
+directly from tox (outside a Docker container), install RMR using the
+script in the integration_tests directory: ``install_rmr.sh``.
 
 Upon completion, view the test coverage like this:
 
@@ -80,6 +115,7 @@ less nice because you don't get the pretty HTML)
 
    docker build  --no-cache -f Dockerfile-Unit-Test .
 
+
 Integration testing
 -------------------
 
@@ -104,8 +140,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