Index of modules


A
Array [Ketrew_pervasives]
Automaton [Ketrew_target]

B
Build_process [Ketrew_target]

C
Collection [Ketrew_measurement]
A mutable collection of Ketrew_measurement.Item.t values.
Command [Ketrew_target]
Definition of command-lines to run on a given Ketrew_host.t.
Command_line [Ketrew]
Condition [Ketrew_edsl]
Condition [Ketrew_target]
Configuration [Ketrew]
Count [Ketrew_target.State]
A module providing functions t -> int to provide counts.

D
Daemonize [Ketrew]
Down_message [Ketrew_protocol]

E
EDSL [Ketrew]
Engine [Ketrew]
Equivalence [Ketrew_target]
Error [Ketrew_host_io]
Error [Ketrew_client]
Error.t is the type of the error kinds that this module introduces.
Error [Ketrew]
Exit_code [Ketrew_unix_process]
Higher-level representation of Unix exit codes.

F
Float [Ketrew_pervasives]

H
Host [Ketrew_edsl]
Host [Ketrew]

I
Int [Ketrew_pervasives]
Is [Ketrew_target.State]
Item [Ketrew_measurement]
This module allows to construct and transform measurmeent items.

J
Json [Ketrew_pervasives]

K
Ketrew
Top-level module exporting the API (pack).
Ketrew_client
The “client” is the frontend to either a standalone engine or an HTTP client talking to a server/engine.
Ketrew_command_line
Command line interface to the engine.
Ketrew_configuration
Definition of the configuration (input to state creation; contents of the config-file).
Ketrew_daemonize
Implementation of the LONG_RUNNING API with nohup setsid unix processes or generated Python scripts.
Ketrew_document
Transform complex Ketrew values into display-friendly Log.t values.
Ketrew_edsl
Easy interface to the library for end users.
Ketrew_engine
The engine of the actual Workflow Engine.
Ketrew_error
Deal with error values common across the library.
Ketrew_eval_condition
Evaluation of Ketrew_target.Condition.t values.
Ketrew_explorer
The “Target Explorer™“
Ketrew_host
Definition of a host; a place to run commands or handle files.
Ketrew_host_io
Definition of a host; a place to run commands or handle files.
Ketrew_interaction
Keyboard interaction functions (build “menus”, ask questions, etc.)
Ketrew_long_running
Definition of the interface required from “long-running task” plugins.
Ketrew_long_running_utilities
Call Deferred_result.fail with a “fatal error” (Mandatory in the Long-running API).
Ketrew_lsf
Implementation of the LONG_RUNNING API with the LSF batch processing scheduler.
Ketrew_measurement
Measurements are values that the Engine will keep about its performance; those can be “flushed” to the database, and exported later.
Ketrew_monitored_script
Generate Shell scripts that “monitor” commands.
Ketrew_path
File-path handling
Ketrew_pbs
Implementation of the LONG_RUNNING API with the PBS batch processing scheduler.
Ketrew_pervasives
Pervasives module for the library.
Ketrew_plugin
The “long-running” plugins loaded by default.
Ketrew_program
The “things” to run on a given host.
Ketrew_protocol
Ketrew_server
Implementation of the HTTP server.
Ketrew_target
Definition of the basic building bloc of a workflow.
Ketrew_unix_io
Ketrew_unix_process
Manage calls to Unix processes
Ketrew_yarn
Implementation of the LONG_RUNNING API asking Aapache Yarn for resources and using Ketrew_daemonize to “keep” the process group together.

L
List [Ketrew_pervasives]
Log [Ketrew_pervasives]
Application of the functor Docout.Make_logger to write to stderr without buffering.

M
Measure [Ketrew_engine]
Measurements [Ketrew_engine]

O
Of_v0 [Ketrew_pervasives.Json.Versioned]
Option [Ketrew_pervasives]

P
Path [Ketrew]
Program [Ketrew_edsl]
Build “things to run”, i.e.
Program [Ketrew]

R
Result [Ketrew_pervasives]
Run_automaton [Ketrew_engine]

S
Ssh [Ketrew_host_io]
Helper functions to build SSH commands.
Ssh [Ketrew_host]
Definitions specific to “SSH” hosts (see Ketrew_host.connection).
State [Ketrew_target]
Stored_target [Ketrew_target]
String [Ketrew_pervasives]

T
Target [Ketrew]
Time [Ketrew_pervasives]
Handle timestamps.

U
Unique_id [Ketrew_pervasives]
Provide pseudo-unique identifiers.
Up_message [Ketrew_protocol]

V
Versioned [Ketrew_pervasives.Json]
Volume [Ketrew_target]