CLI node installation

In this page, learn how to install an Axway Decision Insight (DI) node on Linux or Windows.

This page describes the preferred way of installing DI; which is by using the Command Line Interface (CLI) installation method. 


Installation prerequisites

To install your DI node, make sure that you have checked the Prerequisites first. 

To install your node make sure you have a   valid license file provided by Axway and  a valid installer matching to the product version you want to install. 

Installers can be downloaded from Axway Support Portal or from  Decision Insight supported downloads and releases :

  • For Windows, pick the zipped product installer that looks like DecisionInsight_2.0.0_Product_win-x86-64_BNXXXXXXXXXX.zip.
  • For Linux, pick an installer that looks like  DecisionInsight_2.0.0_Product_linux-x86-64_BNXXXXXXXXXX.tar.gz.

About CLI installation

The CLI installation mode is the recommended way to install a DI node. This installation method enables you to install your node in one command line and benefit from complete control and customization over the settings of your node. 

This method relies on a script called node-deploy that you can run from a CLI tool to install DI. 

About node-deploy

The node-deploy script is located in the bin folder of your unzipped installer. Depending on your OS, it is named:

  • node-deploy.bat on Windows
  • node-deploy.sh on Linux  – Make sure you have execute permission granted on the script.

As both Windows and Linux node-deploy scripts accept the same parameters their file extension is omitted in the command examples of this page.

This script is used to install a DI node in the specified directory. It comes with a list of options:

node-deploy --installDir <installationDirectory> [OPTIONS]
 
Options:
--installDir    Path    Path where the node will be installed. The path must not be empty.
--apply         Path    Path to a configuration file to apply. Can be used multiple times.
--linkProduct           Advanced. Link the product from its initial path. The product will not be copied in the node directory.
--noPrompt              Advanced. Disable prompt mode. 

To see this list of options from the CLI, type:

./{UnzippedInstallerPath}/bin/node-deploy --help

Choose your CLI installation method

The below describes the different ways you can install DI in a CLI mode.

#1 Install a DI node, configure it later 

Requirements:

A valid ZIP or TAR.GZ installer depending on your OS

Description:

Once you have installed DI, you may either manually change your node settings or run a script and use a configuration file

Instructions: Click here.

#2 Install a DI node and apply configuration settings directly

Requirements:

  • A valid ZIP or TAR.GZ installer depending on your OS
  • A configuration file for your node

Description:

Install a DI node complete with all desired node settings, in one command line. (You will still have to follow prompts on screen to install your node).

Instructions: Click here.

#3 Advanced options 

Requirements:

A valid ZIP or TAR.GZ installer depending on your OS

Description:

  • Disable prompt mode. You will have to generate the admin hash and encryption key yourself later (or specify it using a configuration file) as well as configure your node.
  • Install a DI node without copying the product to the node directory

Instructions: Click here.

#1 Install a DI node, configure it later

Install DI in the directory of your choice

Step Action
1 Extract all the contents of your DI installer to the directory of your choice.
2 Using the CLI tool of your choice, navigate to the the location where you extracted the installer.
3

Launch the node-deploy script located in the bin folder of your extracted installer. 

./{UnzippedInstaller}/bin/node-deploy --installDir Path

For example, the following command installs a DI node in folder node1 of the S drive: 

node-deploy --installDir S:/node1
  Node installation path considerations

The node directory path must fulfill these prerequisites:

  • <Decision Insight administration account> must have full access.
  • <Decision Insight execution account> must have read & execute permissions.
4 You are prompted to create the admin password for your node.  Type your password then press Enter
5

Type your password one more time to confirm it.  Press Enter

Your password is created and stored in installDir>var>data>default.hash.

6

You are prompted to provide the location of the encryption.salt file you want to use to secure your DI node database, just press  Enter and a random salt is generated automatically in your var folder .

7

You are prompted to provide the location of the key file you want to use to secure your DI node database, just press  Enter and a random key is generated automatically in the conf folder of your node that's being installed.

8 You are prompted to create a password for the encryption file. Type your password then press Enter
9

Type your password one more time to confirm it.  Press Enter

Your password is created and stored in installDir>conf>encryption.key.

10 Your DI node installation is done. You can now configure the node to your preferred settings. Don't forget to install your license .

