X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=9a191790936fce0d8e7932e49fd39abf95da4ed3;hb=refs%2Fchanges%2F23%2F11823%2F2;hp=abada0fdec2c8c9c941d15d91a8948c89a191629;hpb=fe30c1726c397b1ee100cd3d3795758e7d21b6bf;p=ric-plt%2Fa1.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index abada0f..9a19179 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -2,30 +2,27 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 AT&T Intellectual Property -A1 Installation Guide -===================== +Installation Guide +================== .. contents:: :depth: 3 :local: -Optional ENV Variables ----------------------- +Environment Variables +--------------------- -You can set the following ENVs 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. - -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 ~~~~~~~~~~~~~~~ @@ -38,26 +35,20 @@ Build the image Start the container ~~~~~~~~~~~~~~~~~~~ -A sample RMR routing table is supplied here in file `local.rt` for mounting as a volume: +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 -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: - -:: + docker run -e USE_FAKE_SDL=True -p 10000:10000 -v /path/to/local.rt:/opt/route/local.rt a1:latest - http://docker-host-name-or-ip:10000/ui Check container health ~~~~~~~~~~~~~~~~~~~~~~ -The following command requests the container health. This requires a Storage Data Layer -(SDL) service; expect internal server error if that service is not available/running. +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. ::