Configuring an instance to use an external ElasticSearch server

You can configure your instance to use an external ElasticSearch server. This is required for clustering and can be used to help spead the resource usage of Deskpro across several servers.

The external server can be configured during instance creation or after the instance is setup.

During instance creation

The option to set ElasticSearch to use an external server during creation can be set by choosing the external option on the instance setup screen. You will need to validate the configuration before you can create the instance with the external service.

After instance creation

Navigate to the ElasticSearch page on the instance 'Services' page

Click 'Edit Parameters' on the connection card

In the URL box you can provide a URL or IP address of the external ElasticSearch server

Before you can apply the changes you need to validate the parameters as valid, this is to check the server is reachable and that the ElasticSearch service is running

Clicking 'Save Changes' will apply the configuration, a re-index may be required after the server is changed.

Setting an external server on the CLI

You can run the following command to set your helpdesk instance to use an external ElasticSearch server:

opc inst -i <instance_name> config set --es-host http://<server_address>:9200
 copy

Disabling the local ElasticSaerch service

If you are not using the local ElasticSearch service, the main configuration page will have a banner advising that it is possible to disable the local service.

Click the 'service active' toggle to off and click save to disable the service

The banner will then change to a message advising that Elasticsearch is not running and can be re-activated with the toggle.