Module Ketrew.EDSL.Host

module Host: sig .. end

type t = Ketrew_pure.Host.t 

Alias for the host type.

val parse : string -> t

Parse a URI string into a Ketrew-host.

The “scheme” and “host” part of the URI define the connection type:

• SSH Hosts: use "ssh:" as the scheme means (if a hostname is defined but no scheme, SSH is the default). Then you can add a user, a hostname, and a port number. You can aslo add options to pass to the SSH client through the URI's query parameters "ssh-option=-K".
• Named hosts: use the scheme "named://" and the hostname as a name. Named hosts are dynamic connections managed by the Ketrew server.
• Engine's host: if no scheme, and no host part are provided, Ketrew will create a host for the local-host (the host where the Engine is running).

The “path” part of the URI defines the “playground”; a directory where the Ketrew-engine will create temporary and monitoring files.

Other query options can be used to configure the host:

• "shell=<comma-separated-list-of-command-line-arguments" defines the shell, with more command-line options, to use on the host.
• "timeout=<float>" is the execution timeout, an optional float setting the maximal duration Ketrew will wait for SSH commands to return.

Examples:

• "ssh://user@SomeHost:42/tmp/pg?shell=bash,-l,--init-file,bouh,-c&timeout=42&ssh-option=-K" is an SSH host.
• "named://TheNameOfTheHost/tmp/ketrew-playground/" is a named host: Ketrew will try to find its active connection called "TheNameOfTheHost" and use it at every call.
• "/tmp/KT?shell=ksh,-c" is the engine's host, using "tmp/KT" as a playground, and "ksh" as a shell.

See also Ketrew_pure.Host.of_uri.

val tmp_on_localhost : t

val ssh : ?add_ssh_options:string list ->
       ?playground:string ->
       ?port:int -> ?user:string -> ?name:string -> string -> t

val cmdliner_term : ?doc:string ->
       [ `Flag of string list | `Required of int ] ->
       t Cmdliner.Term.t

Cmdliner term which creates a host argument or flag. `Required n will be an anonymous argument at position n; `Flag ["option-name"; "O"] will create an optional flag "--option-name" (aliased to "-O") whose default value is the host "/tmp/" (i.e. Localhost with "/tmp" as “playground”).