Skip to content

Services

Services is a standard configuration interface for adding, editing, and removing services. A service is an application that runs continuously. It is customizable by choosing which program to run, any arguments, and if applicable, the configuration that the service uses to gather additional options and features. The services section also can be used to create primary and backup services and determine the failover state.

Refer to the Standard Configuration Interface guide for details on interacting with the grid and form. The additional controls are explained in the Grid Details section.

This user interface calls REST methods from api/broker/services.

The UI path for this interface is Configuration -> Broker Control -> Services.

Grid Details

This interface contains the following additional options in the Button Bar:

  • Start/Stop/Restart - After an existing service has been selected, click Start/Stop/Restart to immediately interact with the service.

  • Reload Config - After a running Assure1 service has been selected, click Reload Config to initiate a reread of its configuration and rules files. Refer to the Service Reload Config section for more info.

  • Help - After an existing service has been selected, click Help to show the help text for the application to be used.

In the main grid, click the - icon next to a server name to collapse that server's services and hide those entries. Click the + icon next to a server name to expand the services and show those entries.

Form Fields

  • Server - The Assure1 server that will execute the application.

  • Package - The package for the application. The documentation for each application provides the correct package to be selected.

  • Name - The name of the service.

  • Program The application that will be executed. Path to the application is relative to the Assure1 install directory.

  • Arguments - These are any command line options to be passed when executing the application. Each application documentation page lists the correct arguments that can be used, if any are available.

  • Description - The description of what the service does.

  • Failover Type - The failover type for the service.

  • Primary Service - If Failover Type is set to Redundant/Backup, the service set here will be checked to see if it is running, and if not, the backup will be started.

  • Decouple - If Failover Type is set to Redundant/Backup, this checkbox will be displayed. A normal primary/backup service pairing is a primary service on the primary server and a backup service on the backup server. This checkbox allows for different combinations of primary/backup service pairings, e.g. a primary service on the backup server and a backup service on the primary server, or pairing services across servers that are not tied together.

  • Cluster ID - If Failover Type is set to Cluster, this will be the ID used to identify individual clusters of applications.

  • Status - The status of the service.

  • Privileged - Whether or not to run the service as the "root" user account. Many Assure1 applications will need this to be checked to ensure proper functionality.

  • Configuration - This section contains the additional settings that are needed for most applications to function, including rules files, number of threads, etc. Not every service will require or support a configuration. Each application documentation page lists the correct configuration options that are supported, if any.

Best Practice

  • When setting up redundant services, the failover type for the service on the primary server is set to Primary and the service on the redundant server is set to Redundant/Backup. If the service is part of a cluster, in which multiple services are grouped together to execute, then the failover type must be Cluster. If the service is a standalone service, leave as Standalone.