datarouter-prov/src/main/resources/misc/notes

   1 Package notes for com.att.dmaap.datarouter:prov
   2
   3 This component is for the Data Router Provisioning Server software.
   4
   5 The following pre-requisite components should already be present:
   6     com.att.aft.swm:swm-cli
   7     com.att.aft.swm:swm-node
   8     - SWM Variables: AFTSWM_AUTOLINK_PARENTS=/opt/app:/opt/app/workload,/opt/app/aft:/opt/app/workload/aft
   9     com.att.platform:uam-auto
  10     com.att.java:jdk8lin
  11     com.att.platform:initd
  12     com.att.platform:port-fwd
  13     - SWM Variables: PLATFORM_PORT_FWD=80,8080|443,8443
  14     mysql:mysql
  15     mysql:mysql-config
  16     - SWM Variables: MYSQL_CONFIG_SIZE=small
  17         MYSQL_DB_DATABASES=datarouter
  18         MYSQL_DB_datarouter_USERS=datarouter,tier2
  19         MYSQL_DB_datarouter_USERS_datarouter_LEVEL=RW
  20         MYSQL_DB_datarouter_USERS_datarouter_PASSWORD=datarouter
  21         MYSQL_DB_datarouter_USERS_tier2_LEVEL=RO
  22         MYSQL_DB_datarouter_USERS_tier2_PASSWORD=<password>
  23         MYSQL_MAX_ALLOWED_PACKET=32M
  24         MYSQL_MAX_CONNECTIONS=300
  25         MYSQL_PASSWORD=datarouter
  26         MYSQL_PORT=3306
  27
  28
  29 In a production environment, the SWM variables that MUST be overwridden are:
  30     DRTR_PROV_ACTIVEPOD, DRTR_PROV_STANDBYPOD, DRTR_PROV_NODES
  31 In addition, in a non-production environment, the DRTR_PROV_CNAME SWM variable
  32 must also be overwridden.
  33
  34 The SWM variables that can be set to control the provisioning server are:
  35
  36 DRTR_PROV_ACTIVEPOD
  37     The FQDN of the active POD
  38 DRTR_PROV_STANDBYPOD
  39     The FQDN of the standby POD
  40 DRTR_PROV_CNAME (default feeds-drtr.web.att.com)
  41     The DNS CNAME used for the prov server in this environment.
  42 DRTR_PROV_NODES
  43     Pipe-delimited list of DR nodes to init the DB with.
  44 DRTR_PROV_DOMAIN (default web.att.com)
  45     Domain to use for non-FQDN node names
  46
  47 DRTR_PROV_INTHTTPPORT (default 8080)
  48     The TCP/IP port number the component should listen on for "go fetch"
  49     requests from the provisioning server
  50 DRTR_PROV_INTHTTPSPORT (default 8443)
  51     The TCP/IP port number the component should listen on for publish
  52     requests from feed publishers and other nodes
  53 DRTR_PROV_LOGS (default /opt/app/datartr/logs)
  54     The directory where log files should be kept
  55 DRTR_PROV_SPOOL (default /opt/app/datartr/spool)
  56     The directory where logfiles from the DR nodes are spooled before being
  57     imported into the DB.
  58
  59 DRTR_PROV_KEYMGRPASS (default changeit)
  60     The password for the key manager
  61 DRTR_PROV_KSTOREFILE (default /opt/app/datartr/etc/keystore)
  62     The java keystore file containing the server certificate and private key
  63     for this server
  64 DRTR_PROV_KSTOREPASS (default changeit)
  65     The password for the keystore file
  66 DRTR_PROV_TSTOREFILE (by default, use the truststore from the Java JDK)
  67     The java keystore file containing the trusted certificate authority
  68     certificates
  69 DRTR_PROV_TSTOREPASS (default changeit)
  70     The password for the trust store file.  Only applies if a trust store
  71     file is specified.
  72
  73 DRTR_PROV_DBLOGIN (default datarouter)
  74     The login used to access MariaDB
  75 DRTR_PROV_DBPASS (default datarouter)
  76     The password used to access MariaDB
  77 DRTR_PROV_DBSCRIPTS (default /opt/app/datartr/etc)
  78     The directory containing DB initialization scripts