DOKK / manpages / debian 11 / charliecloud-builders / ch-build.1.en
CH-BUILD(1) Charliecloud CH-BUILD(1)

ch-build - Build an image and place it in the builder's back-end storage

$ ch-build [-b BUILDER] [--builder-info] -t TAG [ARGS ...] CONTEXT


Build an image named TAG described by a Dockerfile. Place the result into the builder’s back-end storage.

Using this script is not required for a working Charliecloud image. You can also use any builder that can produce a Linux filesystem tree directly, whether or not it is in the list below. However, this script hides the vagaries of making the supported builders work smoothly with Charliecloud and adds some conveniences (e.g., pass HTTP proxy environment variables to the build environment if the builder doesn’t do this by default).

Supported builders, unprivileged:

  • buildah: Buildah in “rootless” mode with no setuid helpers, using ch-run (via ch-run-oci) for RUN instructions. This requires Buildah v1.10.1+; see the install instructions.
  • ch-image: Our internal builder.



Supported builders, privileged:

  • buildah-runc: Buildah in “rootless” mode with setuid helpers, using the default runc for RUN instructions.
  • buildah-setuid: Buildah in “rootless” mode with setuid helpers, using ch-run (via ch-run-oci) for RUN instructions.
  • docker: Docker.



Specifying the builder, in descending order of priority:

Command line option.
$CH_BUILDER
Environment variable
docker if Docker is installed; otherwise, ch-image.



Other arguments:

Print the builder to be used and its version, then exit.
Dockerfile to use (default: $CONTEXT/Dockerfile)
Name (tag) of Docker image to build.
Print help and exit.
Print version and exit.



Additional arguments are accepted and passed unchanged to the underlying builder.

The tag suffix :latest is somewhat misleading, as by default neither ch-build nor bare builders will notice if the base FROM image has been updated. Use --pull to make sure you have the latest base image.

Create an image tagged foo and specified by the file Dockerfile located in the context directory. Use /bar as the Docker context directory. Use the default builder.

$ ch-build -t foo /bar


Equivalent to above:

$ ch-build -t foo --file=/bar/Dockerfile /bar


Instead, use /bar/Dockerfile.baz:

$ ch-build -t foo --file=/bar/Dockerfile.baz /bar


Equivalent to the first example, but use ch-image even if Docker is installed:

$ ch-build -b ch-image -t foo /bar


Equivalent to above:

$ export CH_BUILDER=ch-image
$ ch-build -t foo /bar


If Charliecloud was obtained from your Linux distribution, use your distribution’s bug reporting procedures.

Otherwise, report bugs to: <https://github.com/hpc/charliecloud/issues>

charliecloud(7)

Full documentation at: <https://hpc.github.io/charliecloud>

2014–2020, Triad National Security, LLC

2020-12-20 14:44 Coordinated Universal Time 0.21