X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=ff12eca2e6304e61a95f8329841a2b0a2f1a7692;hb=d26734faf0366f95ed055a783fed8297f8c63ff6;hp=5ddad4851f4379820a06f0aac92fe357a357c56c;hpb=4249398baf8e9607f4e2a88d214410affc818666;p=ric-plt%2Fa1.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 5ddad48..ff12eca 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,8 +1,9 @@ .. 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 -================== +A1 Installation Guide +===================== .. contents:: :depth: 3 @@ -13,9 +14,11 @@ Optional ENV 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``. +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``. + +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. + +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 --- @@ -37,5 +40,5 @@ running :: - 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 -dt -p 10000:10000 -v /path/to/localrt:/opt/route/local.rt a1:X.Y.Z -v