Fix changelog links and titles
[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
4 Installation Guide
5 ==================
6
7 .. contents::
8    :depth: 3
9    :local:
10
11 Optional ENV Variables
12 ----------------------
13
14 You can set the following ENVs to change the A1 behavior:
15
16 1. ``RMR_RETRY_TIMES`` the number of times failed rmr operations such as
17 timeouts and send failures should be retried before A1 gives up and
18 returns a 503. The default is ``4``.
19
20 K8S
21 ---
22 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.
23
24 Local Docker
25 -------------
26
27 building
28 ~~~~~~~~
29 ::
30
31    docker build --no-cache -t a1:X.Y.Z .
32
33 .. _running-1:
34
35 running
36 ~~~~~~~
37
38 ::
39
40    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
41