On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package dockerfile
Generate Dockerfile scripts for use with the Docker container manager
Core combinators and serializers
val sexp_of_t : t -> Sexplib.Sexp.tsexp_of_t t converts a Dockerfile into a s-expression representation.
val t_of_sexp : Sexplib.Sexp.t -> tval empty : tAn empty set of instruction lines.
maybe f v returns empty if the optional value v is None, and otherwise applies f to the Some value in v.
Dockerfile commands
val sexp_of_parser_directive : parser_directive -> Ppx_sexp_conv_lib.Sexp.tval parser_directive_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> parser_directiveval __parser_directive_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> parser_directiveval parser_directive : parser_directive -> tA parser directive. If used, needs to be the first line of the Dockerfile.
val buildkit_syntax : tConvenience function, returns the parser directive describing the latest BuildKit syntax.
val comment : ('a, unit, string, t) Stdlib.format4 -> 'aAdds a comment to the Dockerfile for documentation purposes
Build here-document values with heredoc.
val heredoc :
?strip:bool ->
?word:string ->
?delimiter:string ->
('a, unit, string, heredoc) Stdlib.format4 ->
'aheredoc ~word here_document creates a heredoc value with here_document as content and word () as opening delimiter. If word is quoted, then delimiter (unquoted word) needs to be specified. Quoting affects expansion in the here-document. Requires 1.4 buildkit_syntax.
val from : ?alias:string -> ?tag:string -> ?platform:string -> string -> tThe from instruction sets the base image for subsequent instructions.
- A valid Dockerfile must have
fromas its first instruction. The image can be any valid image. frommust be the first non-comment instruction in the Dockerfile.fromcan appear multiple times within a single Dockerfile in order to create multiple images. Multiple FROM commands will result in a multi-stage build, and the?fromargument to thecopyandaddfunctions can move artefacts across stages.
By default, the stages are not named, and you refer to them by their integer number, starting with 0 for the first FROM instruction. However, you can name your stages, by supplying an ?alias argument. The alias can be supplied to the ?from parameter to copy or add to refer to this particular stage by name.
If no tag is supplied, latest is assumed. If the used tag does not exist, an error will be returned.
The optional platform flag can be used to specify the platform of the image in case the from references a multi-platform image. For example, linux/386 could be used. By default, the target platform of the build request is ued if this is not specified.
val maintainer : ('a, unit, string, t) Stdlib.format4 -> 'amaintainer sets the author field of the generated images.
val run :
?mounts:mount list ->
?network:network ->
?security:security ->
('a, unit, string, t) Stdlib.format4 ->
'arun ?mounts ?network ?security fmt will execute any commands in a new layer on top of the current image and commit the results. The resulting committed image will be used for the next step in the Dockerfile. The string result of formatting arg will be passed as a /bin/sh -c invocation.
run_exec ?mounts ?network ?security args will execute any commands in a new layer on top of current image and commit the results. The resulting committed image will be used for the next step in the Dockerfile. The cmd form makes it possible to avoid shell string munging, and to run commands using a base image that does not contain /bin/sh.
val mount_bind :
target:string ->
?source:string ->
?from:string ->
?readwrite:bool ->
unit ->
mountmount_bind ~target ?source ?from ?readwrite () Creates a bind mount for run.
Requires buildkit_syntax.
val mount_cache :
?id:string ->
target:string ->
?readonly:bool ->
?sharing:[ `Locked | `Private | `Shared ] ->
?from:string ->
?source:string ->
?mode:int ->
?uid:int ->
?gid:int ->
unit ->
mountmount_cache ?id ~target ?readonly ?sharing ?from ?source ?mode ?uid ?gid () Creates a cache mount for run.
Requires buildkit_syntax.
val mount_tmpfs : target:string -> ?size:int -> unit -> mountmount_tmpfs ~target ?size ()) Creates a tmpfs mount for run.
Requires buildkit_syntax.
val mount_secret :
?id:string ->
?target:string ->
?required:bool ->
?mode:int ->
?uid:int ->
?gid:int ->
unit ->
mountmount_secret ?id ?target ?required ?mode ?uid ?gid Creates a secret mount for run.
Requires buildkit_syntax.
val mount_ssh :
?id:string ->
?target:string ->
?required:bool ->
?mode:int ->
?uid:int ->
?gid:int ->
unit ->
mountmount_ssh ?id ?target ?required ?mode ?uid ?gid Creates an ssh mount for run.
Requires buildkit_syntax.
Seems to be only supported by Docker at the moment.
val cmd : ('a, unit, string, t) Stdlib.format4 -> 'acmd args provides defaults for an executing container. These defaults can include an executable, or they can omit the executable, in which case you must specify an entrypoint as well. The string result of formatting arg will be passed as a /bin/sh -c invocation.
There can only be one cmd in a Dockerfile. If you list more than one then only the last cmd will take effect.
val cmd_exec : string list -> tcmd_exec args provides defaults for an executing container. These defaults can include an executable, or they can omit the executable, in which case you must specify an entrypoint as well. The first argument to the args list must be the full path to the executable.
There can only be one cmd in a Dockerfile. If you list more than one then only the last cmd will take effect.
val expose_port : int -> texpose_port informs Docker that the container will listen on the specified network port at runtime.
val expose_ports : int list -> texpose_ports informs Docker that the container will listen on the specified network ports at runtime.
val arg : ?default:string -> string -> targ ~default name defines a variable that users can pass at build-time to the builder with the docker build command using the --build-arg <varname>=<value> flag. It can optionally include a default value.
val env : (string * string) list -> tenv sets the list of environment variables supplied with the (<key>, <value>) tuple. This value will be passed to all future run instructions. This is functionally equivalent to prefixing a shell command with <key>=<value>.
val add :
?link:bool ->
?chown:string ->
?from:string ->
src:string list ->
dst:string ->
unit ->
tadd ?link ?chown ?from ~src ~dst () copies new files, directories or remote file URLs from src and adds them to the filesystem of the container at the dst path.
Multiple src resource may be specified but if they are files or directories then they must be relative to the source directory that is being built (the context of the build).
Each src may contain wildcards and matching will be done using Go's filepath.Match rules.
All new files and directories are created with a UID and GID of 0. In the case where src is a remote file URL, the destination will have permissions of 600. If the remote file being retrieved has an HTTP Last-Modified header, the timestamp from that header will be used to set the mtime on the destination file. Then, like any other file processed during an ADD, mtime will be included in the determination of whether or not the file has changed and the cache should be updated.
val copy :
?link:bool ->
?chown:string ->
?from:string ->
src:string list ->
dst:string ->
unit ->
tcopy ?link ?chown ?from ~src ~dst () copies new files or directories from src and adds them to the filesystem of the container at the path dst. See add for more detailed documentation.
copy_heredoc src dst creates the file dst using the content of the here-documents src. Requires 1.4 buildkit_syntax.
val user : ('a, unit, string, t) Stdlib.format4 -> 'auser fmt sets the user name or UID to use when running the image and for any run, cmd, entrypoint commands that follow it in the Dockerfile.
val workdir : ('a, unit, string, t) Stdlib.format4 -> 'aworkdir fmt sets the working directory for any run, cmd and entrypoint instructions that follow it in the Dockerfile.
It can be used multiple times in the one Dockerfile. If a relative path is provided, it will be relative to the path of the previous workdir instruction.
val volume : ('a, unit, string, t) Stdlib.format4 -> 'avolume fmt will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers. The value can be a JSON array or a plain string with multiple arguments that specify several mount points.
val volumes : string list -> tvolumes mounts will create mount points with the specified names in mounts and mark them as holding externally mounted volumes from native host or other containers.
val entrypoint : ('a, unit, string, t) Stdlib.format4 -> 'aentrypoint fmt allows you to configure a container that will run as an executable. The fmt string will be executed using a /bin/sh subshell.
The shell form prevents any cmd or run command line arguments from being used, but has the disadvantage that your entrypoint will be started as a subcommand of /bin/sh -c, which does not pass signals. This means that the executable will not be the container's PID 1 - and will not receive Unix signals - so your executable will not receive a SIGTERM from docker stop <container>.
To get around this limitation, use the entrypoint_exec command to directly execute an argument list without a subshell.
val entrypoint_exec : string list -> tentrypoint fmt allows you to configure a container that will run as an executable. You can use the exec form here to set fairly stable default commands and arguments and then use either cmd or cmd_exec to set additional defaults that are more likely to be changed by the user starting the Docker container.
val shell : string list -> tshell t allows the default shell used for the shell form of commands to be overridden. The default shell on Linux is "/bin/sh"; "-c", and on Windows is "cmd"; "/S"; "/C". The shell instruction can appear multiple times. Each shell instruction overrides all previous shell instructions, and affects all subsequent instructions.
onbuild t adds to the image a trigger instruction t to be executed at a later time, when the image is used as the base for another build. The trigger will be executed in the context of the downstream build, as if it had been inserted immediately after the from instruction in the downstream Dockerfile.
Any build instruction can be registered as a trigger.
This is useful if you are building an image which will be used as a base to build other images, for example an application build environment or a daemon which may be customized with user-specific configuration.
val label : (string * string) list -> tlabel l adds metadata to an image via a list of key-value pairs. To include spaces within a label value, use quotes and backslashes as you would in command-line parsing. An image can have more than one label. To specify multiple labels, Docker recommends combining labels into a single label instruction where possible. Each label instruction produces a new layer which can result in an inefficient image if you use many labels.
Labels are additive including LABELs in FROM images. If Docker encounters a label/key that already exists, the new value overrides any previous labels with identical keys.
To view an image’s labels, use the docker inspect command.
val healthcheck :
?interval:string ->
?timeout:string ->
?start_period:string ->
?retries:int ->
('a, unit, string, t) Stdlib.format4 ->
'ahealthcheck cmd checks container health by running a command inside the container. See cmd for additional details.
val healthcheck_exec :
?interval:string ->
?timeout:string ->
?start_period:string ->
?retries:int ->
string list ->
thealthcheck_exec cmd checks container health by running a command inside the container. See cmd_exec and healthcheck for additional details.
val healthcheck_none : unit -> thealthcheck_none disables any healthcheck inherited from the base image.
val stopsignal : string -> tstopsignal signal sets the system call signal that will be sent to the container to exit.
On This Page