ewms-pilot 0.26.8

EWMS's Pilot: A Job Pilot for Processing EWMS Events/Tasks

ewms-pilot

An Event-Task Pilot for EWMS

The EWMS Pilot is a non-user-facing wrapper for task container instances in the Event Workflow Management System (EWMS), running on an HTCondor Execution Point (EP). The pilot:

• Triggers task instances for each inbound event.
• Interfaces with EWMS events as input/output files.
• Isolates task containers from one another.
• Provides fault tolerance for failed tasks, CPUs, etc.

The following outlines what users need to know to operate within EWMS.

Overview

The Pilot is designed to be invisible to users. However, some key details are necessary for running a task container:

Task Container Overview

A task container is created for each inbound event, it is defined by its image, arguments, and environment variables. See the WMS docs for information on setting these within EWMS.

Event I/O

An input event is provided to the task container as a file. The task container creates an output event by writing to a predetermined location.

The pilot provides the filepaths to the input and output files in two ways:

1. By replacing the placeholder strings, {{INFILE}} and {{OUTFILE}}, in the container's arguments at runtime.
2. By setting the task container's environment variables: EWMS_TASK_INFILE and EWMS_TASK_OUTFILE.

The files' extensions are configured by the pilot's environment variables, EWMS_PILOT_INFILE_EXT and EWMS_PILOT_OUTFILE_EXT: by default, these are .in and .out, respectively.

No other event or message handling is required by the task container.

The Init Container

An init container is an optional, user-supplied image used to set up the environment, wait for conditions, or perform other preparatory actions before running task containers. It is configured using the EWMS_PILOT_INIT_IMAGE, EWMS_PILOT_INIT_ARGS, and EWMS_PILOT_INIT_ENV_JSON environment variables.

File I/O

Task containers (and init containers) can interact with external files in two ways:

Inter-Task Files

To transfer files between task containers, a shared directory is available to all task containers and the init container.

The pilot provides the filepath to the "data hub" in two ways:

1. By replacing the placeholder string, {{DATA_HUB}}, in the container's arguments at runtime.
2. By setting the task container's environment variable: EWMS_TASK_DATA_HUB_DIR.

Note:

• The data hub directory is writable, but there is no protection against race conditions for parallelized tasks.

External Files

Externally-mounted directories are supported in EWMS. See the WMS documentation for more details.

EWMS Glossary Applied to the Pilot

Workflow

Does not exist within the Pilot. Compare to WMS.

Message Queue

The message queue is abstracted from the task container and can be ignored. Compare to WMS.

Event

An event is an object transferred via event I/O. Compare to WMS.

Task

In the context of the Pilot, the task is the runtime instance of the task image (a task container) applied to an inbound event, possibly producing outbound events. Compare to WMS.

Task Container

The task container is an instance of a task image and is nearly synonymous with task.

Task Directive

Does not exist within the Pilot. Compare to WMS.

Taskforce

Does not exist within the Pilot. Compare to WMS.