.nh
.TH umoci-raw-add-layer(1) # umoci raw add-layer - add a layer archive verbatim to an image
Aleksa Sarai
SEPTEMBER 2018

.SH NAME
.PP
umoci raw add-layer - add a layer archive verbatim to an image


.SH SYNOPSIS
.PP
\fBumoci raw add-layer\fP
\fB--image\fP=\fIimage\fP
[\fB--tag\fP=\fItag\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]
\fInew-layer.tar\fP


.SH DESCRIPTION
.PP
Adds the uncompressed layer archive referenced by \fInew-layer.tar\fP verbatim to
the image. Note that since this is done verbatim, no changes are made to the
layer and thus any OCI-specific \fB\fCtar\fR extensions (such as \fB\fC\&.wh.\fR whiteout
files) will be included unmodified. Use of this command is therefore only
recommended for expert users, and more novice users should look at
\fBumoci-repack\fP(1) to create their layers.

.PP
At the moment, \fBumoci raw add-layer\fP only supports appending layers to the
end of the image layer list.


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

.PP
\fB--image\fP=\fIimage\fP[:\fItag\fP]
  The source tag to use as the base of the image containing the new layer.
  \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=\fItag\fP
  The destination tag to use for the newly created image. \fItag\fP must be a valid
  tag in the image. If \fItag\fP is not provided it defaults to the \fItag\fP specified
  in \fB--image\fP (overwriting it).

.PP
\fB--no-history\fP
  Causes no history entry to be added for this operation. \fBThis is not
  recommended for use with umoci-raw-add-layer(1), since it results in the
  history not including all of the image layers -- and thus will cause
  confusion with tools that look at image history.\fP

.PP
\fB--history.comment\fP=\fIcomment\fP
  Comment for the history entry corresponding to this modification of the image
  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. 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. 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. This must be an ISO8601 formatted timestamp (see \fBdate\fP(1)). If
  unspecified, the current time is used.


.SH EXAMPLE
.PP
The following takes an existing diff directory, creates a new archive from it
and then inserts it into an existing image. Note that the new archive is \fInot\fP
compressed (\fBumoci\fP will compress the archive for you).

.PP
.RS

.nf
% tar cfC diff-layer.tar diff/ .
% umoci raw add-layer --image oci:foo diff-layer.tar

.fi
.RE


.SH SEE ALSO
.PP
\fBumoci\fP(1), \fBumoci-repack\fP(1)