X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Finstallation-guide.rst;h=111058d3050d01554ced39353de4cc7e339c1ed5;hb=refs%2Fchanges%2F37%2F3537%2F1;hp=abada0fdec2c8c9c941d15d91a8948c89a191629;hpb=fe30c1726c397b1ee100cd3d3795758e7d21b6bf;p=ric-plt%2Fa1.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index abada0f..111058d 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -12,7 +12,7 @@ A1 Installation Guide Optional ENV Variables ---------------------- -You can set the following ENVs to change the A1 behavior: +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``. @@ -20,6 +20,8 @@ You can set the following ENVs to change the A1 behavior: 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. @@ -38,11 +40,13 @@ 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 + docker run -e USE_FAKE_SDL=True -p 10000:10000 -v /path/to/local.rt:/opt/route/local.rt a1:latest View container API ~~~~~~~~~~~~~~~~~~ @@ -56,8 +60,8 @@ A web user interface generated from the OpenAPI specification can be accessed at 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. ::