Creating a response file for a non-load balancer upgrade (console mode)

Before you begin:
Note: The installer does not support changing a non-load balancer deployment to a load balancer deployment during an upgrade, or vice versa. To make such a change, you would need to uninstall the server and then reinstall it. See Uninstalling Hybrid Data Pipeline server and Installing the Hybrid Data Pipeline server for details.

After copying the product installation file to a temporary directory, take the following steps to generate a response file for a non-load balancer upgrade using the console installer. Note that an installation or upgrade of the server occurs when using the installer to generate a response file.

  1. From a command-line prompt, navigate to the directory where you saved the product file. Alternatively, place the product file directory on your path before proceeding to the next step.

    The product file has the format PROGRESS_DATADIRECT_HDP_SERVER_nn_LINUX_64_INSTALL.bin, where nn is the version of the product.

  2. Make the file an executable using the chmod command. Then, press ENTER. For example:

    chmod +x ./PROGRESS_DATADIRECT_HDP_SERVER_nn_LINUX_64_INSTALL.bin

  3. At a command-line prompt, type the following command where response_file is the path and file name of the response file you want to create. You must specify an absolute path.

    PROGRESS_DATADIRECT_HDP_SERVER_nn_LINUX_64_INSTALL.bin -i console -r response_file 

    The following example creates a response file named pipeline.response in the /home/users/johndoe directory.

    PROGRESS_DATADIRECT_HDP_SERVER_nn_LINUX_64_INSTALL.bin -i console -r /home/users/johndoe/pipeline.response

  4. You are prompted for the installation directory. Type the absolute path to the installation directory of the installation you want to upgrade. Then, press ENTER.
  5. Choose the JVM you want to use for the runtime operation of the server.
    Note: See Product requirements for details on JVM prerequisites.
    • Type 1 to use the JVM that was used to run the installer.
    • Type 2 to enter your preferred JVM. Then enter the full path to the Java executable.
  6. Choose whether you want to upgrade with an evaluation or licensed version of the product. Licensed installations require a valid License Key.
    • Evaluation. Type 1 to upgrade with an evaluation version of the product that is fully functional for 30 days. Then, press ENTER.
    • Licensed. Type 2 if you purchased a licensed version of the product. Then, press ENTER. Type the license key, including any dashes, and then press ENTER.
  7. Accept or enter the fully qualified hostname of the machine that will host the Hybrid Data Pipeline server. By default, the installer suggests the name of the current machine. Then, press ENTER.

    Note the following important information. Then, press ENTER to continue.

    • If you enter a hostname different than the hostname of the current machine, the installer will fail to validate the hostname. You are then prompted to reenter the hostname or skip validation. If you are planning on using the response file to install the product on a different machine, you should opt to skip validation.
    • Before using the response file to install the product on another machine, the response file must have the SKIP_HOSTNAME_VALIDATION and SKIP_PORT_VALIDATION validation properties set to 1. For example:
      SKIP_HOSTNAME_VALIDATION=true
