Merge "Merge branch 'development'"
[ric-plt/a1.git] / docs / installation-guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2019 AT&T Intellectual Property
4
5 Installation Guide
6 ==================
7
8 .. contents::
9    :depth: 3
10    :local:
11
12 Optional ENV Variables
13 ----------------------
14
15 You can set the following ENVs to change the A1 behavior:
16
17 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``.
18
19 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.
20
21 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.
22
23 K8S
24 ---
25 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.
26
27 Local Docker
28 -------------
29
30 building
31 ~~~~~~~~
32 ::
33
34    docker build --no-cache -t a1:X.Y.Z .
35
36 .. _running-1:
37
38 running
39 ~~~~~~~
40
41 ::
42
43    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
44