16.20 - Customizing Values Used in PUT Installation - Data Stream Utility

Teradata® DSA - DSU Installation, Configuration, and Upgrade Guide

prodname
BAR
Data Stream Architecture
Data Stream Utility
vrm_release
16.20
created_date
September 2019
category
Configuration
Installation
featnum
B035-3153-127K
A dsainputs file, which includes the input values for all the DSA components being installed on that server, is required to install DSA components with PUT. Each DSA server needs its own dsainputs file, customized for that server. The values will vary from server to server.
  1. Create a dsainputs file under the /tmp directory on the system where the DSA packages will be installed. A dsainput template is available in all DSA packages. The template for the DSC is a compilation of all inputs required for all the packages: dsacomp_tdput_template.
    Keep the dsainputs file in a secure location. The dsainputs file that is placed in /tmp cannot be used by subsequent installation or upgrade processes.
  2. Insert the parameters and values for the component you are installing. Values are specific for that server. For example: BURL=dsasrv1
    Important: You must add DSARESTSCHEME to the dsainputs file.
    Parameter Component Description
    BARSIZE DSC The size of the BAR database, in GB, that holds the repository. Acceptable values: 1 to 800.
    BROKERLIST ClientHandler List of broker:port pairs separated by a comma. For example: dsasrv1:61616
    BURL DSC, ClientHandler, BAR Command Line Hostname or IP address of the machine running the JMS broker (ActiveMQ). If the broker is running on the DSC server, use localhost as the parameter. Hostname or IP address of the machine running the ActiveMQ broker (where tdactivemq is installed), usually the DSC server.
    BPORT DSC, ClientHandler, BAR Command Line Port number on the server where the ActiveMQ broker is listening (61616 for tcp, 61617 for ssl). Default: 61616
    CONNECTION DSC, ClientHandler, BAR Command Line, BARPortlets Type of ActiveMQ connection (tcp or ssl). If tcp is chosen, the ActiveMQ connection is validated during install. If ssl is chosen, the ActiveMQ (jms ssl) password should match the DSA REST API https password. Default: tcp
    DSCNAME DSC, BAR Command Line Unique name for the DSC server. Maximum of 22 characters: alphanumeric, "-", and ".".

    The first character of the name can be alphanumeric (a-z, A-Z, and 0-9) only.

    Important: DSCNAME must be specified for an upgrade or the repository restore from the previous version will fail. Analyze_read jobs may also fail.
    CBBFILEPATH ClientHandler The path needed for Change Block Backup temporary file storage: /var/opt/teradata/dsa/cbb
    DBSHOST DSC TDPID of the Teradata Repository used to store the DSC repository.
    DSCREPBACKUPSYSIP DSC IP address of the DBSHOST. Used for backup repository configuration.
    DBSUSERNAME DSC NewSQL Engine / Teradata Database user used for administration purposes and repository jobs. This user must have the ability to create tables under BAR and BARBACKUP databases.
    DBSPASSWORD DSC Password for DBSUSERNAME.
    SUPERUSERNAME DSC NewSQL Engine / Teradata Database user used to create the DSC repository.
    SUPERUSERPASSWORD DSC Password for SUPERUSERNAME.
    DSCUSER DSC, ClientHandler Username to set up an account for running the DSA services.
    ISMASTER ClientHandler Specify yes or no on whether this server is the Web Service master server used in incremental job communication.
    MASTERHOSTNAME ClientHandler Specify the host name of the Web Service master server used in incremental job communication.
    USERID DSC, ClientHandler The user ID of dscuser. Must be the same across all DSA client components and servers in the environment.
    VIEWPOINTURL DSC Hostname or IP address of the Viewpoint server.
    VIEWPOINTPORT DSC Port number of the Viewpoint server.
    CAMPRIMARYURL DSC Hostname or IP address of primary CAM system, which enables alert messaging
    CAMPRIMARYPORT DSC CAM port number of primary CAM system. Default: 61616.

    [DSA 16.20.51] CAM does not support SSL in this version. Port must be 61616.

    CAMCLUSTERENABLED DSC Flag for enabling CAM clustering
    CAMCLUSTERURL DSC Hostname or IP address of primary and failover CAM systems, which enable alert messaging
    CAMCLUSTERPORT DSC CAM port number for clustered environment. This has the same value as CAMPRIMARYPORT. Default: 61616.

    [DSA 16.20.51] CAM does not support SSL in this version. Port must be 61616.

    DSARESTPORT DSC Port number for DSARest Web Service running on DSC server. Default: 9090.
    DSARESTSCHEME DSC DSARest Web Service scheme, http or https. Default: https.

    [DSA 16.20.00.03 and earlier] If you use https, you must create the self-signed certificate and set up the permissions.

    1. Extract the package: SSLsetup_sles11_x8664.xx.xx.xx.xx-#######.tar.gz
    2. Run the script:

      ./enable_https.sh

    3. Restart the DSC:

      /etc/init.d/dsc restart

    KEYSTOREPASS DSC Required if DSARESTSCHEME is https.

    Password for keystore. Minimum of 6 characters.

    If JMS SSL is enabled, this password must match SSLKEYSTOREPASSWORD.

    OPPASSWORD DSC Password for the DSC repository user. Used for Create, Read, Update and Delete (CRUD) operations on BAR.
    REPPASSWORD DSC Password for the backup DSC repository user. Used for Create, Read, Update and Delete (CRUD) operations on BARBACKUP.
    SERVERID ClientHandler The server ID is the name of a DSA media server, and is a unique logical name across a single DSA domain. It is defined using SQL 92 syntax and used as the selector for JMS message headers. If the ClientHandler package is installed on a TPA node, the server ID cannot be equal to the name of that system. It is not the ID for NetBackup or other third party servers.
    When upgrading a media server for multiple DSA Network Client (ClientHandler) instances, specify the server IDs in a comma-separated list, for example, server1,server2.
    SERVERPORT ClientHandler Port number for datapath traffic, corresponds to the server.port property in clienthandler.properties. Default: 15401.
    SSLTRUSTSTOREFILE ClientHandler Full file path for truststore file.
    SSLKEYSTOREFILE ClientHandler Full file path for keystore file.
    SSLKEYSTOREPASSWORD ClientHandler The value for the JMS SSL keystore password, in clear text.

    If DSARESTSCHEME is set to https, this value must match KEYSTOREPASS.

    WSPORT ClientHandler Port number for ClientHandler Web Service traffic, corresponds to the WebService.port property in clienthandler.properties. Default: 15402.

    The following is an example of a DSC server dsainputs file:

    Important: DSCNAME must be specified for an upgrade or the repository restore from the previous version will fail. Analyze_read jobs may also fail.
    BURL=TDActiveMQ running server name
    BPORT=TDActivemq connection port number, for tcp 61616 and for ssl 61617
    CONNECTION=TDActiveMQ connection type, either tcp or ssl
    DSCNAME=unique name for the DSC server (max 22 characters: alphanumeric, "-", ".")
    SERVERPROTOCOL=tcp
    SERVERID=dsams name: uname -n 
    DBSUSERNAME=dbc
    DBSPASSWORD=dbc password in clear text
    SUPERUSERNAME=dbc
    SUPERUSERPASSWORD=dbc password in clear text
    DSARESTPORT=9090
    DSARESTSCHEME=URL type, either http or httpsKEYSTOREPASS=6 or more character password, required if DSARESTSCHEME=https. Must be the same as SSLKEYSTOREPASSWORD, if SSL is used.
    BARSIZE=size in GB of BAR database for repository
    OPPASSWORD=BAR password in clear text
    REPPASSWORD=BARBACKUP password in clear text
    DSCUSER=dscuser
    USERID=600
    VIEWPOINTURL=viewpoint server name
    VIEWPOINTPORT=80
    CAMPRIMARYURL=CAM primary server
    CAMPRIMARYPORT=61616
    CAMCLUSTERENABLED=yes
    CAMCLUSTERURL=CAM primary server, CAM failover server
    CAMCLUSTERPORT=61616
    SSLTRUSTSTOREFILE=/etc/opt/teradata/dsa/client.pem
    SSLKEYSTOREFILE=/etc/opt/teradata/dsa/client-keystore.pem
    SSLKEYSTOREPASSWORD=Client keystore passwordin clear text, used for ssl on TDActiveMQ
    ISMASTER=y
    MASTERHOSTNAME=dsadsc server where the master server is running
    CBBFILEPATH=/var/opt/teradata/dsa/cbb
    DBSHOST=tdpid of dsadsc server
    DSCREPBACKUPSYSIP=public ip for DBSHOST
    BROKERLIST=tdactivemq_server:61616

    The following code is an example of a dsainputs file for a DSA media server:

    BROKERLIST=tdactivemq_server:61616
    CONNECTION=TDActiveMQ connection type, either tcp or ssl
    SERVERPROTOCOL=tcp
    SERVERID=dsams name: uname -n 
    DSCUSER=dscuser
    USERID=600
    SSLTRUSTSTOREFILE=/etc/opt/teradata/dsa/client.pem
    SSLKEYSTOREFILE=/etc/opt/teradata/dsa/client-keystore.pem
    SSLKEYSTOREPASSWORD=Client keystore passwordin clear text, used for ssl on TDActiveMQ
    ISMASTER=n
    MASTERHOSTNAME=dsadsc server where the master server is running
    CBBFILEPATH=/var/opt/teradata/dsa/cbb