Installing the IQ Combined Index and Query Services microservice

Run the appropriate microservice installation PowerShell or Unix script to install and run the standalone microservice.

Before you begin

You must have configured the connection to your Elasticsearch instance in the installation or startup script, or you must configure the connection directly on the command line (not recommended).

About this task

You may want to add one or more parameters (without values, acting as Booleans) or parameter-value pairs to your installation script. To do so, edit the installation script to append them to your command in the form --PARAMETER or --PARAMETER=VALUE, where PARAMETER is the name of the parameter, and VALUE (when using) is the value you want to set it to. Alternatively, instead of editing the script, you can also enter them by hand on the command line.

You can install the microservice in one of the following ways:
As a Windows service
Choose this option for long-term use, say on a production system. The microservice continues to run when you close the PowerShell prompt, it can be stopped and restarted from the Windows Control Panel, and it outputs its log as a file. The installation script to use is installService.ps1.
As a standalone Windows process
Choose this option for short-term use, say on a test system. The microservice stops running when you close the PowerShell prompt and it outputs its log in the command prompt window. The installation script to use is start.ps1.
As a standalone Unix process
Choose this option if you are installing on a Unix-based operating system. The installation script to use is start.sh.

Procedure

  1. Navigate to the folder to which you copied the IQ Combined Index and Query Services standalone microservice files.
  2. If your Discovery Service is running on another server, on another port, or if you have changed the name or password of the user who registers Capabilities in the Discovery Service, go to the config\ subfolder, open cd_storage_conf.xml for editing, and change the attributes of the ConfigRepository element to reflect your customizations.
  3. If you are installing this microservice on a machine on which the Discovery Service is also running (that is, if you are not in a scaled-out setup), open your installation script and ensure that the following line is present:
    $arguments += "++DependsOn=TridionDiscoveryService"
  4. On a Unix-based system, to run the microservice as a standalone process, type /bin/sh start.sh but do not yet press Enter.
  5. Alternatively, on a Windows system, open a PowerShell prompt and do one of the following:
    • To install as a Windows service, type & '.\installService.ps1' but do not yet press Enter.
    • To install as a standalone Windows process, type & '.\start.ps1' but do not yet press Enter.
  6. Add -Dfile.encoding=UTF-8 to the command line to ensure UTF-8 encoding of content.
  7. If this is the very first time you are installing this microservice on any computer, add a parameter called es.bootstrap.enable and set it to true. This applies the default bootstrap configuration, found in the file bootstrap.json in the configuration location, to Elasticsearch. If you want to apply a different bootstrap configuration file, also add a parameter called es.bootstrap.file and set it to the name of your custom bootstrap configuration file, which must be located in the configuration location.
  8. If you want the service to register itself as a Capability with the Discovery Service automatically, add an auto-register parameter.
  9. To specify a different default HTTP port than the default, add a server.port parameter and set it to the port number of your choice.
  10. To specify a default context path, add a server.contextPath parameter and set it to the context path of your choice (the value must start with a /).
  11. Press Enter.