Wrappers for various Docker client commands, exposing file descriptors.
type 'a log =
?stdout:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
?stderr:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
'aLog standard output and standard error of the sub-process.
Log only standard error of the sub-process.
val version :
(unit -> (string, [> `Msg of string ]) Stdlib.result Lwt.t) logerrval pull : ([< `Docker_image of string ] -> unit Lwt.t) logPulls a Docker image.
val export : ([< `Docker_container of string ] -> unit Lwt.t) logPulls a Docker image.
Exports a Docker container.
val image : ([< `Remove of [< `Docker_image of string ] ] -> unit Lwt.t) logExports a Docker container.
Operates on a Docker image.
val rm : ([ `Docker_container of string ] list -> unit Lwt.t) logOperates on a Docker image.
Removes a Docker container.
val rmi : ([ `Docker_image of string ] list -> unit Lwt.t) logRemoves a Docker container.
Removes a list of Docker images.
val tag :
([< `Docker_image of string ] ->
[< `Docker_image of string ] ->
unit Lwt.t)
logRemoves a list of Docker images.
tag source_image target_image creates a new tag for a Docker iamge.
val commit :
([< `Docker_image of string ] ->
[< `Docker_container of string ] ->
[< `Docker_image of string ] ->
unit Lwt.t)
logtag source_image target_image creates a new tag for a Docker iamge.
commit base_image container target_image commits the container to the target_image using base_image (typically the container's base image) entrypoint and cmd.
val volume :
(?timeout:float ->
[< `Create of [< `Docker_volume of string ]
| `Inspect of [< `Docker_volume of string ] list * [< `Mountpoint ]
| `List of string option
| `Remove of [< `Docker_volume of string ] list ] ->
string Lwt.t)
logerrcommit base_image container target_image commits the container to the target_image using base_image (typically the container's base image) entrypoint and cmd.
Operates on Docker volumes.
val volume_containers :
([< `Docker_volume of string ] ->
[> `Docker_container of string ] list Lwt.t)
logerrOperates on Docker volumes.
volume_containers vol returns the list of containers using vol.
val mount_point : ([< `Docker_volume of string ] -> string Lwt.t) logerrvolume_containers vol returns the list of containers using vol.
mount_point vol returns the mount point in the host filesystem of vol.
val build :
(string list -> [< `Docker_image of string ] -> string -> unit Lwt.t) logmount_point vol returns the mount point in the host filesystem of vol.
build docker_args image context_path builds the Docker image using the context located in context_path.
val run :
?stdin:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
(?is_success:(int -> bool) ->
?name:[< `Docker_container of string ] ->
?rm:bool ->
string list ->
[< `Docker_image of string ] ->
string list ->
unit Lwt.t)
logrun ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
val run' :
?stdin:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
?stdout:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
(?is_success:(int -> bool) ->
?name:[< `Docker_container of string ] ->
?rm:bool ->
string list ->
[< `Docker_image of string ] ->
string list ->
unit Lwt.t)
logerrrun ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
run' ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
val run_result :
?stdin:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
(?name:[< `Docker_container of string ] ->
?rm:bool ->
string list ->
[< `Docker_image of string ] ->
string list ->
(unit, [> `Msg of string ]) Stdlib.result Lwt.t)
logrun' ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
run_result ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
val run_result' :
?stdin:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
?stdout:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
(?name:[< `Docker_container of string ] ->
?rm:bool ->
string list ->
[< `Docker_image of string ] ->
string list ->
(unit, [> `Msg of string ]) Stdlib.result Lwt.t)
logerrrun_result ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
run_result ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
val run_pread_result :
?stdin:[ `Dev_null | `FD_move_safely of Obuilder__.Os.unix_fd ] ->
(?name:[< `Docker_container of string ] ->
?rm:bool ->
string list ->
[< `Docker_image of string ] ->
string list ->
(string, [> `Msg of string ]) Stdlib.result Lwt.t)
logerrrun_result ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
run_pread_result ?stdin ?stdout ?stderr ?is_success ?name ?rm docker_argv image argv
val stop :
([< `Docker_container of string ] ->
(unit, [> `Msg of string ]) Stdlib.result Lwt.t)
logStop a Docker container.
val manifest :
([< `Create of
[< `Docker_image of string ] * [< `Docker_image of string ] list
| `Inspect of [< `Docker_image of string ]
| `Remove of [< `Docker_image of string ] list ] ->
(unit, [> `Msg of string ]) Stdlib.result Lwt.t)
logOperates on a Docker manifest.
val exists :
([< `Docker_container of string
| `Docker_image of string
| `Docker_volume of string ] ->
(unit, [> `Msg of string ]) Stdlib.result Lwt.t)
logTests if an object exists.
val obuilder_images :
(?tmp:bool -> unit -> [ `Docker_image of string ] list Lwt.t) logerrReturns the list of this OBuilder instance images.
val obuilder_containers :
(unit -> [ `Docker_container of string ] list Lwt.t) logerrReturns the list of this OBuilder instance images.
Returns the list of this OBuilder instance containers.
val obuilder_volumes :
(?prefix:string -> unit -> [ `Docker_volume of string ] list Lwt.t) logerrReturns the list of this OBuilder instance containers.
Returns the list of this OBuilder instance volumes.
val obuilder_caches_tmp :
(unit -> [ `Docker_volume of string ] list Lwt.t) logerrReturns the list of this OBuilder instance volumes.
Returns the list of this OBuilder instance temporary caches.