docs/deployment-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   4
   5 Deployment Guide
   6 ================
   7
   8 Build
   9
  10 .. code-block:: bash
  11
  12     cd ves-nf-oam-adopter
  13     mvn clean install -Pdocker
  14
  15 Go to solution folder and execute
  16
  17 .. code-block:: bash
  18
  19     cd solution
  20     docker-compose up
  21
  22 **Environment variables**
  23
  24 - **SERVER_PORT:** Application server port. Default 443.
  25 - **USERNAME:** basic auth username for adapter service. Default admin.
  26 - **PASSWORD:** basic auth password for adapter service. Default admin.
  27
  28 - **KEYSTORE_PATH:** path to ssl certificates key store.
  29 - **KEY_STORE_PASSWORD:** key store password.
  30 - **KEY_PASSWORD:** key password.
  31 - **TRUST_STORE_PATH:** path to ssl certificates trust store.
  32 - **TRUST_STORE_PASSWORD:** trust store password.
  33
  34 - **VES_COLLECTOR:** ves collector url.
  35 - **VES_ENCODED_AUTH:** Base64-encoded basic auth e.g. YWRtaW46YWRtaW4= (admin:admin)
  36
  37 - **CONNECTION_TIMEOUT:** HTTP client connection timeout(seconds). Default value 600.
  38 - **RESPONSE_TIMEOUT:** HTTP client response timeout(seconds). Default value 600.
  39
  40 - **PM_SYNC_TIME_START:** Defines the time for first execution of pull of PM files and forwarding as VES Message.
  41 - **PM_SYNC_TIME_FREQ:** Define the frequency to trigger the pull and forward of PM data after first execution.
  42 - **PM_MAPPING_FILE_PATH:** Defines the path where mapping configuration file is located. Default value.
  43
  44 - **SNMP_PORT:** UDP port to listen SNMP traps. Default value 162.
  45 - **FM_MAPPING_FILE_PATH:** Defines the path where mapping configuration file is located. Default value.
  46
  47
  48