package dockerfile-opam

  1. Overview
  2. Docs

Run Opam commands across a matrix of Docker containers. Each of these containers represents a different version of OCaml, Opam and an OS distribution (such as Debian or Alpine).

Known distributions and OCaml variants

type win10_release = [
  1. | `V1507
  2. | `V1511
  3. | `V1607
  4. | `V1703
  5. | `V1709
  6. | `V1803
  7. | `V1809
  8. | `V1903
  9. | `V1909
  10. | `V2004
  11. | `V20H2
  12. | `V21H1
  13. | `V21H2
]

All Windows 10 release versions.

val sexp_of_win10_release : win10_release -> Sexplib0.Sexp.t
val win10_release_of_sexp : Sexplib0.Sexp.t -> win10_release
val __win10_release_of_sexp__ : Sexplib0.Sexp.t -> win10_release
type win10_ltsc = [
  1. | `Ltsc2015
  2. | `Ltsc2016
  3. | `Ltsc2019
  4. | `Ltsc2022
]

All Windows Long-Term Service Branch releases. LTSC versions are aliased to the semi-annual release they're based on.

val sexp_of_win10_ltsc : win10_ltsc -> Sexplib0.Sexp.t
val win10_ltsc_of_sexp : Sexplib0.Sexp.t -> win10_ltsc
val __win10_ltsc_of_sexp__ : Sexplib0.Sexp.t -> win10_ltsc
type win_all = [
  1. | win10_release
  2. | win10_ltsc
]

All Windows 10/11 release versions and LTSC names.

val sexp_of_win_all : win_all -> Sexplib0.Sexp.t
val win_all_of_sexp : Sexplib0.Sexp.t -> win_all
val __win_all_of_sexp__ : Sexplib0.Sexp.t -> win_all
type win10_lcu = [
  1. | `LCU
  2. | `LCU20230314
  3. | `LCU20230214
  4. | `LCU20230110
  5. | `LCU20221213
  6. | `LCU20221108
  7. | `LCU20221011
  8. | `LCU20220913
  9. | `LCU20220809
  10. | `LCU20220712
  11. | `LCU20220614
  12. | `LCU20220510
  13. | `LCU20220412
  14. | `LCU20220308
  15. | `LCU20220208
  16. | `LCU20220111
  17. | `LCU20211214
  18. | `LCU20211109
  19. | `LCU20211012
  20. | `LCU20210914
  21. | `LCU20210810
  22. | `LCU20210713
  23. | `LCU20210608
]

Windows 10 Latest Cumulative Update. Out-of-band LCUs are not included as they aren't released with Docker images. `LCU always refers to the most recent LCU.

val sexp_of_win10_lcu : win10_lcu -> Sexplib0.Sexp.t
val win10_lcu_of_sexp : Sexplib0.Sexp.t -> win10_lcu
val __win10_lcu_of_sexp__ : Sexplib0.Sexp.t -> win10_lcu
val win10_current_lcu : win10_lcu