Configure your node

The following lists the minimum settings you must specify in order to be able to work with your node. 

Setting Description Location
Duser.timezone

Time zone offset for your node.
Specify using either an ID or the GMT format.

  • For a list of time zone IDs, see List_of_tz_database_time_zones (wikipedia). For instance, the time zone ID for the U.S. Pacific Time zone is "America/Los_Angeles". 
  • The GMT must follow this pattern GMT[+-]00:00. For instance, GMT+01:10 means one hour ten minutes ahead of GMT. This is not the recommended way to specify a time zone with DST.

installDir> conf > jvm.conf file
org.osgi.service.http.port

Port of the application, for example 8080 & context root of the application for example, myApp

Here are some examples of node URLs given an HTTP port and a Web context root.

HTTP port Web context root URL to access the node
8080 / http://localhost:8080/
8080 /adi http://localhost:8080/adi/
80 /adi http://localhost/adi/

installDir > conf > platform.properties file
com.systar.boson.http.contextRoot installDir > conf > platform.properties file

For more information about all the different node settings, seNode settings.  

You can also configure your node in one command line using a configuration file. For more information, see Configure a node.

#2 Install a DI node and apply configuration settings directly

This method is particularly useful provided you already have a configuration file that can be used to install your node. You can generate a diff configuration file from the settings of an existing node and then use that file to install a node with the exact same settings. This can be useful, for instance, if you are planning to install a primary/replica cluster. You could have a configuration file for your primary node and one configuration file set to install all your replica nodes. 

For information about how to generate a configuration file, see Configure a node.

Step Action
1 Extract all the contents of your DI installer to the directory of your choice.
2 Using the CLI tool of your choice, for example Windows Power Shell, navigate to the the location where you extracted the installer.
3

Launch the node-deploy script located in the bin folder of your extracted installer. 

./{UnzippedInstaller}/bin/node-deploy --installDir Path --apply Path

For example, the following command installs a DI node in folder node1 of the S drive and applies a configuration file located under S:/myconf

\node-deploy --installDir S:/node1 --apply S:/myconf/diff.varfile
  Node installation path considerations

If you install the node in the default installation path – C:\Program Files\DecisionInsight  – the node will not work out of the box as this directory is not writable by default.

If you install the node in a sub-directory of  C:\Program Files, once the installation is complete, you must change the location of the working directory or change the permissions on the installation directory.

Select an installation path that fulfills these prerequisites:

  • <Decision Insight administration account> must have full access.
  • <Decision Insight execution account> must have read & execute permissions.
4

If the configuration file already contained the admin password values, the node automatically applies this setting. Otherwise, You are prompted to create the admin password for your node, then to confirm it.  

Your password is created and stored in installDir>var>data>default.hash.

5

If the configuration file already contained the encryption key &salt location and values, the node automatically applies this setting. Otherwise, You are prompted to specify the location of an existing file. You can also just press Enter to create a random salt automatically. 

6 You are prompted to create a password for the encryption file.  Type your password then press Enter
7

Type your password one more time to confirm it.  Press Enter

Your password is created and stored in installDir>conf>encryption.key .

8

Your DI node is now installed and configured.  Don't forget to install your license if you had not already specified it in the configuration file used to install the node. 

#3 Advanced options

Install a DI node in NoPrompt mode

This method is intended for users who do not want to have to type anything into the console while installing DI from the CLI. 

Using the node.deploy script, in your unzipped DI installer, specify the path to the folder where you want to install your node and use the --noPrompt option:

\node-deploy --installDir Path --noPrompt


Once the installation is complete, you will not be able to launch DI straight away. Instead, you'll have to specify all the properties you would normally enter while performing a standard installation, that is:

  • the admin password – Launch the tnd-generate-admin-hash.bat script in your node's bin folder. 
  • the encryption key – Launch the tnd-generate-encryption-key.bat script in your node's bin folder. 
  • Time zone and network settings – You can use a configuration file or fill these in manually. See Configure your node.

Install a DI node without copying the product to the node directory

Use the linkProduct option:

\node-deploy --installDir Path --linkProduct

Install the license

A valid license is required to start the node. The license is a file having a .jar or .licence extension.

