Deploying the Watson Query Remote Agent on Linux

Deploy the Watson Query Remote Agent on Linux®.

Before you begin

You must have command-line access to the remote server where the Watson Query Remote Agent is going to be deployed.

Note: If you are using the Remote Agent to virtualize files on the remote server, then OS user restrictions apply. Also, running the Remote Agent with low privileges might limit its access to certain files on the disk.

Procedure

Download and install the Java Runtime Environment from IBM® SDK, Java Technology Edition, Version 8 from Java SDK downloads, version 8.0 or the appropriate version of Oracle Java SE 8. Take a note of the installation path to complete the next steps.
Download and install the IBM Watson Query Remote Agent from IBM Watson Query Remote Agent.
Create the installation directory and specify the operating system user that is running the Remote Agent process.

Note: Ensure that the user who runs the remote agent has Read, Write, and Execute permissions on the directory.
As the operating system user, change to the newly created directory and extract the Watson Query Remote Agent archive.

Run the following configuration command and enter the value for each parameter as described in the following table.

JAVA_HOME=”<Path to Java>” JAVA_OPTS=”<Additional Java Options>” ./config.sh -i <Instance ID> -c <Configuration Hash>

For example:

JAVA_HOME=/home/<Operating system user>/ibm-java-x86_64-80/jre JAVA_OPTS="-Xmx2g" ./config.sh -i pre5efba-9f80-4678-979f-d6e776724bcd -c Tm2IdX1tf20...

Table 1. Parameters and parameter descriptions that you use to deploy the Remote Agent on Linux
Parameter	Description
Path to Java	Enter the file system path to the Java Runtime Environment directory. The default system path is taken from the JAVA_HOME environment variable.
Java Options	Enter Java Options for memory configuration or proxy support. To increase the memory configuration of the agent from 512 Mb to 2 Gb, enter `JAVA_OPTS=”-Xmx2g”`.
Instance ID	Enter the `Instance ID` from the Output values column. See Generating the configuration for the Watson Query Remote Agent.
Configuration Hash	Enter the `Configuration Hash` from the Output values column. See Generating the configuration for the Watson Query Remote Agent.

After you deploy the Remote Agent, proceed to start the agent manually for immediate use or configure it as a system service to start automatically.

To manually start the agent, see Manually starting the Remote Agent on Linux.

To automatically start the agent, see Automatically start the Remote Agent by adding a systemctl service on Linux.