github.com/opencontainers/umoci@v0.4.8-0.20240508124516-656e4836fb0d/doc/man/umoci-raw-add-layer.1.md (about)

     1  % umoci-raw-add-layer(1) # umoci raw add-layer - add a layer archive verbatim to an image
     2  % Aleksa Sarai
     3  % SEPTEMBER 2018
     4  # NAME
     5  umoci raw add-layer - add a layer archive verbatim to an image
     6  
     7  # SYNOPSIS
     8  **umoci raw add-layer**
     9  **--image**=*image*
    10  [**--tag**=*tag*]
    11  [**--no-history**]
    12  [**--history.comment**=*comment*]
    13  [**--history.created_by**=*created_by*]
    14  [**--history.author**=*author*]
    15  [**--history-created**=*date*]
    16  *new-layer.tar*
    17  
    18  # DESCRIPTION
    19  Adds the uncompressed layer archive referenced by *new-layer.tar* verbatim to
    20  the image. Note that since this is done verbatim, no changes are made to the
    21  layer and thus any OCI-specific `tar` extensions (such as `.wh.` whiteout
    22  files) will be included unmodified. Use of this command is therefore only
    23  recommended for expert users, and more novice users should look at
    24  **umoci-repack**(1) to create their layers.
    25  
    26  At the moment, **umoci raw add-layer** only supports appending layers to the
    27  end of the image layer list.
    28  
    29  # OPTIONS
    30  The global options are defined in **umoci**(1).
    31  
    32  **--image**=*image*[:*tag*]
    33    The source tag to use as the base of the image containing the new layer.
    34    *image* must be a path to a valid OCI image and *tag* must be a valid tag in
    35    the image. If *tag* is not provided it defaults to "latest".
    36  
    37  **--tag**=*tag*
    38    The destination tag to use for the newly created image. *tag* must be a valid
    39    tag in the image. If *tag* is not provided it defaults to the *tag* specified
    40    in **--image** (overwriting it).
    41  
    42  **--no-history**
    43    Causes no history entry to be added for this operation. **This is not
    44    recommended for use with umoci-raw-add-layer(1), since it results in the
    45    history not including all of the image layers -- and thus will cause
    46    confusion with tools that look at image history.**
    47  
    48  **--history.comment**=*comment*
    49    Comment for the history entry corresponding to this modification of the image
    50    If unspecified, **umoci**(1) will generate an implementation-dependent value.
    51  
    52  **--history.created_by**=*created_by*
    53    CreatedBy entry for the history entry corresponding to this modification of
    54    the image. If unspecified, **umoci**(1) will generate an
    55    implementation-dependent value.
    56  
    57  **--history.author**=*author*
    58    Author value for the history entry corresponding to this modification of the
    59    image. If unspecified, this value will be the image's author value **after**
    60    any modifications were made by this call of **umoci-config**(1).
    61  
    62  **--history-created**=*date*
    63    Creation date for the history entry corresponding to this modifications of
    64    the image. This must be an ISO8601 formatted timestamp (see **date**(1)). If
    65    unspecified, the current time is used.
    66  
    67  # EXAMPLE
    68  
    69  The following takes an existing diff directory, creates a new archive from it
    70  and then inserts it into an existing image. Note that the new archive is *not*
    71  compressed (**umoci** will compress the archive for you).
    72  
    73  ```
    74  % tar cfC diff-layer.tar diff/ .
    75  % umoci raw add-layer --image oci:foo diff-layer.tar
    76  ```
    77  
    78  # SEE ALSO
    79  **umoci**(1), **umoci-repack**(1)