[DMAAP-48] Initial code import
[dmaap/datarouter.git] / datarouter-node / src / main / resources / misc / notes
1 package notes for com.att.dmaap.datarouter:node
2
3 This component is for the Data Router Node 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         com.att.dmaap.datarouter:util
15
16 In a non-production environment, the URL for fetching provisioning data from
17 the provisioning server must be overridden.  This can be done by setting a SWM
18 variable prior to installing this component.  The production (default) value for
19 this variable is:
20         DRTR_PROV_INTURL=https://feeds-drtr.web.att.com/internal/prov
21
22 Similarly, the URL for uploading event logs to the log server must be overridden.  This can also be done by setting a SWM variable.  The production (default) value is:
23         DRTR_LOG_URL=https://feeds-drtr.web.att.com/internal/logs
24
25 Other SWM variables that can be set are:
26
27 DRTR_NODE_INTHTTPPORT (default 8080)
28         The TCP/IP port number the component should listen on for "go fetch"
29         requests from the provisioning server
30 DRTR_NODE_INTHTTPSPORT (default 8443)
31         The TCP/IP port number the component should listen on for publish
32         requests from feed publishers and other nodes
33 DRTR_NODE_EXTHTTPSPORT (default 443)
34         The TCP/IP port number the component should use for node-to-node
35         transfers and for sending redirect requests back to publishers
36 DRTR_NODE_SPOOL (default /opt/app/datartr/spool)
37         The directory where data files should be saved while in transit
38 DRTR_NODE_LOGS (default /opt/app/datartr/logs)
39         The directory where log files should be kept
40 DRTR_NODE_LOG_RETENTION (default 30)
41         How long a log file is kept before being deleted
42 DRTR_NODE_KSTOREFILE (default /opt/app/datartr/etc/keystore)
43         The java keystore file containing the server certificate and private key
44         for this server
45 DRTR_NODE_KSTOREPASS (default changeit)
46         The password for the keystore file
47 DRTR_NODE_PVTKEYPASS (default changeit)
48         The password for the private key in the keystore file
49 DRTR_NODE_TSTOREFILE (by default, use the truststore from the Java JDK)
50         The java keystore file containing the trusted certificate authority
51         certificates
52 DRTR_NODE_TSTOREPASS (default changeit)
53         The password for the trust store file.  Only applies if a trust store
54         file is specified.