About Microservices

This applies to: Visual Data Discovery

You can manage microservices in CentOS environments or in Ubuntu 18, 20, or 22 environments. You can also manage the microservices using the Symphony CLI.

See the following sections:

• Enable Microservices

• Start Microservices

• Restart Microservices

• Stop Microservices

• Disable Microservices

• Microservice Startup Order

Enable Microservices

You can also enable microservices using the CLI. See Manage Symphony Microservices Using the Command Line Utility.

To enable all Symphony microservices, enter the following command:

sudo systemctl enable $(systemctl list-unit-files | grep zoomdata | grep edc | awk '{print $1}')

To enable a specific Symphony microservice, enter the following command:

sudo systemctl enable <service>

Replace <service> with the name of the Symphony microservice. See Symphony Data Discovery Microservice Name Reference.

Start Microservices

The list of microservices can be found in Symphony Data Discovery Microservice Name Reference. The order in which microservices should be started is described in Microservice Startup Order.

You can also start microservices using the CLI. See Manage Symphony Microservices Using the Command Line Utility.

To start all Symphony microservices, enter the following command:

sudo systemctl start $(systemctl list-unit-files | grep zoomdata | grep edc | awk '{print $1}')

To start a specific Symphony microservice, enter the following command:

sudo systemctl start <service>

Replace <service> with the name of the Symphony microservice. See Symphony Data Discovery Microservice Name Reference.

Restart Microservices

You can also restart microservices using the CLI. See Manage Symphony Microservices Using the Command Line Utility.

To restart all Symphony microservices, enter the following command:

sudo systemctl restart $(systemctl list-unit-files | grep zoomdata | grep edc | awk '{print $1}')

To restart a specific Symphony microservice, enter the following command:

sudo systemctl restart <service>

Replace <service> with the name of the Symphony microservice. See Symphony Data Discovery Microservice Name Reference.

Stop Microservices

You can also stop microservices using the CLI. See Manage Symphony Microservices Using the Command Line Utility.

To stop all Symphony microservices, enter the following command:

sudo systemctl stop $(systemctl list-unit-files | grep zoomdata | awk '{print $1}')

To stop a specific Symphony microservice, enter the following command:

sudo systemctl stop <service>

Replace <service> with the name of the Symphony microservice. See Symphony Data Discovery Microservice Name Reference.

Disable Microservices

You can also disable microservices using the CLI. See Manage Symphony Microservices Using the Command Line Utility.

To disable all Symphony microservices, enter the following command:

sudo systemctl disable $(systemctl list-unit-files | grep zoomdata | awk '{print $1}')

To disable a specific Symphony microservice, enter the following command:

sudo systemctl disable <service>

Replace <service> with the name of the Symphony microservice. See Symphony Data Discovery Microservice Name Reference.

Microservice Startup Order

The only microservices that must be started first are the Postgres and Service Discovery microservices. The other microservices are more tolerant and can be started in any order.

Symphony recommends starting microservices in the following order. You can start microservices using CentOS or Ubuntu commands or using the CLI. See Start Microservices and Manage Symphony Microservices Using the Command Line Utility. A full list of Symphony microservices can be found in Symphony Data Discovery Microservice Name Reference.

1. The Postgres microservice (postgresql-<version>) used for metadata storage (where <version> is the version of Postgres you have installed.

2. The Service Discovery microservice (zoomdata-consul) used for microservice discovery.

3. The connector microservices (in the format zoomdata-edc-<connector_name>) used to connect to different data stores. The following CentOS example starts all available connector microservices, rather than starting them individually:

   sudo systemctl start $(systemctl list-unit-files | grep zoomdata-edc | awk ‘{print $1}‘)

4. The query engine microservice (zoomdata-query-engine) used for query engine processing.

5. The zoomdata-data-writer-postgresql microservice.

6. The following optional microservices, if they are installed.

   • zoomdata-admin-server
   • zoomdata-screenshot-service

7. The main Symphony microservice (zoomdata).