Current Windows 10 Latest Cumulative Update; value used when `LCU is specified.

type win10_revision = win10_release * win10_lcu option

A Windows 10 version optionally with an LCU.

val sexp_of_win10_revision : win10_revision -> Sexplib0.Sexp.t
val win10_revision_of_sexp : Sexplib0.Sexp.t -> win10_revision
type distro = [
  1. | `Alpine of [ `V3_3 | `V3_4 | `V3_5 | `V3_6 | `V3_7 | `V3_8 | `V3_9 | `V3_10 | `V3_11 | `V3_12 | `V3_13 | `V3_14 | `V3_15 | `V3_16 | `V3_17 ]
  2. | `Archlinux of [ `Latest ]
  3. | `CentOS of [ `V6 | `V7 | `V8 ]
  4. | `Debian of [ `V11 | `V10 | `V9 | `V8 | `V7 | `Testing | `Unstable ]
  5. | `Fedora of [ `V21 | `V22 | `V23 | `V24 | `V25 | `V26 | `V27 | `V28 | `V29 | `V30 | `V31 | `V32 | `V33 | `V34 | `V35 | `V36 | `V37 ]
  6. | `OracleLinux of [ `V7 | `V8 | `V9 ]
  7. | `OpenSUSE of [ `V42_1 | `V42_2 | `V42_3 | `V15_0 | `V15_1 | `V15_2 | `V15_3 | `V15_4 ]
  8. | `Ubuntu of [ `V12_04 | `V14_04 | `V15_04 | `V15_10 | `V16_04 | `V16_10 | `V17_04 | `V17_10 | `V18_04 | `V18_10 | `V19_04 | `V19_10 | `V20_04 | `V20_10 | `V21_04 | `V21_10 | `V22_04 | `V22_10 ]
  9. | `Cygwin of win10_release
  10. | `Windows of [ `Mingw | `Msvc ] * win10_release
]

Supported Docker container distributions without aliases.

val sexp_of_distro : distro -> Sexplib0.Sexp.t
val distro_of_sexp : Sexplib0.Sexp.t -> distro
val __distro_of_sexp__ : Sexplib0.Sexp.t -> distro
type t = [
  1. | `Alpine of [ `V3_3 | `V3_4 | `V3_5 | `V3_6 | `V3_7 | `V3_8 | `V3_9 | `V3_10 | `V3_11 | `V3_12 | `V3_13 | `V3_14 | `V3_15 | `V3_16 | `V3_17 | `Latest ]
  2. | `Archlinux of [ `Latest ]
  3. | `CentOS of [ `V6 | `V7 | `V8 | `Latest ]
  4. | `Debian of [ `V11 | `V10 | `V9 | `V8 | `V7 | `Stable | `Testing | `Unstable ]
  5. | `Fedora of [ `V21 | `V22 | `V23 | `V24 | `V25 | `V26 | `V27 | `V28 | `V29 | `V30 | `V31 | `V32 | `V33 | `V34 | `V35 | `V36 | `V37 | `Latest ]
  6. | `OracleLinux of [ `V7 | `V8 | `V9 | `Latest ]
  7. | `OpenSUSE of [ `V42_1 | `V42_2 | `V42_3 | `V15_0 | `V15_1 | `V15_2 | `V15_3 | `V15_4 | `Latest ]
  8. | `Ubuntu of [ `V12_04 | `V14_04 | `V15_04 | `V15_10 | `V16_04 | `V16_10 | `V17_04 | `V17_10 | `V18_04 | `V18_10 | `V19_04 | `V19_10 | `V20_04 | `V20_10 | `V21_04 | `V21_10 | `V22_04 | `V22_10 | `Latest | `LTS ]
  9. | `Cygwin of win_all
  10. | `Windows of [ `Mingw | `Msvc ] * win_all
]

Supported Docker container distributions with aliases such as `Latest.

val sexp_of_t : t -> Sexplib0.Sexp.t
val t_of_sexp : Sexplib0.Sexp.t -> t
val __t_of_sexp__ : Sexplib0.Sexp.t -> t
type os_family = [
  1. | `Cygwin
  2. | `Linux
  3. | `Windows
]

The operating system family a distro belongs to.

val sexp_of_os_family : os_family -> Sexplib0.Sexp.t
val os_family_of_sexp : Sexplib0.Sexp.t -> os_family
val __os_family_of_sexp__ : Sexplib0.Sexp.t -> os_family
val os_family_of_distro : t -> os_family

os_family_of_distro t returns the OS family of the distro.

val os_family_to_string : os_family -> string

os_family_to_string os returns a string representing the OS family.

val opam_repository : os_family -> string

opam_repository os_family returns the git URL to the default Opam repository.

val personality : os_family -> Ocaml_version.arch -> string option

personality os_family arch returns the personality associated to the architecture, if os_family is `Linux.

val is_same_distro : t -> t -> bool

is_same_distro d1 d2 returns whether d1 is the same distro as d2, regardless of their respective versions.

val compare : t -> t -> int

compare a b is a lexical comparison function for t.

val resolve_alias : t -> distro

resolve_alias t will resolve t into a concrete version. This removes versions such as Latest.

val distros : t list

Enumeration of the supported Docker container distributions.

val latest_distros : t list

Enumeration of the latest stable (ideally LTS) supported distributions.

val win10_latest_release : win10_release

Latest Windows 10 release.

val win10_latest_image : win10_release

Latest Windows 10 Docker image available. May differ from win10_latest_release if the Docker repository hasn't been updated.

val master_distro : t

The distribution that is the top-level alias for the latest tag in the ocaml/opam2 Docker Hub build.

val builtin_ocaml_of_distro : t -> string option

builtin_ocaml_of_distro t will return the OCaml version supplied with the distribution packaging, and None if there is no supported version.

val human_readable_string_of_distro : t -> string

human_readable_string_of_distro t returns a human readable version of the distribution tag, including version information.

val human_readable_short_string_of_distro : t -> string

human_readable_short_string_of_distro t returns a human readable short version of the distribution tag, excluding version information.

type package_manager = [
  1. | `Apk
    (*

    Alpine Apk

    *)
  2. | `Apt
    (*

    Debian Apt

    *)
  3. | `Yum
    (*

    Fedora Yum

    *)
  4. | `Zypper
    (*

    OpenSUSE Zypper

    *)
  5. | `Pacman
    (*

    Archlinux Pacman

    *)
  6. | `Cygwin
    (*

    Cygwin package manager

    *)
  7. | `Windows
    (*

    Native Windows, WinGet, Cygwin

    *)
]

The package manager used by a distro.

val sexp_of_package_manager : package_manager -> Sexplib0.Sexp.t
val package_manager_of_sexp : Sexplib0.Sexp.t -> package_manager
val __package_manager_of_sexp__ : Sexplib0.Sexp.t -> package_manager
val package_manager : t -> package_manager

package_manager t returns the package manager used by that distribution. Many derived distributions (such as OracleLinux) share the same package manager from a base distribution (such as CentOS).

val bubblewrap_version : t -> (int * int * int) option

bubblewrap_version t returns the version of bubblewrap available on that distribution.

Docker Hub addresses

val tag_of_distro : t -> string

tag_of_distro t convert a distribution t to a Docker Hub tag.

val distro_of_tag : string -> t option

distro_of_tag s parses s into a t distribution, and None otherwise.

val latest_tag_of_distro : t -> string

latest_tag_of_distro distro will generate a Docker Hub tag that is a convenient short form for the latest stable release of a particular distribution. This tag will be regularly rewritten to point to any new releases of the distribution.

type win10_docker_base_image = [
  1. | `NanoServer
    (*

    Windows Nano Server

    *)
  2. | `ServerCore
    (*

    Windows Server Core

    *)
  3. | `Windows
    (*

    Windows Server "with Desktop Experience"

    *)
]

Windows containers base images.

val win10_base_tag : ?win10_revision:win10_lcu -> win10_docker_base_image -> win_all -> string * string

win10_base_tag base_image release will return a tuple of Windows container base image and tag for which the base image of a Windows base image can be found (e.g. mcr.microsoft.com/windows/servercore,ltsc2022 which maps to mcr.microsoft.com/windows/servercore:ltsc2022 on the Microsoft Container Registry).

val base_distro_tag : ?win10_revision:win10_lcu -> ?arch:Ocaml_version.arch -> t -> string * string

base_distro_tag ?arch t will return a tuple of a Docker Hub user/repository and tag for which the base image of a distribution can be found (e.g. opensuse/leap,15.0 which maps to opensuse/leap:15.0 on the Docker Hub). This base image is in turn can be used to generate opam and other OCaml tool Dockerfiles. arch defaults to x86_64 and can vary the base user/repository since some architecture are built elsewhere.

val win10_release_to_string : win10_release -> string

win10_release_to_string update converts a Windows 10 version name to string.

val win10_release_of_string : string -> win_all option

win10_release_of_string converts a Windows 10 version name as string to its internal representation. Ignores any KB number.

val win10_revision_to_string : win10_revision -> string
val win10_revision_of_string : string -> win10_revision option

CPU architectures

val distro_arches : Ocaml_version.t -> t -> Ocaml_version.arch list

distro_arches ov t returns the list of architectures that distribution t is supported on for OCaml compiler version ov

val distro_supported_on : Ocaml_version.arch -> Ocaml_version.t -> t -> bool

distro_supported_on arch ov distro returns true if the combination of CPU arch, compiler version ov is available on the distribution distro.

Opam build infrastructure support

type win10_release_status = [
  1. | `Deprecated
  2. | `Active
]

Windows 10 release status.

val win10_release_status : win_all -> win10_release_status

win10_release_status v channel returns the Microsoft support status of the specified Windows 10 release.

val active_distros : Ocaml_version.arch -> t list

active_distros arch returns the list of currently supported distributions in the opam build infrastructure. Distributions that are end-of-life upstream will rotate out of this list regularly.

val active_tier1_distros : Ocaml_version.arch -> t list

Tier 1 distributions are those supported for the full matrix of compiler versions in the opam build infrastructure. The Docker base images will compile a base image for every OCaml version, so this list should be added to sparingly.

val active_tier2_distros : Ocaml_version.arch -> t list

Tier 2 distributions are those supported for a limited set of compiler versions in the opam build infrastructure. The distros in this list are also tested for packages in the opam repository.

val active_tier3_distros : Ocaml_version.arch -> t list

Tier 3 distributions are those supported for a limited set of compiler versions in the opam build infrastructure. While these distros will have base images compiled for them, they are not widely tested. Distros maybe here as they are on the way to being deprecated, or new and still experimental.