refinery-service-class(8) -- service class start and stop commands¶

Synopsis¶

refinery service-class [option]

Description¶

Provides the ability to start and stop service classes

Options¶

--start¶

Starts a service class. This option supports the additional [SERVICE CLASS START OPTIONS] described below. Apart from the additional options, all other command line arguments passed to the command will be forwarded to the service class when it is started.

--start-template template-name¶

Starts a service class based on some pre-defined templates for Refinery. These are only supported in Refinery 5.0 onwards. The provided templates are:

refinery-process-manager: Refinery Process Manager
refinery-gw-client: Refinery Gateway Client - query process for Dashboard functionality

This option supports the additional [SERVICE CLASS START OPTIONS] and [SERVICE CLASS TEMPLATE START OPTIONS] described below.

Apart from the additional options, all other command line arguments passed to the command will be forwarded to the service class when it is started. See [SERVICE CLASS TEMPLATE SPECIFIC START OPTIONS] for additional arguments that the templates expect.

--stop sc-name¶

Stops the specified service class. This defers to process --stop.

--list¶

Lists all the currently running service classes within the system. This option supports the additional [SERVICE CLASS FILTERING OPTION] described below.

--list-templates¶

Lists all the available templates in the current CLI installation.

Service class start options¶

--type type¶

The type of service class to start (e.g. refinery_process)

--name name¶

The unique name of the service class to start.

NOTE: If the specified name is already assigned to a service class, the start will fail.

--host host¶

--port port¶

--wait wait-seconds¶

If specified, wait for the specified number of seconds for the service class to start successfully before the CLI exits.

--taskset taskset¶

The CPU assigment for the service class (in taskset format).

--interactive¶

If specified, start the service class interactively in the current terminal. This option CANNOT be used with --host set to any server other than the current server or with --instances set to greater than 1.

Service class template start options¶

--instances instances¶

The number of instances of the specified template to start.

Note with this parameter, --host and --taskset will be applied to all instances started and --port cannot be used.

Service class filtering option¶

--filter type:filter¶

If specified, the list of service classes printed will be filtered by either name or service type. The format of the filter is *filter-type*:*filter-value* and the value can either be a specific value or a basic regular expression.

Note that the regular expression supported is limited as documented at https://code.kx.com/q/basics/regex/.

Service class template specific start options¶

--start-template refinery-process-manager¶

This template has no additional arguments that can be specified

--start-template refinery-gw-client¶

This template has additional OPTIONAL arguments related to Gateway selection priority. Both arguments specified together work as an AND condition. This can be used to create multiple refinery-gw-client instances.

--instance-priority instance-num¶

If specified, the GW client process will only connect to Gateways in the specified instance by default

--pipeline-priority pipeline-name¶

If specified, the GW client process will only connect to Gateways in the specified pipeline by default

Copyright¶

Version¶

RELEASE_NAME