RIC:1060: Change in PTL

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

diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 5ddad48..c6d1752 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -1,5 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 AT&T Intellectual Property
 
 Installation Guide
 ==================
@@ -8,34 +9,47 @@ Installation Guide
    :depth: 3
    :local:
 
-Optional ENV Variables
-----------------------
+Environment Variables
+---------------------
 
-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``.
+Kubernetes Deployment
+---------------------
+The official Helm chart for the A1 Mediator is in a deployment repository, which 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.
 
-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 Deployment
+----------------
 
-Local Docker
--------------
+Build and run the A1 mediator locally using the docker CLI as follows.
 
-building
-~~~~~~~~
+Build the image
+~~~~~~~~~~~~~~~
 ::
 
-   docker build --no-cache -t a1:X.Y.Z .
+   docker build --no-cache -t a1:latest .
 
 .. _running-1:
 
-running
-~~~~~~~
+Start the container
+~~~~~~~~~~~~~~~~~~~
+
+The A1 container depends on a companion DBaaS (SDL) container, but if that is not convenient set
+an environment variable as shown below to mock that service.  Also a sample RMR routing table is
+supplied in file `local.rt` for mounting as a volume.  The following command uses both:
 
 ::
 
-   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
+   docker run -e USE_FAKE_SDL=True -p 10000:10000 -v /path/to/local.rt:/opt/route/local.rt a1:latest
+
+
+Check container health
+~~~~~~~~~~~~~~~~~~~~~~
+
+The following command requests the container health.  Expect an internal server error if the
+Storage Data Layer (SDL) service is not available or has not been mocked as shown above.
+
+::
 
+    curl docker-host-name-or-ip:10000/A1-P/v2/healthcheck