SKIP_PORT_VALIDATION=true
    • Running an installation in silent mode with a response file containing these settings allows the silent installation to continue even if hostname or port validation fail. When the validation fails during the silent installation process, the installer generates the file SilentInstallInfo.log in the user's home directory but completes a full installation.
    Note: For non-load balancer deployments where the server is receiving queries directly, the hostname should be tied to the DNS for public access. This allows you to update IP addresses in the DNS without having to run an upgrade installation to reconfigure your deployment.
  8. Select how you want to continue the upgrade.
    • Type 1 for an Express upgrade to persist previously established values. Then, press ENTER and continue at Step 25.
    • Type 2 to change values for the following configurations. Then, press ENTER to continue.
      • Change the location of the SSL certificate file
      • Enable or disable FIPS
      • Add MySQL Community Edition as a data store or external system database
      • Change the system database you are using
      • Update external system database credentials
      • Change Server Access Ports
      • Change On-Premises Connector Ports
      • Change Server Internal Access Ports
    Note: The key location where the generated key and internal files are stored cannot be modified when performing an upgrade.
  9. Specify whether you want to enable FIPS on the Hybrid Data Pipeline server.
    Important: To enable FIPS, your hardware must support secure random, or you must have a secure random daemon installed.
    Important: When you enable FIPS during an upgrade, the environment uses the encryption key for the system database that was generated during the original installation of the server. This encryption key, while generated with a FIPS compliant algorithm, was not generated with a FIPS certified implementation of the algorithm.
    • Type 1 if you want to enable FIPS. Press ENTER and continue to the next step.
    • Type 2 and press ENTER if you want to use the default setting which is FIPS disabled.
  10. Depending on your environment, provide the appropriate SSL certificate information.
    • Type 1 to specify a PEM file to be used by the server to establish SSL connections with ODBC and JDBC client applications. Press ENTER. Type the full path to the PEM file. Press ENTER again, and proceed to the next step.
      Note: The PEM file must consist of a private key, a public key certificate issued by a certificate authority (CA), and additional certificates that make up the trust chain. See The PEM file for more information.
    • Type 2 to use the SSL certificate specified in the previous installation or the self-signed certificate included with the previous installation. Then, press ENTER, and proceed to the next step.
      Note: The self-signed certificate may be used in a test environment. However, for production, a PEM file with required information should be specified. See The PEM file for more information.
  11. Choose the appropriate option depending on whether you are using MySQL Community Edition. MySQL Community Edition can be used as an external system database or as a data source. Hybrid Data Pipeline does not provide a driver for MySQL Community Edition. However, you can use the MySQL Connector/J driver to use MySQL Community Edition as an external system database or as a data source.
    • Type 1 and press ENTER, if you are using MySQL Community Edition. Type the name and location of the MySQL Connector/J jar file, and press ENTER again.
    • Type 2 and press ENTER, if you are not using MySQL Community Edition in your environment.
    Note: For more information on the MySQL Connector/J driver, visit the MySQL developer website at https://dev.mysql.com/.
  12. Choose the appropriate option depending on whether you are using Kerberos for SQL Server authentication.
    • Type 1 and press ENTER, if you are authenticating using Kerberos. Type the path to the configuration file krb5.conf, and press ENTER again.
    • Type 2 and press ENTER, if you are not using Kerberos authentication in your environment.
  13. Select the type of database you want to use to store system information.
    • Type 1 to use the default internal database supplied by this installation. Continue at Step 15.
    • Type 2 to store information on an external database. Proceed to the next step.
    Note: Users and data sources created in the internal database are specific to the internal database. They are not migrated to the external database if you subsequently modify the Hybrid Data Pipeline Server to use an external database.
  14. Select the type of external system database you want to use to store system information.
    • Select Oracle, and continue at Step 16.
    • Select MySQLCommunity, and continue at Step 17.
    • Select MSSQLServer, and continue at Step 18.
    • Select PostgreSQL, and continue at Step 19.
  15. Enter the database port for the internal database. If your environment has already defined a function for the default port, the installer pops up a message so that you can specify a different port. Press ENTER, and continue at Step 21.
  16. Provide the Oracle connection information.
    1. Type the name of the host.
    2. Type the port number.
    3. Select the connection type. Do one of the following:
      • If you connect using the Oracle System Identifier (SID), type 1, then type the SID.
      • If you connect using the Service Name, type 2,then type the database service name that specifies the database that is used for the connection. The service name is a string that is the global database name—a name that typically comprises the database name and domain name.
    4. Optionally, when prompted for Advanced Options, specify additional connection parameters and their values to be included the connection url. Values should be entered as a semicolon-separated list of parameter=value. For example, you may enter to following options to configure SSL: 
      encryptionLevel=Required;encryptionTypes=(AES256);