You should copy this file in the <install dir>/lib/licences directory.

Change the working directory (optional)

To specify the directory where the node can perform read/write operations and where your data will be stored, you can change the <working directory>.

To specify the <working directory> , perform the following steps:

  1. Copy the contents of <node directory>/var to <working directory>.
  2. Edit the following file:
<installation directory>/conf/path.conf
WORKING_DIR=<working directory>

Change the logging directory (optional)

To specify the directory where the node will write the logging files, you can change the <logging directory>.

To specify the <logging directory>, perform the following steps:

  1. Copy the content of <working directory>/log to <logging directory>
  2. Edit the following files:

    <installation directory>/conf/platform.properties
    com.systar.platform.log.dir=<logging directory>

Install as a service (optional)

  Click to expand Windows procedure

Multi instance configuration

If you want more than one instance of Decision Insight installed as a service, edit the com.systar.platform.name= property in <installation dir>/conf/platform.properties.

This value will be used as the service name. (Default name is DecisionInsight)

To install the service:

  1. Once the node is installed and configured, execute the provided configuration script located in <installation directory>/bin using the specific user <Decision Insight administration account>

    <installation directory>\bin\tnd-service-configure.bat
    This command generates a  DecisionInsight.ini file used to launch the node as a service.Do not manually modify this file. If configuration files ( jvm.confpath.conf, platform.properties) are modified after installation as service, re-execute this script. No specific user is needed to do this operation.
  2. Execute the provided installation script located in <installation directory>/bin using the specific user <System administration account>

    <installation directory>\bin\tnd-service-register

This installs the service as an operating system service named <product-name> and sets it for manual start. This command checks no other service is already registered under the same name before proceeding.


Once the service is installed, change the service user from the Windows services management GUI (default user is local system):

  1. From the Start menu, in the Find programs search bar, type Services.  
  2. In the list of available services, locate DecisionInsight.

  3. Right-click the service and select Properties
  4. In the service properties window, under the Connexion tab, set the user account <Decision Insight execution account>  (./DecisionInsight in the example below) to start the node from a service.

  5. Apply your changes and close the services management window. 
  Click to expand Linux procedure

Multi platform configuration

If you want more than one instance of Decision Insight installed as a service, edit the property com.systar.platform.name= in <installation dir>/conf/platform.properties.

This value will be used as the service name. (Default name is DecisionInsight)


Execute the provided install script located in <installation directory>/bin/tnd-service-register.sh using the <System administration account> user.

> ./<installation directory>/bin/tnd-service-register.sh
setting service auto run levels using update-rc.d
 Adding system startup for /etc/init.d/DecisionInsight ...
   /etc/rc0.d/K01DecisionInsight -> ../init.d/DecisionInsight
   /etc/rc1.d/K01DecisionInsight -> ../init.d/DecisionInsight
   /etc/rc6.d/K01DecisionInsight -> ../init.d/DecisionInsight
   /etc/rc2.d/S99DecisionInsight -> ../init.d/DecisionInsight
   /etc/rc3.d/S99DecisionInsight -> ../init.d/DecisionInsight
   /etc/rc4.d/S99DecisionInsight -> ../init.d/DecisionInsight
   /etc/rc5.d/S99DecisionInsight -> ../init.d/DecisionInsight

This installs the service script in /etc/init. d/ <node name> and sets its run levels to allow auto-start. This command checks that no other service is already registered under the same name before proceeding.

By default, the node runs with root privileges.

On SUSE 12, you might need to enable the service before the first start.

Enable Decision Insight service
> systemctl enable DecisionInsight.service

Change service user account

If you want to change the user that manages the node, modify the startup script /etc/init.d/<node name> and replace the line:

USER=root


to:

USER=<Decision Insight execution account>

Secure your installation (optional)

To restrict what files the node can access or modify, you can apply the following rights:

Directory

<Decision Insight administration account> rights

<Decision Insight execution account> rights

<installation directory>/bin/

read / write / execute

read / execute

<installation directory>/conf/

read / write / execute

read / execute

<installation directory>/lib/

read / write / execute

read / execute

<installation directory>/product/

read / write / execute

read / execute

<working directory>

read / write / execute

read / write / execute

<logging directory> read / write / execute read / write / execute

Related Links