workflow

Manage entire process workflows

refinery workflow [options]
Options:
--core-status               --list           --status
--environment               --restart        --status-summary
--filter                    --show           --stop
--force                     --start          --stop-core
--ignore-manual-procs       --start-core     --wait
--ignore-scheduled-procs

--list

List all the workflows within the Refinery installation.

--show workflow

List the processes that form a workflow.

--start workflow/s

Start the processes within workflow/s. Separate multiple workflows with commas, e.g. --start workflow1,workflow2.

Note the process start order depends on the layout of the workflow.

Supports the Workflow Wait option.

--stop workflow/s

Stop the processes within workflow/s. Separate multiple workflows with commas, e.g. --stop workflow1,workflow2.

Supports the Workflow Wait option and Workflow Force Stop option.

--restart workflow/s

Stop and restart the processes within workflow/s. Separate multiple workflows with commas, e.g. --stop workflow1,workflow2.

Supports the Workflow Wait option and Workflow Force Stop option. If the Workflow Wait option is used, the command waits for the workflow to completely stop and start again before returning.

--status workflow

Show the status of each process within the workflow.

Supports the Process Ignore options.

--status-summary

Summarize the status of all workflows within the Refinery installation. A workflow status is derived from the status of all processes within it.

Supports the Process Ignore options and Status Summary Filtering option.

--start-core

Start all the core Refinery workflows.

These workflows must be started before attempting to start any pipeline workflows.

Supports the Environment-specific options.

--stop-core

Stop 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.

Supports the additional Environment-specific options.

--core-status

Show current status of the core Refinery workflows.

Supports the additional Environment-specific options.

Workflow wait option

--wait wait-seconds

Wait wait-seconds 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.

When starting multiple workflows, the command waits for each workflow individually.

Workflow force stop option

--force

Stop the workflow by killing all its member processes with SIGKILL.

Recommended only if processes within the workflow do not stop with the standard --stop option.

Process ignore options

--ignore-manual-procs

Ignore all manual processes within a workflow 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

Ignore all scheduled processes within a workflow 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

Apply the command only to workflows in environment env. In a default Refinery installation, the environment options are A and B.

Status summary filtering options

--filter filter-type:filter-value

Filter the status summary results by either workflow or status type.

The filter value is either a specific value or a [simple regular expression]code.kx.com/q/basics/regex/).