dataIntegrityLevel=Required;dataIntegrityTypes=(SHA1);
encryptionMethod=SSL;keyStore=/common/Oracle/trustStore.jks;
keyStorePassword=secret; serverType=dedicated;authenticationMethod=ntlm;
hostNameInCertificate=oracle;editionName=hybrid
    5. Press ENTER, continue at Step 20.
  17. Provide connection information for the MySQL Community Edition external database.
    1. Type the name of the Hostname.
    2. Type the port number.
    3. Type the database name.
    4. Optionally, when prompted for Advanced Options, specify additional connection parameters and their values to be included the connection url. Values should be entered as an ampersand-separated list of parameter=value.
    5. Press ENTER, continue at Step 20.
  18. Provide the SQL Server connection information.
    1. Type the name of the host.
    2. Type the port number.
    3. Type the database name.
    4. Type the name of the schema.
    5. Optionally, in the Advanced Options field, specify additional connection parameters and their values to be included in the connection URL. Values should be entered as a semicolon-separated list of parameter=value.
    6. Optionally, in the Advanced Options field, specify the path to the krb5.conf file to use Kerberos authentication method.
    7. Press ENTER, continue at Step 20.
  19. Provide the PostgreSQL connection information.
    1. Type the name of the host.
    2. Type the port number.
    3. Type the database name.
    4. Optionally, in the Advanced Options field, specify additional connection parameters and their values to be included in the connection URL. Values should be entered as a semicolon-separated list of parameter=value.
    5. Press ENTER, continue at Step 20.
  20. You are prompted to provide the database credential information for a user with administrator privileges and for a user without administrator privileges.
    Attention: For an installation using environment variables, do not enter credential information and simply press ENTER at each prompt. Then, when prompted, skip database validation. Database validation is not required for a successful installation.
    • Type the administrator user name. The administrator user must have certain privileges that are specific to the database vendor. For a list of required privileges, see External system databases.
    • You are prompted to provide the Admin Password. Type the password for an external database administrator account.
    • You are prompted to provide the username for a user who does not have administrator privileges. Type a user name. For a list of required privileges, see External system databases.
    • You are prompted to provide the User Password. Type the user password.
    • The installer validates the connection. Press ENTER to continue.
    Important:
    • Administrator credentials are required at install time to add and modify required tables in the database schema. Administrator credentials are not used by the product at run time.
    • Passwords for an external database implementation are not persisted. These values must be specified in the response file with the D2C_DB_ADMIN_PASSWORD and D2C_DB_USER_PASSWORD options before running a silent install.
    • The installer attempts to validate the database. If the installer is unable to validate, you are prompted to reenter credentials or skip validation. If you skip validation, the response file must have the SKIP_DATABASE_VALIDATION property set to true. During a silent installation, the installer will complete the installation even when the database validation fails.
  21. Review the Server Access Ports. A Server Access Port must be available to the end user across the firewall. Best security practices recommend using an HTTPS port.
    Table 1. Server Access Ports
    Name Default Description
    Server Access HTTP Port 8080 HTTP port used for communication to the Hybrid Data Pipeline Web UI and API.
    Server Access HTTPS Port 8443 HTTPS port used for encrypted communication to the Hybrid Data Pipeline Web UI and API.
  22. Select whether you will continue to use the On-Premises Connector.
    • If using the On-Premises Connector, type 1 and press ENTER. Then continue to the next step.
    • If not using the On-Premises Connector, type 2 and press ENTER. Continue at Step 24.
  23. Review the On-Premises Access Ports. The On-Premises Access Port and a Notification Server Port must be available across the firewall. Best security practices recommend using the SSL Notification Server Port.
    Important: If you change any values for On-Premises Access Ports during an upgrade, you will need to reinstall the On-Premises Connector with the updated distribution files in the redist subdirectory. See "What to do next" in Performing a silent upgrade.
    Table 2. On-Premises Access Ports
    Name Default Description
    On-Premises Port 40501 Port for communication between the On-Premises Connector and the Hybrid Data Pipeline server.
    Notification Server TCP Port 11280 TCP port for communication from the On-Premises Connector to the Notification Server.
    Notification Server TCP SSL Port 11443 TCP SSL port for encrypted communication from the On-Premises Connector to the Notification Server.
    Message Queue Port 8282 Port for communication between the Notification Server and the Hybrid Data Pipeline server. Required for Linux installation of Hybrid Data Pipeline. Not used in Docker deployments.
  24. Review the Server Internal Ports. A port for the internal API and the Shutdown Port must be opened. Best security practices recommend using the Internal API HTTPS Port.
    Important: As a matter of best practice, the Shutdown Port should not be available outside the firewall of the Hybrid Data Pipeline instance.
    Table 3. Server Internal Ports
    Name Default Description
    Internal API HTTP Port 8190 HTTP port for communication between individual nodes in a cluster deployment.
    Internal API HTTPS Port 8090 HTTPS port for encrypted communication between individual nodes in a cluster deployment.
    Shutdown Port 8005 TCP port that listens for shutdown requests.
  25. Review the summary. If you are satisfied with your choices, press ENTER to generate the response file.
  26. After the response file has been generated, press ENTER to exit the installer.
  27. Confirm that a response file has been generated by navigating to the response file directory you specified in Step 3 and opening the response file.
  28. Proceed to Editing a console generated upgrade response file.