github.com/dctrud/umoci@v0.4.3-0.20191016193643-05a1d37de015/doc/man/umoci-repack.1.md (about)

     1  % umoci-repack(1) # umoci repack - Repacks an OCI runtime bundle into an image tag
     2  % Aleksa Sarai
     3  % DECEMBER 2016
     4  # NAME
     5  umoci repack - Repacks an OCI runtime bundle into an image tag
     6  
     7  # SYNOPSIS
     8  **umoci repack**
     9  **--image**=*image*[:*tag*]
    10  [**--history.comment**=*comment*]
    11  [**--history.created_by**=*created_by*]
    12  [**--history.author**=*author*]
    13  [**--history-created**=*date*]
    14  [**--refresh-bundle**]
    15  *bundle*
    16  
    17  # DESCRIPTION
    18  Given a modified OCI bundle extracted with **umoci-unpack**(1) (at the given
    19  path *bundle*), **umoci-repack**(1) computes the filesystem delta for the OCI
    20  bundle's *rootfs*. The delta is used to generate a delta layer, which is then
    21  appended to the original image manifest (that was used as an argument to
    22  **umoci-unpack**(1)) and tagged as a new image tag. Between a call to
    23  **umoci-unpack**(1) and **umoci-repack**(1) users SHOULD NOT modify the OCI
    24  image in any way (specifically you MUST NOT use **umoci-gc**(1)).
    25  
    26  All **--uid-map** and **--gid-map** settings are implied from the saved values
    27  specified in **umoci-unpack**(1), so they are not available for
    28  **umoci-repack**(1).
    29  
    30  In addition, a history entry is appended to the tagged OCI image for this
    31  change (with the various **--history.** flags controlling the values used). To
    32  view the history, see **umoci-stat**(1).
    33  
    34  Note that the original image tag (used with **umoci-unpack**(1)) will **not**
    35  be modified unless the target of **umoci-repack**(1) is the original image tag.
    36  
    37  # OPTIONS
    38  The global options are defined in **umoci**(1).
    39  
    40  **--image**=*image*[:*tag*]
    41    The destination tag for the repacked OCI image. *image* must be a path to a
    42    valid OCI image (and the same *image* used in **umoci-unpack**(1) to create
    43    the *bundle*) and *tag* must be a valid tag name. If another tag already has
    44    the same name as *tag* it will be overwritten. If *tag* is not provided it
    45    defaults to "latest".
    46  
    47  **--history.comment**=*comment*
    48    Comment for the history entry corresponding to this modification of the image
    49    If unspecified, **umoci**(1) will generate an implementation-dependent value.
    50  
    51  **--history.created_by**=*created_by*
    52    CreatedBy entry for the history entry corresponding to this modification of
    53    the image. If unspecified, **umoci**(1) will generate an
    54    implementation-dependent value.
    55  
    56  **--history.author**=*author*
    57    Author value for the history entry corresponding to this modification of the
    58    image. If unspecified, this value will be the image's author value **after**
    59    any modifications were made by this call of **umoci-config**(1).
    60  
    61  **--history-created**=*date*
    62    Creation date for the history entry corresponding to this modifications of
    63    the image. This must be an ISO8601 formatted timestamp (see **date**(1)). If
    64    unspecified, the current time is used.
    65  
    66  **--refresh-bundle**
    67    Whether to update the OCI bundle's metadata (i.e. mtree and umoci
    68    metadata) after repacking the image. If set, then the new state of
    69    the bundle should be equivalent to unpacking the new image tag.
    70  
    71  # EXAMPLE
    72  The following downloads an image from a **docker**(1) registry using
    73  **skopeo**(1), unpacks it with **umoci-unpack**(1), modifies it and then
    74  repacks it.
    75  
    76  ```
    77  % skopeo copy docker://opensuse/amd64:42.2 oci:image:latest
    78  # umoci unpack --image image bundle
    79  # touch bundle/rootfs/a_new_file
    80  # umoci repack --image image:new-42.2 bundle
    81  ```
    82  
    83  # SEE ALSO
    84  **umoci**(1), **umoci-unpack**(1)