Index of types


A
authorized_tokens [Ketrew_configuration]
This type is a container for one more authentication-tokens, used by the server's HTTP API

B
bookkeeping [Ketrew_target.Automaton]

C
client [Ketrew_configuration]
Configuration of the client (as in HTTP client).
condition_evaluation [Ketrew_target.Automaton]

D
default_shell [Ketrew_host]
dependencies_status [Ketrew_target.Automaton]
distributed_shell_parameters [Ketrew_yarn]

E
engine [Ketrew_configuration]
The configuration of the engine, the component that orchestrates the run of the targets (used both for standalone and server modes).
error [Ketrew_long_running]
The “imposed” error types for “long-running” plugins.
execution [Ketrew_host_io.Error]
explorer_defaults [Ketrew_configuration]
Configuration of the Explorer text-user-interface.

F
failure_reason [Ketrew_target.Automaton]

H
http_request [Ketrew_measurement]

I
id [Ketrew_target]
The identifiers of targets.

L
long_running_action [Ketrew_target.Automaton]
long_running_failure [Ketrew_target.Automaton]

M
measurement [Ketrew_measurement]
menu_item [Ketrew_interaction]
The type of a menu item.
mode [Ketrew_configuration]
Union of the possible configuration “modes.”

N
non_zero_execution [Ketrew_host_io.Error]

P
plugin [Ketrew_configuration]
The 2 kinds of dynamically loaded “plugins” accepted by Ketrew:
process_check [Ketrew_target.Automaton]
process_status_check [Ketrew_target.Automaton]
profile [Ketrew_configuration]
A profile is a name associated with a configuration.
progress [Ketrew_target.Automaton]

R
response_log [Ketrew_measurement]
run_parameters [Ketrew_long_running.LONG_RUNNING]
Hidden type kept serialized by the engine.
run_parameters [Ketrew_daemonize]

S
server [Ketrew_configuration]
The configuration of the server.
severity [Ketrew_target.Automaton]
shell [Ketrew_host_io]
A “shell” is a function that takes a command and returns, and execv-style string list; the default for each host is "sh"; "-c"; cmd
standalone [Ketrew_configuration]
structure [Ketrew_target.Volume]

T
t [Ketrew_unix_process.Exit_code]
t [Ketrew_protocol.Up_message]
t [Ketrew_protocol.Down_message]
t [Ketrew_pervasives.Unique_id]
t [Ketrew_pervasives.Time]
t [Ketrew_pervasives.Json.Versioned.WITH_VERSIONED_SERIALIZATION]
t [Ketrew_pervasives.Json]
t [Ketrew_monitored_script]
t [Ketrew_measurement.Collection]
t [Ketrew_measurement.Item]
t [Ketrew_explorer]
t [Ketrew_client.Error]
t [Ketrew_client]
The handle of the client.
t [Ketrew_edsl.Condition]
t [Ketrew_edsl.Program]
Something to run is a Ketrew_program.t.
t [Ketrew_edsl.Host]
Alias for the host type.
t [Ketrew_engine]
The contents of the application engine.
t [Ketrew_configuration]
The contents of a configuration.
t [Ketrew_target.Stored_target]
t [Ketrew_target.State]
t [Ketrew_target.Equivalence]
t [Ketrew_target.Condition]
An execution anti-condition; the condition defines when a target is ready and therefore should be run if the condition is met: with `Never the target always runs (because never “ready”),, with `Satisfied the target never runs (a bit useless),, with `Volume_exists v the target runs if the volume does not exist (make-like behavior)., with `Volume_size_bigger_than (v, sz) Ketrew will get the total size of the volume (in bytes) and check that it is bigger., with `Command_returns (c, v) Ketrew will run the Ketrew_target.Command.t and check its return value., `And list_of_conditions is a conjunction of conditions.
t [Ketrew_target.Build_process]
Specification of how to build a target.
t [Ketrew_target.Volume]
t [Ketrew_target.Command]
The type of commands.
t [Ketrew_target]
t [Ketrew_program]
t [Ketrew_host.Ssh]
t [Ketrew_host]
t [Ketrew_path]
target [Ketrew_target.Stored_target]
target_query [Ketrew_protocol.Up_message]
timeout [Ketrew_host_io]
Timeout specification for execution functions below.
transition [Ketrew_target.Automaton]
transition_callback [Ketrew_target.Automaton]

U
ui [Ketrew_configuration]
General configuration of the text-based user interface.