.nh
.TH umoci-config(1) # umoci config - Modifies the configuration of an OCI image
Aleksa Sarai
DECEMBER 2016

.SH NAME
.PP
umoci config - Modifies the configuration of an OCI image


.SH SYNOPSIS
.PP
\fBumoci config\fP
\fB--image\fP=\fIimage\fP[:\fItag\fP]
[\fB--tag\fP=\fInew-tag\fP]
[\fB--no-history\fP]
[\fB--history.comment\fP=\fIcomment\fP]
[\fB--history.created_by\fP=\fIcreated_by\fP]
[\fB--history.author\fP=\fIauthor\fP]
[\fB--history-created\fP=\fIdate\fP]
[\fB--clear\fP=\fIvalue\fP]
[\fB--config.user\fP=\fIvalue\fP]
[\fB--config.exposedports\fP=\fIvalue\fP]
[\fB--config.env\fP=\fIvalue\fP]
[\fB--config.entrypoint\fP=\fIvalue\fP]
[\fB--config.cmd\fP=\fIvalue\fP]
[\fB--config.volume\fP=\fIvalue\fP]
[\fB--config.label\fP=\fIvalue\fP]
[\fB--config.workingdir\fP=\fIvalue\fP]
[\fB--created\fP=\fIvalue\fP]
[\fB--author\fP=\fIvalue\fP]
[\fB--architecture\fP=\fIvalue\fP]
[\fB--os\fP=\fIvalue\fP]
[\fB--manifest.annotation\fP=\fIvalue\fP]


.SH DESCRIPTION
.PP
Modify the configuration and manifest data for a particular tagged OCI image --
\fBoverwriting it unless you specify --tag\fP\&. If \fB--no-history\fP was not
specified, a history entry is appended to the tagged OCI image for this change
(with the various \fB--history.\fP flags controlling the values used). To view
the history, see \fBumoci-stat\fP(1).

.PP
Note that the original image tag (the argument to \fB--image\fP) will \fBnot\fP be
modified unless the target of \fBumoci-config\fP(1) is the original image tag.


.SH OPTIONS
.PP
The global options are defined in \fBumoci\fP(1).

.PP
\fB--image\fP=\fIimage\fP[:\fItag\fP]
  The source tagged OCI image whose config will be modified. \fIimage\fP must be
  a path to a valid OCI image and \fItag\fP must be a valid tag in the image. If
  \fItag\fP is not provided it defaults to "latest".

.PP
\fB--tag\fP=\fInew-tag\fP
  Tag name for the modified image, if unspecified then the original tag
  provided to \fB--image\fP will be clobbered.

.PP
\fB--no-history\fP
  Causes no history entry to be added for this operation.

.PP
\fB--history.comment\fP=\fIcomment\fP
  Comment for the history entry corresponding to this modification of the image
  configuration. If unspecified, \fBumoci\fP(1) will generate an
  implementation-dependent value.

.PP
\fB--history.created_by\fP=\fIcreated_by\fP
  CreatedBy entry for the history entry corresponding to this modification of
  the image configuration. If unspecified, \fBumoci\fP(1) will generate an
  implementation-dependent value.

.PP
\fB--history.author\fP=\fIauthor\fP
  Author value for the history entry corresponding to this modification of the
  image configuration. If unspecified, this value will be the image's author
  value \fBafter\fP any modifications were made by this call of
  \fBumoci-config\fP(1).

.PP
\fB--history-created\fP=\fIdate\fP
  Creation date for the history entry corresponding to this modifications of
  the image configuration. This must be an ISO8601 formatted timestamp (see
  \fBdate\fP(1)). If unspecified, the current time is used.

.PP
\fB--clear\fP=\fIvalue\fP
  Removes all pre-existing entries for a given set or list configuration option
  (it will not undo any modification made by this call of \fBumoci-config\fP(1)).
  The valid values of \fIvalue\fP are:

.PP
.RS

.nf
* config.labels
* manifest.annotations
* config.exposedports
* config.env
* config.entrypoint
* config.cmd
* config.volume

.fi
.RE

.PP
The following commands all set their corresponding values in the configuration
or image manifest. For more information see the OCI image specification
\[la]https://github.com/opencontainers/image-spec\[ra]\&.

.RS
.IP \(bu 2
\fB--config.user\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.exposedports\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.env\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.entrypoint\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.cmd\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.volume\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.label\fP=\fIvalue\fP
.IP \(bu 2
\fB--config.workingdir\fP=\fIvalue\fP
.IP \(bu 2
\fB--created\fP=\fIvalue\fP
.IP \(bu 2
\fB--author\fP=\fIvalue\fP
.IP \(bu 2
\fB--architecture\fP=\fIvalue\fP
.IP \(bu 2
\fB--os\fP=\fIvalue\fP
.IP \(bu 2
\fB--manifest.annotation\fP=\fIvalue\fP

.RE


.SH EXAMPLE
.PP
The following modifies an OCI image configuration in various ways, and
overwrites the original tag with the new image.

.PP
.RS

.nf
% umoci config --image image:tag --clear=config.env --config.env="VARIABLE=true" \\
	--config.user="user:group" --config.entrypoint=cat --config.cmd=/proc/self/stat \\
	--config.label="com.cyphar.umoci=true" --author="Aleksa Sarai <asarai@suse.de>" \\
	--os="gnu/hurd" --architecture="lisp" --created="$(date --iso-8601=seconds)"

.fi
.RE


.SH SEE ALSO
.PP
\fBumoci\fP(1)