buildah-commit man page

buildah-commit — Create an image from a working container.

Synopsis

buildah commit [options] container image

Description

Writes a new image using the specified container's read-write layer and if it is based on an image, the layers of that image.  If image does not begin with a registry name component, localhost will be added to the name.

Return Value

The image ID of the image that was created.  On error, 1 is returned and errno is returned.

Options

--authfile path
Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json, which is set using buildah login. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using docker login.
--cert-dir path
Use certificates at path (*.crt, *.cert, *.key) to connect to the registry. Default certificates directory is /etc/containers/certs.d.
--creds creds
The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered.  The password is entered without echo.
--disable-compression, -D
Don't compress filesystem layers when building the image unless it is required by the location where the image is being written.  This is the default setting, because image layers are compressed automatically when they are pushed to registries, and images being written to local storage would only need to be decompressed again to be stored.  Compression can be forced in all cases by specifying --disable-compression=false.
--format
Control the format for the image manifest and configuration data.  Recognized formats include oci (OCI image-spec v1.0, the default) and docker (version 2, using schema format 2 for the manifest).

Note: You can also override the default format by setting the BUILDAH_FORMAT environment variable.  export BUILDAH\_FORMAT=docker

--iidfile ImageIDfile
Write the image ID to the file.
--quiet
When writing the output image, suppress progress output.
--rm
Remove the container and its content after committing it to an image. Default leaves the container and its content in place.
--squash
Squash all of the new image's layers (including those inherited from a base image) into a single new layer.
--tls-verify bool-value
Require HTTPS and verify certificates when talking to container registries (defaults to true)
--omit-timestamp bool-value
Set the create timestamp to epoch 0 to allow for deterministic builds (defaults to false). By default, the created timestamp is changed and written into the image manifest with every commit, causing the image's sha256 hash to be different even if the sources are exactly the same otherwise. When --omit-timestamp is set to true, the created timestamp is always set to the epoch and therefore not changed, allowing the image's sha256 to remain the same.

Example

This example saves an image based on the container.
buildah commit containerID newImageName

This example saves an image named newImageName based on the container.
buildah commit --rm containerID newImageName

This example saves an image based on the container disabling compression.
buildah commit --disable-compression containerID

This example saves an image named newImageName based on the container disabling compression.
buildah commit --disable-compression containerID newImageName

This example commits the container to the image on the local registry while turning off tls verification.
buildah commit --tls-verify=false containerID docker://localhost:5000/imageId

This example commits the container to the image on the local registry using credentials and certificates for authentication.
buildah commit --cert-dir  /auth  --tls-verify=true --creds=username:password containerID docker://localhost:5000/imageId

This example commits the container to the image on the local registry using credentials from the /tmp/auths/myauths.json file and certificates for authentication.
buildah commit --authfile /tmp/auths/myauths.json --cert-dir  /auth  --tls-verify=true --creds=username:password containerID docker://localhost:5000/imageName

Files

registries.conf (/etc/containers/registries.conf)

registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion.

policy.json (/etc/containers/policy.json)

Signature policy file.  This defines the trust policy for container images.  Controls which container registries can be used for image, and whether or not the tool should trust the images.

See Also

buildah(1), policy.json(5), registries.conf(5)

Referenced By

buildah(1).

March 2017 buildah