Installing the Management Service as a standalone microservice

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

Before you begin

A Google Analytics service account is already set up and you have access to the configuration details.

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. Go to the folder to which you copied the Management Service 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. From the bin\ subfolder, open a PowerShell prompt.
  4. Type one of the following commands, but do NOT yet press Enter, as you also need to include additional parameters for Elasticsearch:
    • For Windows:
      & '.\installService.ps1' --auto-register
    • For Unix-based systems:
      .\start.sh --auto-register
  5. Add the parameters es.host and es.port with appropriate values for your implementation.

    The following table describes these and other available parameters for Elasticsearch.

    ParameterDescriptionDefault value
    es.hostHost name of the Elasticsearch instance to which you want to connectlocalhost
    es.portPort of the Elasticsearch instance 9200
    es.schemeThe protocol used
    • HTTP
    • HTTPS
    http
    es.client.max.connections.per.route Maximum connections for the route to the Elasticsearch server30
    es.client.max.connectionsMaximum number of open connections the underlying HTTP client is allowed to have100
    es.client.connection.request.timeoutNumber of milliseconds before a connection request times out 10000
    es.client.connect.timeoutNumber of milliseconds before a connect action times out 10000
    es.client.socket.timeoutNumber of milliseconds before the socket times out 30000
    es.client.max.retry.timeoutNumber of milliseconds before a retry connect times out 30000
    index.common.name.prefixStarts the service with an prefix added to the Elasticsearch index

    A prefix is needed only when running the same Elasticsearch instance for Experience Optimization and for IQ Search (a future Tridion Sites release).

    none
    The following command illustrates the Windows command with sample parameter values:
    & '.\installService.ps1' --auto-register --es.host=10.100.101.52 --es.port=9200
  6. 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.
  7. 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 /).
  8. Press Enter to execute the command.