Installing the Adapter

Last published : Jul 27, 2026
Use this procedure to install DataSynapse™ High-Performance Computing Cloud Adapter (HPCCA) and to restore configuration from the previous versions.
Prerequisites
  • Ensure that your system meets the platform and software requirements. For more information, see Readme.
  • DataSynapse GridServer® must be installed as described at Installing the Base Product.
  • If the DataSynapse GridServer® Manager is running, stop it before installing the adapter.
  • TIBCO DataSynapse GridServer® Engine and DataSynapse GridServer® Manager must be on the same or different Virtual Private Cloud (VPC).
  • Avoid connecting DataSynapse GridServer® Engine to DataSynapse GridServer® Manager using the public internet.
  • Test DataSynapse GridServer® setup with a manually installed DataSynapse GridServer® Engine.
  • Take a backup of the datasynapse/manager/webapps/livecluster/WEB-INF/lib directory before installing DataSynapse HPCCA. If the installation fails, you can restore the lib folder using the backup folder.
  • While installing the adapter, DataSynapse HPCCA also creates backup folder named as GsLibBackup-hpcca which contains all libs from datasynapse/manager/webapps/livecluster/WEB-INF/lib/. This folder is useful when we uninstall the adapter.
  • If you plan to install the adapter on a DataSynapse GridServer® Manager instance where SSL is enabled, then take a backup of the manager-data/certs folder. This is needed for post installation.
Procedure
  1. Extract the adapter's installation archive in the same folder that you extracted the base product's installation archive.
  2. Run the batch or bash file for your system ( install.sh or install.bat). For Windows, run the install.bat with two arguments: the path to the folder above the datasynapse folder in the base product, and true or false to preserve the cloudprovider.properties file.
    For example, if you have the DataSynapse GridServer® Manager installed at C:\TIBCO\datasynapse\manager and you want to preserve the cloudprovider.properties file, enter install.bat C:\TIBCO true.
    Note: During the installation process, the previous version of the adapter is uninstalled and the previous version's cloudprovider.properties file is stored as cloudprovider.properties.bak file if the argument is entered as true.
  3. (Applicable only if you have installed an earlier version of this adapter) restore the cloudprovider.properties.bak file:
    1. Stop the DataSynapse GridServer® Director.
    2. Copy the matching parameters from cloudprovider.properties.bak file to cloudprovider.properties file.
      Note: Ensure that the parameters that you want to copy from cloudprovider.properties.bak file exists in cloudprovider.properties file (as all parameters from the previous versions of the adapter might not exist in cloudprovider.properties file).
    3. Start the DataSynapse GridServer® Director.
  4. Update ./datasynapse/manager-data/hooks/Director/cloudprovider.properties as follows:
    1. In the first section, provide the general settings such as which service provider you are using, the platform on which engines are to be launched, and Director details to be used for the newly launched engines. See General Configuration Properties.
    2. If you are using AWS Cloud Provider, update the AWS-Specific Configuration Properties.
    3. If you are using Azure Cloud Provider, update the Azure-Specific Configuration Properties.
    4. If you are using Google Cloud Provider (GCP), update the Google Cloud Platform Specific Configuration Properties.
  5. Start the DataSynapse GridServer® Manager.
  6. Verify that the adapter creates a number of engines equal to the MINENGINES property in the cloudprovider.properties file if CONSIDER_NON_HPCCA_ENGINES property is set to false.
Post-requisites
If you plan to install the adapter on a DataSynapse GridServer® Manager instance where SSL is enabled, then take a backup of the manager-data/certs folder. Then, you must import the certificates from the original ssl.keystore and server.keystore from that directory into the new ssl.keystore and server.keystore.
To merge the backup and the new certificate, use the following command-line example:
keytool -importkeystore -srckeystore PATH_OF_DIRECTOR_BACKUP_CERT/ssl.keystore -srcstorepass changeit -destkeystore ..datasynapse/manager-data/cert/ssl.keystore -deststorepass changeit

keytool -importkeystore -srckeystore PATH_OF_DIRECTOR_BACKUP_CERT/server.keystore -srcstorepass changeit -destkeystore ..datasynapse/manager-data/cert/server.keystore -deststorepass changeit