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

     1  % umoci-config(1) # umoci config - Modifies the configuration of an OCI image
     2  % Aleksa Sarai
     3  % DECEMBER 2016
     4  # NAME
     5  umoci config - Modifies the configuration of an OCI image
     6  
     7  # SYNOPSIS
     8  **umoci config**
     9  **--image**=*image*[:*tag*]
    10  [**--tag**=*new-tag*]
    11  [**--no-history**]
    12  [**--history.comment**=*comment*]
    13  [**--history.created_by**=*created_by*]
    14  [**--history.author**=*author*]
    15  [**--history-created**=*date*]
    16  [**--clear**=*value*]
    17  [**--config.user**=*value*]
    18  [**--config.exposedports**=*value*]
    19  [**--config.env**=*value*]
    20  [**--config.entrypoint**=*value*]
    21  [**--config.cmd**=*value*]
    22  [**--config.volume**=*value*]
    23  [**--config.label**=*value*]
    24  [**--config.workingdir**=*value*]
    25  [**--created**=*value*]
    26  [**--author**=*value*]
    27  [**--architecture**=*value*]
    28  [**--os**=*value*]
    29  [**--manifest.annotation**=*value*]
    30  
    31  # DESCRIPTION
    32  Modify the configuration and manifest data for a particular tagged OCI image --
    33  **overwriting it unless you specify --tag**. If **--no-history** was not
    34  specified, a history entry is appended to the tagged OCI image for this change
    35  (with the various **--history.** flags controlling the values used). To view
    36  the history, see **umoci-stat**(1).
    37  
    38  Note that the original image tag (the argument to **--image**) will **not** be
    39  modified unless the target of **umoci-config**(1) is the original image tag.
    40  
    41  # OPTIONS
    42  The global options are defined in **umoci**(1).
    43  
    44  **--image**=*image*[:*tag*]
    45    The source tagged OCI image whose config will be modified. *image* must be
    46    a path to a valid OCI image and *tag* must be a valid tag in the image. If
    47    *tag* is not provided it defaults to "latest".
    48  
    49  **--tag**=*new-tag*
    50    Tag name for the modified image, if unspecified then the original tag
    51    provided to **--image** will be clobbered.
    52  
    53  **--no-history**
    54    Causes no history entry to be added for this operation.
    55  
    56  **--history.comment**=*comment*
    57    Comment for the history entry corresponding to this modification of the image
    58    configuration. If unspecified, **umoci**(1) will generate an
    59    implementation-dependent value.
    60  
    61  **--history.created_by**=*created_by*
    62    CreatedBy entry for the history entry corresponding to this modification of
    63    the image configuration. If unspecified, **umoci**(1) will generate an
    64    implementation-dependent value.
    65  
    66  **--history.author**=*author*
    67    Author value for the history entry corresponding to this modification of the
    68    image configuration. If unspecified, this value will be the image's author
    69    value **after** any modifications were made by this call of
    70    **umoci-config**(1).
    71  
    72  **--history-created**=*date*
    73    Creation date for the history entry corresponding to this modifications of
    74    the image configuration. This must be an ISO8601 formatted timestamp (see
    75    **date**(1)). If unspecified, the current time is used.
    76  
    77  **--clear**=*value*
    78    Removes all pre-existing entries for a given set or list configuration option
    79    (it will not undo any modification made by this call of **umoci-config**(1)).
    80    The valid values of *value* are:
    81  
    82      * config.labels
    83      * manifest.annotations
    84      * config.exposedports
    85      * config.env
    86      * config.entrypoint
    87      * config.cmd
    88      * config.volume
    89  
    90  The following commands all set their corresponding values in the configuration
    91  or image manifest. For more information see [the OCI image specification][1].
    92  
    93  * **--config.user**=*value*
    94  * **--config.exposedports**=*value*
    95  * **--config.env**=*value*
    96  * **--config.entrypoint**=*value*
    97  * **--config.cmd**=*value*
    98  * **--config.volume**=*value*
    99  * **--config.label**=*value*
   100  * **--config.workingdir**=*value*
   101  * **--created**=*value*
   102  * **--author**=*value*
   103  * **--architecture**=*value*
   104  * **--os**=*value*
   105  * **--manifest.annotation**=*value*
   106  
   107  # EXAMPLE
   108  
   109  The following modifies an OCI image configuration in various ways, and
   110  overwrites the original tag with the new image.
   111  
   112  ```
   113  % umoci config --image image:tag --clear=config.env --config.env="VARIABLE=true" \
   114  	--config.user="user:group" --config.entrypoint=cat --config.cmd=/proc/self/stat \
   115  	--config.label="com.cyphar.umoci=true" --author="Aleksa Sarai <asarai@suse.de>" \
   116  	--os="gnu/hurd" --architecture="lisp" --created="$(date --iso-8601=seconds)"
   117  ```
   118  
   119  # SEE ALSO
   120  **umoci**(1)
   121  
   122  [1]: https://github.com/opencontainers/image-spec