docs/index.rst

   1 .. ==================================================================================
   2 ..       Copyright (c) 2019 Nokia
   3 ..       Copyright (c) 2018-2019 AT&T Intellectual Property.
   4 ..
   5 ..   Licensed under the Apache License, Version 2.0 (the "License");
   6 ..   you may not use this file except in compliance with the License.
   7 ..   You may obtain a copy of the License at
   8 ..
   9 ..          http://www.apache.org/licenses/LICENSE-2.0
  10 ..
  11 ..   Unless required by applicable law or agreed to in writing, software
  12 ..   distributed under the License is distributed on an "AS IS" BASIS,
  13 ..   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 ..   See the License for the specific language governing permissions and
  15 ..   limitations under the License.
  16 .. ==================================================================================
  17
  18 A1 Mediator
  19 ===========
  20
  21 API
  22 ===
  23
  24 You can see the API (OpenAPI3 spec) at ``a1/openapi.yml``. You can also
  25 see the “pretty” version if you run the container at
  26 ``http://localhost:10000/ui/``.
  27
  28 Running
  29 =======
  30
  31 Optional ENV Variables
  32 ----------------------
  33
  34 You can set the following ENVs to change the A1 behavior: 1)
  35 ``RMR_RCV_RETRY_INTERVAL`` the number of milliseconds that execution
  36 will defer (back to the server loop to handle http request if
  37 applicable) when an expected ack is not received by rmr call. The
  38 default is ``1000`` (1s). The time for the full HTTP request to
  39 ``PUT /policies`` will be > this if an ACK is not recieved within 10ms,
  40 which is an initial delay until the first rcv is tried. 2)
  41 ``RMR_RETRY_TIMES`` the number of times failed rmr operations such as
  42 timeouts and send failures should be retried before A1 gives up and
  43 returns a 503. The default is ``4``.
  44
  45 K8S
  46 ---
  47 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.
  48
  49 Local Docker
  50 ------------
  51
  52 building
  53 ~~~~~~~~
  54 ::
  55
  56    docker build --no-cache -t a1:X.Y.Z .
  57
  58 .. _running-1:
  59
  60 running
  61 ~~~~~~~
  62
  63 ::
  64
  65    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