X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=9a191790936fce0d8e7932e49fd39abf95da4ed3;hb=6a289e8ccf5816ac6b5de417d6edffcb7b024471;hp=0b1de6ac9b508d8b2ebe50181d4c13119698b3a9;hpb=39c9ab62125be03194b4c433b4f9fa4617d0a65d;p=ric-plt%2Fa1.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 0b1de6a..9a19179 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -9,25 +9,20 @@ Installation Guide :depth: 3 :local: -Optional ENV Variables ----------------------- +Environment Variables +--------------------- -You can set the following environment variables when launching a container to change the A1 behavior: -1. ``A1_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. -2. ``INSTANCE_DELETE_NO_RESP_TTL``: Please refer to the delete flowchart in docs/; this is ``T1`` there. The default is 5 (seconds). Basically, the number of seconds that a1 waits to remove an instance from the database after a delete is called in the case that no downstream apps responded. +Local Deployment +---------------- -3. ``INSTANCE_DELETE_RESP_TTL``: Please refer to the delete flowchart in docs/; this is ``T2`` there. The default is 5 (seconds). Basically, the number of seconds that a1 waits to remove an instance from the database after a delete is called in the case that downstream apps responded. - -4. ``USE_FAKE_SDL``: This allows testing of the A1 feature without a DBaaS SDL container. The default is False. - -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 -------------- +Build and run the A1 mediator locally using the docker CLI as follows. Build the image ~~~~~~~~~~~~~~~ @@ -48,14 +43,6 @@ supplied in file `local.rt` for mounting as a volume. The following command use docker run -e USE_FAKE_SDL=True -p 10000:10000 -v /path/to/local.rt:/opt/route/local.rt a1:latest -View container API -~~~~~~~~~~~~~~~~~~ - -A web user interface generated from the OpenAPI specification can be accessed at this URL: - -:: - - http://docker-host-name-or-ip:10000/ui Check container health ~~~~~~~~~~~~~~~~~~~~~~