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 Environment Variables
  13 ---------------------
  14
  15
  16 Kubernetes Deployment
  17 ---------------------
  18 The official Helm chart for the A1 Mediator is in a deployment repository, which holds all of the Helm charts
  19 for the RIC platform. There is a helm chart in `integration_tests` here for running the integration tests as
  20 discussed above.
  21
  22 Local Deployment
  23 ----------------
  24
  25 Build and run the A1 mediator locally using the docker CLI as follows.
  26
  27 Build the image
  28 ~~~~~~~~~~~~~~~
  29 ::
  30
  31    docker build --no-cache -t a1:latest .
  32
  33 .. _running-1:
  34
  35 Start the container
  36 ~~~~~~~~~~~~~~~~~~~
  37
  38 The A1 container depends on a companion DBaaS (SDL) container, but if that is not convenient set
  39 an environment variable as shown below to mock that service.  Also a sample RMR routing table is
  40 supplied in file `local.rt` for mounting as a volume.  The following command uses both:
  41
  42 ::
  43
  44    docker run -e USE_FAKE_SDL=True -p 10000:10000 -v /path/to/local.rt:/opt/route/local.rt a1:latest
  45
  46
  47 Check container health
  48 ~~~~~~~~~~~~~~~~~~~~~~
  49
  50 The following command requests the container health.  Expect an internal server error if the
  51 Storage Data Layer (SDL) service is not available or has not been mocked as shown above.
  52
  53 ::
  54
  55     curl docker-host-name-or-ip:10000/A1-P/v2/healthcheck