refinery-workflow(8) -- workflow start and stop commands¶

Synopsis¶

refinery workflow [option]

Description¶

Provides the ability to interact and check the status of processes based on the workflow they belong to.

Options¶

--list¶

List all the workflows within the Refinery installation

--show workflow¶

List the processes that form the specified workflow

---start workflow(s)¶

Start the processes within the specified workflow(s)

Note that the process start order is dependent on the layout of the workflow.

This option supports specifying multiple workflows if they are comma-separated (e.g. --start workflow1,workflow2) and also supports the additional [WORKFLOW WAIT OPTION] described below.

--stop workflow(s)¶

Stop the processes within the specified workflow(s). This option supports specifying multiple workflows if they are comma-separated (e.g. --stop workflow1,workflow2) and also supports the additional [WORKFLOW WAIT OPTION] and [WORKFLOW FORCE STOP OPTION] described below.

--restart workflow(s)¶

Stops the processes within the specified workflow(s) and then starts them again. This option supports specifying multiple workflows if they are comma-separated (e.g. --restart workflow1,workflow2) and also supports the additional [WORKFLOW WAIT OPTION] and [WORKFLOW FORCE STOP OPTION] described below.

If the [WORKFLOW WAIT OPTION] option is used, the command will wait for the workflow to completely stop and start again before returning.

--status workflow¶

Shows the status of each process within the workflow. This option supports the additional [PROCESS IGNORE OPTIONS] described below.

--status-summary¶

Shows the overall status of all workflows within the Refinery installation. A workflow status is derived from the status of all processes within it. This option supports the additional [PROCESS IGNORE OPTIONS] and [STATUS SUMMARY FILTERING OPTION] described below.

--start-core¶

Starts all the 'core' Refinery workflows. These workflows MUST be started prior to attempting to start any pipeline workflows. This option supports the additional [ENVIRONMENT SPECIFIC OPTIONS] described below.

--stop-core¶

Stops all the 'core' Refinery workflows. This option will only stop the core workflows if there are no pipeline workflows running. If one or more pipelines are running, this command will throw an error. This option supports the additional [ENVIRONMENT SPECIFIC OPTIONS] described below.

--core-status¶

Shows the current status of the core Refinery workflows. This option supports the additional [ENVIRONMENT SPECIFIC OPTIONS] described below.

Workflow wait option¶

--wait wait-seconds¶

If specified, the command will wait for the workflow to either start up or shut down successfully. A maximum wait time (in seconds) can also be specified which will cause the command to error if the workflow does not start or stop in that time. If no time is specified, a default wait time of 5 minutes will be used.

If this is used when starting multiple workflows, the command will wait for each workflow individually.

Workflow force stop option¶

--force¶

If specified, the workflow will be stopped by killing all its member processes with SIGKILL. This option is only recommended if processes within the workflow do not stop with the standard --stop option.

Process ignore options¶

--ignore-manual-procs¶

If specified, all 'manual' processes within a workflow will be ignored when deriving the overall workflow status. The processes will still be listed in the detailed workflow status with (ignored) printed next to them.

--ignore-scheduled-procs¶

If specified, all 'scheduled' processes within a workflow will be ignored when deriving overall workflow status. The processes will still be listed in the detailed workflow status with (ignored) printed next to them.

Environment specific options¶

--environment env¶

If specified, only the workflows in the specified environment will be affected. In a default Refinery installation, the environment options are A and B.

Status summary filtering option¶

--filter type:filter¶

If specified, the status summary result will be filtered by either workflow or status 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/.

Copyright¶

Version¶

RELEASE_NAME